Update README.md

README.md

@@ -16,4 +16,51 @@ configs:
   data_files:
   - split: train
     path: data/train-*
+license: cc-by-sa-3.0
+task_categories:
+- text-to-image
+language:
+- en
+- ja
+tags:
+- kanji
+pretty_name: Kanji images with textual descriptions
+size_categories:
+- 1K<n<10K
 ---
+
+# KanjiVG PNG images with textual descriptions
+This dataset is an adaptation of [KanjiVG](https://github.com/KanjiVG/kanjivg) by Ulrich Apel. The original SVG files have been converted to 1024x1024 PNG images and enriched with Kanji descriptions of their meaning.
+
+## Usage
+```python
+>>> from datasets import load_dataset
+>>> data=load_dataset("davidstap/kanji_definitions")
+>>> data
+DatasetDict({
+    train: Dataset({
+        features: ['image', 'text'],
+        num_rows: 6315
+    })
+})
+>>> data['train']
+Dataset({
+    features: ['image', 'text'],
+    num_rows: 6315
+})
+>>> data['train']['text'][0]
+'bamboo rice basket'
+>>> data['train']['image'][0]
+<PIL.PngImagePlugin.PngImageFile image mode=RGBA size=1024x1024 at 0x7F1B037E5600>
+```
+
+## Modifications from Original
+- Converted SVG files to 1024x1024 PNG format
+- Added descriptive text for each Kanji character
+- Removed numbering from SVG renders
+- Original vector graphics available at: https://github.com/KanjiVG/kanjivg
+
+## Attribution
+- Original work: KanjiVG by Ulrich Apel
+- Original repository: https://github.com/KanjiVG/kanjivg
+- Adaptation by: David Stap