Update README.md

README.md

@@ -62,6 +62,46 @@ configs:
   - split: train
     path: safe/train-*
 ---
-# Dataset Card for "danbooru-tags-2016-2023"
 
-[More Information needed](https://github.com/huggingface/datasets/blob/main/CONTRIBUTING.md#how-to-contribute-to-the-dataset-cards)
+# danbooru-tags-2016-2023
+
+A dataset of danbooru tags.
+
+## Dataset information
+
+Generated using [danbooru](https://danbooru.donmai.us/) and [safebooru](https://safebooru.donmai.us/) API.
+
+The dataset was created with the following conditions:
+
+|Subset name|`all`|`safe`|
+|-|-|-|
+|API Endpoint|https://danbooru.donmai.us|https://safebooru.donmai.us|
+|Date|`2016-01-01..2023-11-27`|`2016-01-01..2023-11-26`|
+|Score|`>0`|`>0`|
+|Rating|`g,s,q,e`|`g`|
+|Filetype|`png,jpg,webp`|`png,jpg,webp`|
+|Size (number of rows)|4,488,788|1,131,416|
+
+## Usage
+
+```
+pip install datasets
+```
+
+```py
+from datasets import load_dataset
+
+dataset = load_dataset(
+    "isek-ai/danbooru-tags-2016-2023",
+    "safe", # or "all"
+    split="train",
+)
+
+print(dataset)
+print(dataset[0])
+# Dataset({
+#     features: ['id', 'copyright', 'character', 'artist', 'general', 'meta', 'rating', 'score', 'created_at'],        
+#     num_rows: 1131416
+# })
+# {'id': 2229839, 'copyright': 'kara no kyoukai', 'character': 'ryougi shiki', 'artist': 'momoko (momopoco)', 'general': '1girl, 2016, :|, brown eyes, brown hair, closed mouth, cloud, cloudy sky, dated, day, flower, hair flower, hair ornament, japanese clothes, kimono, long hair, long sleeves, looking at viewer, new year, obi, outdoors, sash, shrine, sky, solo, standing, wide sleeves', 'meta': 'commentary request, partial commentary', 'rating': 'g', 'score': 76, 'created_at': '2016-01-01T00:43:18.369+09:00'}
+```