docs(readme): add example and ref to extraction script

#3
by lucabaggi - opened
Files changed (1) hide show
  1. README.md +19 -3
README.md CHANGED
@@ -124,10 +124,26 @@ size_categories:
124
 
125
  # Dataset Card for Dataset Name
126
 
127
- <!-- Provide a quick summary of the dataset. -->
128
-
129
  This dataset is a port of the ["Animal Image Dataset"](https://www.kaggle.com/datasets/iamsouravbanerjee/animal-image-dataset-90-different-animals) that you can find on Kaggle.
130
  The dataset contains 60 pictures for 90 types of animals, with various image sizes.
131
 
 
 
132
  **Note**. At the time of writing, by looking at the Croissant ML Metadata, the original license of the data is `sc:CreativeWork`. If you believe this dataset violates any license, please
133
- do let me know so I can take it down as soon as possible.
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
124
 
125
  # Dataset Card for Dataset Name
126
 
 
 
127
  This dataset is a port of the ["Animal Image Dataset"](https://www.kaggle.com/datasets/iamsouravbanerjee/animal-image-dataset-90-different-animals) that you can find on Kaggle.
128
  The dataset contains 60 pictures for 90 types of animals, with various image sizes.
129
 
130
+ With respect to the original dataset, I created the train-test-split partitions (80%/20%) to make it compatible via HuggingFace `datasets`.
131
+
132
  **Note**. At the time of writing, by looking at the Croissant ML Metadata, the original license of the data is `sc:CreativeWork`. If you believe this dataset violates any license, please
133
+ do let me know so I can take it down as soon as possible.
134
+
135
+ ## How to use this data
136
+
137
+ ```python
138
+ from datasets import load_dataset
139
+
140
+ # for exploration
141
+ ds = load_dataset("lucabaggi/animal-wildlife", split=train)
142
+
143
+ # for training
144
+ ds = load_dataset("lucabaggi/animal-wildlife")
145
+ ```
146
+
147
+ ## How the data was generated
148
+
149
+ You can find the script [here](./extract.py)