Update README.md to include detailed dataset information for Mahjong Souls Tiles, including dataset description, usage, associated model performance, training hyperparameters, and citation. Added license information and improved formatting for clarity.

README.md

@@ -1,144 +1,89 @@
 ---
 task_categories:
 - image-classification
+license: apache-2.0
 size_categories:
-- 1K<n<10K
+- 1k<n<10k
 ---
 
-# Dataset Card for Dataset Name
-
-<!-- Provide a quick summary of the dataset. -->
-
-This dataset card aims to be a base template for new datasets. It has been generated using [this raw template](https://github.com/huggingface/huggingface_hub/blob/main/src/huggingface_hub/templates/datasetcard_template.md?plain=1).
+# Dataset Card for Mahjong Souls Tiles
 
 ## Dataset Details
 
 ### Dataset Description
 
-<!-- Provide a longer summary of what this dataset is. -->
-
+This dataset, `pjura/mahjong_souls_tiles`, contains images of Mahjong tiles extracted from the game Mahjong Soul. It was created specifically for the purpose of training computer vision models to recognize Mahjong tiles within the game interface.
 
+The dataset was used to fine-tune the `google/vit-base-patch16-224-in21k` model, resulting in the `pjura/mahjong_vision` model available on Hugging Face.
 
-- **Curated by:** [More Information Needed]
-- **Funded by [optional]:** [More Information Needed]
-- **Shared by [optional]:** [More Information Needed]
-- **Language(s) (NLP):** [More Information Needed]
-- **License:** [More Information Needed]
+- **Curated by:** pjura
+- **License:** apache-2.0
 
-### Dataset Sources [optional]
+### Dataset Sources
 
-<!-- Provide the basic links for the dataset. -->
-
-- **Repository:** [More Information Needed]
-- **Paper [optional]:** [More Information Needed]
-- **Demo [optional]:** [More Information Needed]
+- **Repository:** [https://huggingface.co/datasets/pjura/mahjong_souls_tiles](https://huggingface.co/datasets/pjura/mahjong_souls_tiles)
+- **Associated Model:** [https://huggingface.co/pjura/mahjong_vision](https://huggingface.co/pjura/mahjong_vision)
 
 ## Uses
 
-<!-- Address questions around how the dataset is intended to be used. -->
-
 ### Direct Use
 
-<!-- This section describes suitable use cases for the dataset. -->
-
-[More Information Needed]
+This dataset is primarily intended for training or fine-tuning image classification models, specifically Vision Transformers (ViT) or similar architectures, for the task of recognizing Mahjong tiles from game screenshots or live feeds.
 
 ### Out-of-Scope Use
 
-<!-- This section addresses misuse, malicious use, and uses that the dataset will not work well for. -->
-
-[More Information Needed]
+Using this dataset for tasks unrelated to Mahjong tile recognition might not yield meaningful results. The images are specific to the art style and presentation of the Mahjong Soul game.
 
 ## Dataset Structure
 
-<!-- This section provides a description of the dataset fields, and additional information about the dataset structure such as criteria used to create the splits, relationships between data points, etc. -->
-
-[More Information Needed]
-
-## Dataset Creation
-
-### Curation Rationale
-
-<!-- Motivation for the creation of this dataset. -->
-
-[More Information Needed]
-
-### Source Data
-
-<!-- This section describes the source data (e.g. news text and headlines, social media posts, translated sentences, ...). -->
-
-#### Data Collection and Processing
-
-<!-- This section describes the data collection and processing process such as data selection criteria, filtering and normalization methods, tools and libraries used, etc. -->
-
-[More Information Needed]
-
-#### Who are the source data producers?
-
-<!-- This section describes the people or systems who originally created the data. It should also include self-reported demographic or identity information for the source data creators if this information is available. -->
-
-[More Information Needed]
-
-### Annotations [optional]
-
-<!-- If the dataset contains annotations which are not part of the initial data collection, use this section to describe them. -->
-
-#### Annotation process
-
-<!-- This section describes the annotation process such as annotation tools used in the process, the amount of data annotated, annotation guidelines provided to the annotators, interannotator statistics, annotation validation, etc. -->
-
-[More Information Needed]
-
-#### Who are the annotators?
-
-<!-- This section describes the people or systems who created the annotations. -->
-
-[More Information Needed]
-
-#### Personal and Sensitive Information
-
-<!-- State whether the dataset contains data that might be considered personal, sensitive, or private (e.g., data that reveals addresses, uniquely identifiable names or aliases, racial or ethnic origins, sexual orientations, religious beliefs, political opinions, financial or health data, etc.). If efforts were made to anonymize the data, describe the anonymization process. -->
-
-[More Information Needed]
-
-## Bias, Risks, and Limitations
-
-<!-- This section is meant to convey both technical and sociotechnical limitations. -->
-
-[More Information Needed]
-
-### Recommendations
-
-<!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. -->
-
-Users should be made aware of the risks, biases and limitations of the dataset. More information needed for further recommendations.
-
-## Citation [optional]
-
-<!-- If there is a paper or blog post introducing the dataset, the APA and Bibtex information for that should go in this section. -->
+The dataset consists of labeled images of individual Mahjong tiles. It is structured as an image folder dataset suitable for use with libraries like `datasets` and `torchvision`.
 
-**BibTeX:**
+## Associated Model Performance
 
-[More Information Needed]
+The `pjura/mahjong_vision` model, fine-tuned on this dataset, achieved the following results on the evaluation set:
 
-**APA:**
+- Loss: 0.0466
+- Accuracy: 0.9967
+- F1: 0.9966
+- Recall: 0.9967
 
-[More Information Needed]
+## Associated Model Training Details
 
-## Glossary [optional]
+### Training Hyperparameters
 
-<!-- If relevant, include terms and calculations in this section that can help readers understand the dataset or dataset card. -->
+The `pjura/mahjong_vision` model was trained with the following hyperparameters:
 
-[More Information Needed]
+- learning_rate: 5e-05
+- train_batch_size: 16
+- eval_batch_size: 16
+- seed: 42
+- gradient_accumulation_steps: 4
+- total_train_batch_size: 64
+- optimizer: Adam with betas=(0.9,0.999) and epsilon=1e-08
+- lr_scheduler_type: linear
+- lr_scheduler_warmup_ratio: 0.1
+- num_epochs: 250
 
-## More Information [optional]
+### Framework Versions
 
-[More Information Needed]
+- Transformers 4.34.1
+- Pytorch 2.1.0+cu121
+- Datasets 2.14.6
+- Tokenizers 0.14.1
 
-## Dataset Card Authors [optional]
+## Citation
 
-[More Information Needed]
+```bibtex
+@misc{mahjong_souls_tiles_dataset,
+  author = {pjura},
+  title = {Mahjong Souls Tiles Dataset},
+  year = {2023},
+  publisher = {Hugging Face},
+  journal = {Hugging Face repository},
+  howpublished = {\url{https://huggingface.co/datasets/pjura/mahjong_souls_tiles}}
+}
+```
 
 ## Dataset Card Contact
 
-[More Information Needed]
+pjura on Hugging Face ([https://huggingface.co/pjura](https://huggingface.co/pjura))