Skip to content

Commit

Permalink
Docs updated
Browse files Browse the repository at this point in the history
  • Loading branch information
sadda committed Feb 28, 2024
1 parent 71d5f80 commit aa8231c
Show file tree
Hide file tree
Showing 5 changed files with 10 additions and 10 deletions.
10 changes: 5 additions & 5 deletions docs/adding.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,11 +16,11 @@ class Test(datasets.DatasetFactory):
return df
```

The class is then created by `Test('')`. The empty argument should point to the location where the images are stored. The dataframe can then be accessed by
The class is then created by `Test('.')`. The empty argument should point to the location where the images are stored. The dataframe can then be accessed by

```python exec="true" source="above" result="console" session="run1"
Test('').df
print(Test('').df) # markdown-exec: hide
Test('.').df
print(Test('.').df) # markdown-exec: hide
```

The dataframe `df` must satisfy [some requirements](../dataframe).
Expand Down Expand Up @@ -55,8 +55,8 @@ class Test(datasets.DatasetFactory):
The metadata can be accessed by

```python exec="true" source="above" result="console" session="run2"
Test('').metadata
print(Test('').metadata) # markdown-exec: hide
Test('.').metadata
print(Test('.').metadata) # markdown-exec: hide
```

## Optional: including download
Expand Down
2 changes: 1 addition & 1 deletion docs/default_splits.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ import pandas as pd

df = pd.read_csv('docs/csv/MacaqueFaces.csv')
df = df.drop('Unnamed: 0', axis=1)
dataset = datasets.MacaqueFaces('', df)
dataset = datasets.MacaqueFaces('.', df)
df = dataset.df
```

Expand Down
4 changes: 2 additions & 2 deletions docs/methods.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,12 +15,12 @@ import pandas as pd

df = pd.read_csv('docs/csv/MacaqueFaces.csv')
df = df.drop('Unnamed: 0', axis=1)
ds1 = datasets.MacaqueFaces('', df)
ds1 = datasets.MacaqueFaces('.', df)
ds1.df.drop(['category'], axis=1, inplace=True)

df = pd.read_csv('docs/csv/IPanda50.csv')
df = df.drop('Unnamed: 0', axis=1)
ds2 = datasets.IPanda50('', df)
ds2 = datasets.IPanda50('.', df)

d = ds1
ds = [ds1, ds2]
Expand Down
2 changes: 1 addition & 1 deletion docs/tutorial_datasets.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ import pandas as pd

df = pd.read_csv('docs/csv/MacaqueFaces.csv')
df = df.drop('Unnamed: 0', axis=1)
d = datasets.MacaqueFaces('', df)
d = datasets.MacaqueFaces('.', df)
d.df.drop(['category'], axis=1, inplace=True)
```

Expand Down
2 changes: 1 addition & 1 deletion docs/tutorial_splits.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ import pandas as pd

df = pd.read_csv('docs/csv/MacaqueFaces.csv')
df = df.drop('Unnamed: 0', axis=1)
dataset = datasets.MacaqueFaces('', df)
dataset = datasets.MacaqueFaces('.', df)
df = dataset.df
```

Expand Down

0 comments on commit aa8231c

Please sign in to comment.