Update README.md

README.md

@@ -19,7 +19,131 @@ dataset_info:
     num_examples: 39712
   download_size: 16984559355
   dataset_size: 32950369201
+annotations_creators:
+- no-annotation
+task_categories:
+- text-generation
+- fill-mask
+task_ids:
+- language-modeling
+- masked-language-modeling
+multilinguality:
+- monolingual
+language:
+- uz
+size_categories:
+- 10M<n<100M
+pretty_name: UzBooks
+license: apache-2.0
+tags:
+- uz
+- books
 ---
-# Dataset Card for "uz-books"
 
-[More Information needed](https://github.com/huggingface/datasets/blob/main/CONTRIBUTING.md#how-to-contribute-to-the-dataset-cards)
+# Dataset Card for BookCorpus
+
+## Table of Contents
+- [Dataset Description](#dataset-description)
+  - [Dataset Summary](#dataset-summary)
+  - [Supported Tasks and Leaderboards](#supported-tasks-and-leaderboards)
+  - [Languages](#languages)
+- [Dataset Structure](#dataset-structure)
+  - [Data Instances](#data-instances)
+  - [Data Fields](#data-fields)
+  - [Data Splits](#data-splits)
+- [Dataset Creation](#dataset-creation)
+  - [Curation Rationale](#curation-rationale)
+  - [Source Data](#source-data)
+  - [Annotations](#annotations)
+  - [Personal and Sensitive Information](#personal-and-sensitive-information)
+- [Considerations for Using the Data](#considerations-for-using-the-data)
+  - [Social Impact of Dataset](#social-impact-of-dataset)
+  - [Discussion of Biases](#discussion-of-biases)
+  - [Other Known Limitations](#other-known-limitations)
+- [Additional Information](#additional-information)
+  - [Dataset Curators](#dataset-curators)
+  - [Licensing Information](#licensing-information)
+  - [Citation Information](#citation-information)
+  - [Contributions](#contributions)
+
+## Dataset Description
+
+- **Homepage:** [https://yknzhu.wixsite.com/mbweb](https://yknzhu.wixsite.com/mbweb)
+- **Repository:** [More Information Needed](https://github.com/huggingface/datasets/blob/master/CONTRIBUTING.md#how-to-contribute-to-the-dataset-cards)
+- **Paper:** [More Information Needed](https://github.com/huggingface/datasets/blob/master/CONTRIBUTING.md#how-to-contribute-to-the-dataset-cards)
+- **Point of Contact:** [More Information Needed](https://github.com/huggingface/datasets/blob/master/CONTRIBUTING.md#how-to-contribute-to-the-dataset-cards)
+- **Size of downloaded dataset files:** 16.98 GB
+- **Size of the generated dataset:** 32.95 GB
+- **Total amount of disk used:** 49.93 GB
+
+### Dataset Summary
+
+In an effort to democratize research on low, we release UzBooks dataset, a cleaned book corpus consisting of nearly 40000 books in Uzbek Language is divided into two branches: "original" and "lat," representing the OCRed and Latin-script versions of the texts. 
+
+Please refer to our [blogpost](https://tahrirchi.uz/grammatika-tekshiruvi) and paper (Coming soon!) for further details.
+
+To load and use dataset, run this script:
+
+```python
+from datasets import load_dataset
+
+load_dataset("tahrirchi/uz-books")
+```
+
+## Dataset Structure
+
+### Data Instances
+
+#### plain_text
+
+- **Size of downloaded dataset files:** 16.98 GB
+- **Size of the generated dataset:** 32.95 GB
+- **Total amount of disk used:** 49.93 GB
+
+An example of 'train' looks as follows.
+```
+{
+    "text": "Hamsa\nAlisher Navoiy ..."
+}
+```
+
+### Data Fields
+
+The data fields are the same among all splits.
+
+#### plain_text
+- `text`: a `string` feature that contains text of the books.
+
+### Data Splits
+
+| name            |         |
+|-----------------|--------:|
+| original        | 39712   |
+| lat             | 39712   |
+
+## Dataset Creation
+
+The books have been crawled from various internet sources and preprocessed using Optical Character Recognition techniques in [Tesseract OCR Engine](https://github.com/tesseract-ocr/tesseract). The latin version is created by converting the original dataset with highly curated scripts in order to put more emphasise on the research and development of the field.
+
+
+## Citation
+
+Please cite this model using the following format:
+
+```
+@online{Mamasaidov2023UzBooks,
+    author    = {Mukhammadsaid Mamasaidov and Abror Shopulatov},
+    title     = {UzBooks dataset},
+    year      = {2023},
+    url       = {https://huggingface.co/datasets/tahrirchi/uz-books},
+    note      = {Accessed: 2023-10-28}, % change this date
+    urldate   = {2023-10-28} % change this date
+}
+```
+
+
+## Contacts
+
+We believe that this work will enable and inspire all enthusiasts around the world to open the hidden beauty of low resource languages, in particular Uzbek. 
+
+For further development and issues about the dataset, please use [email protected] email to contact.