Add comprehensive README

README.md

@@ -1,45 +1,85 @@
 ---
-dataset_info:
-  features:
-  - name: odai_id
-    dtype: string
-  - name: odai_type
-    dtype: string
-  - name: odai
-    dtype: string
-  - name: response
-    dtype: string
-  - name: score
-    dtype: float64
-  - name: original_score
-    dtype: float64
-  - name: original_dataset
-    dtype: string
-  - name: split
-    dtype: string
-  - name: user_name
-    dtype: string
-  - name: award
-    dtype: string
-  splits:
-  - name: train
-    num_bytes: 2097301.1667427155
-    num_examples: 9817
-  - name: validation
-    num_bytes: 524485.5214783913
-    num_examples: 2455
-  - name: test
-    num_bytes: 655660.3117788931
-    num_examples: 3069
-  download_size: 1331271
-  dataset_size: 3277447.0
-configs:
-- config_name: default
-  data_files:
-  - split: train
-    path: data/train-*
-  - split: validation
-    path: data/validation-*
-  - split: test
-    path: data/test-*
+language:
+- ja
+license: apache-2.0
+task_categories:
+- text-scoring
+- multimodal
+tags:
+- humor
+- japanese
+- multimodal
+- comedy
+pretty_name: Japanese Multimodal Humor Evaluation Dataset
+size_categories:
+- 10K<n<100K
 ---
+
+# Japanese Multimodal Humor Evaluation Dataset
+
+This dataset combines two Japanese humor datasets for evaluating the funniness of responses to prompts (odai).
+
+## Dataset Description
+
+This dataset merges:
+- **bokete dataset**: Image prompts with text responses
+- **keitai dataset**: Text prompts with text responses
+
+All scores are normalized to a 0-4 scale for consistency.
+
+## Dataset Structure
+
+### Data Fields
+
+- `odai_id`: Unique identifier for the prompt
+- `odai_type`: Type of prompt ('image' or 'text')
+- `odai`: The prompt content (image reference for bokete, text for keitai)
+- `response`: The humorous response text
+- `score`: Normalized humor score (0-4 scale)
+- `original_score`: Original score from the source dataset
+- `original_dataset`: Source dataset ('bokete' or 'keitai')
+- `split`: Original data split
+- `user_name`: Responder name (keitai only)
+- `award`: Award received (keitai only)
+
+### Data Splits
+
+The dataset is split into train/validation/test sets with an 80/10/10 ratio.
+
+## Usage
+
+```python
+from datasets import load_dataset
+
+dataset = load_dataset("iammytoo/japanese-humor-evaluation")
+
+# Access different splits
+train_data = dataset['train']
+val_data = dataset['validation']
+test_data = dataset['test']
+
+# Example item
+print(train_data[0])
+```
+
+## Source Data
+
+- bokete dataset: https://huggingface.co/datasets/YANS-official/ogiri-bokete
+- keitai dataset: https://huggingface.co/datasets/YANS-official/ogiri-keitai
+
+## Citation
+
+If you use this dataset, please cite the original datasets:
+
+```bibtex
+@misc{japanese-humor-evaluation,
+  title={Japanese Multimodal Humor Evaluation Dataset},
+  author={iammytoo},
+  year={2024},
+  publisher={HuggingFace}
+}
+```
+
+## License
+
+This dataset is released under the Apache 2.0 license, following the original datasets' licensing.