Add dataset README with conversion details

README.md

@@ -1,28 +1,64 @@
----
-dataset_info:
-  features:
-  - name: source_text
-    dtype: string
-  - name: tagged_text
-    dtype: string
-  - name: tokens
-    list: string
-  - name: ner_tags
-    list: int64
-  splits:
-  - name: train
-    num_bytes: 23327316
-    num_examples: 21008
-  - name: validation
-    num_bytes: 5802411
-    num_examples: 5000
-  download_size: 8049407
-  dataset_size: 29129727
-configs:
-- config_name: default
-  data_files:
-  - split: train
-    path: data/train-*
-  - split: validation
-    path: data/validation-*
----
+# KLUE NER Dataset - Converted Format
+
+This dataset is converted from the original KLUE NER dataset with entity tags in the format `<|B_LABEL|>entity<|E_LABEL|>`.
+
+## Dataset Structure
+
+- **train**: 21,008 examples
+- **validation**: 5,000 examples
+
+## Format Conversion
+
+Original format: `<entity:label>`
+Converted format: `<|B_LABEL|>entity<|E_LABEL|>`
+
+## Entity Tags Used
+
+The following entity tags are used in this dataset:
+
+- `DT`: Date (Begin/End tags `<|B_DT|>` and `<|E_DT|>`)
+- `LC`: Location (Begin/End tags `<|B_LC|>` and `<|E_LC|>`)
+- `OG`: Organization (Begin/End tags `<|B_OG|>` and `<|E_OG|>`)
+- `PS`: Person (Begin/End tags `<|B_PS|>` and `<|E_PS|>`)
+- `QT`: Quantity (Begin/End tags `<|B_QT|>` and `<|E_QT|>`)
+- `TI`: Time (Begin/End tags `<|B_TI|>` and `<|E_TI|>`)
+
+Total number of unique entity tokens: 30
+
+## Usage
+
+```python
+from datasets import load_dataset
+
+dataset = load_dataset("dkqjrm/klue-ner-converted")
+print("Source text:", dataset['train'][0]['source_text'])
+print("Tagged text:", dataset['train'][0]['tagged_text'])
+```
+
+## Fields
+
+- `source_text`: Original sentence with entities (no tags)
+- `tagged_text`: Converted sentence with `<|B_LABEL|>entity<|E_LABEL|>` format  
+- `tokens`: Original character-level tokens
+- `ner_tags`: Original NER tag indices
+
+## Citation
+
+```bibtex
+@misc{klue-ner-converted,
+  title={KLUE NER Dataset - Converted Format},
+  author={Converted from original KLUE dataset},
+  year={2024},
+  howpublished={\url{https://huggingface.co/datasets/dkqjrm/klue-ner-converted}}
+}
+```
+
+Original KLUE dataset:
+```bibtex
+@article{park2021klue,
+  title={KLUE: Korean Language Understanding Evaluation},
+  author={Park, Sungjoon and Moon, Jihyung and Kim, Sungdong and Cho, Won Ik and Han, Jiyoon and Park, Jangwon and Song, Chisung and Kim, Junseong and Song, Yongsook and Taek Oh, Sang and others},
+  journal={arXiv preprint arXiv:2105.09680},
+  year={2021}
+}
+```