Update README.md

README.md

@@ -1,3 +1,126 @@
----
-license: mit
----
+---
+license: mit
+---
+
+# Dataset Card for Basic Words
+
+This dataset contains a collection of basic words and phrases in English and Hmar, organized into different categories such as "namesofheavenlybodies" and "daysoftheweek." It is personally created by Donal Muolhoi to supplement or complement other datasets for the Hmar language.
+
+## Dataset Details
+
+### Dataset Description
+
+This dataset provides translations for basic words and phrases between English and Hmar, structured into specific categories. Each category is stored in its own folder, with CSV files containing word pairs, and will be expanded to include example phrases. For example, the "namesofheavenlybodies" folder contains translations of planetary names, while the "daysoftheweek" folder contains translations of the days of the week. Future expansions will add example phrases relevant to each category.
+
+- **Curated by:** Donal Muolhoi
+- **Language(s) (NLP):** English, Hmar
+- **License:** MIT
+
+### Dataset Sources
+
+- **Repository:** [More Information Needed]
+- **Paper [optional]:** [More Information Needed]
+- **Demo [optional]:** [More Information Needed]
+
+## Uses
+
+### Direct Use
+
+This dataset is intended for use in translation tasks between English and Hmar, particularly in language learning, linguistic research, and cultural preservation. The inclusion of example phrases allows for practical application in context-based translations.
+
+### Out-of-Scope Use
+
+This dataset is not suitable for tasks outside of basic word translation or linguistic analysis, such as sentiment analysis or tasks requiring broader vocabulary beyond the provided categories.
+
+## Dataset Structure
+
+The dataset is organized into subfolders, with each folder containing a CSV file of English-Hmar word pairs and example phrases. For example:
+
+- **data/namesofheavenlybodies/namesofheavenlybodies.csv**
+- **data/daysoftheweek/daysoftheweek.csv**
+
+Each CSV file follows the structure:
+
+en,hmr "English word/phrase","Hmar translation"
+
+### Example Phrases:
+
+en,hmr "the first day of the week is sunday","Pathienni hi khat a ni hmasatak anih."
+
+## Dataset Creation
+
+### Curation Rationale
+
+This dataset was created to support the preservation and promotion of the Hmar language by providing essential word pairs and example phrases. It aims to be a supplemental resource for existing Hmar language datasets, helping users to gain a better understanding of the language in practical contexts.
+
+### Source Data
+
+The data was manually compiled from linguistic resources, including dictionaries, books, and native speakers of Hmar.
+
+#### Data Collection and Processing
+
+The data was manually collected and cross-verified with native Hmar speakers to ensure accuracy. Each word pair and example phrase was checked for proper usage in the Hmar language.
+
+#### Who are the source data producers?
+
+The source data producers include Donal Muolhoi, native speakers of Hmar, and other linguistic resources.
+
+### Annotations [optional]
+
+This dataset does not contain annotations beyond the word pairs and example phrases.
+
+#### Annotation process
+
+N/A
+
+#### Who are the annotators?
+
+N/A
+
+#### Personal and Sensitive Information
+
+This dataset contains no personal or sensitive information.
+
+## Bias, Risks, and Limitations
+
+### Biases
+
+The dataset may not capture the full breadth of Hmar vocabulary or regional variations in the language. It focuses on basic words and phrases and may not cover more complex linguistic concepts.
+
+### Risks
+
+The dataset may not be comprehensive enough for advanced language tasks, but it is designed to be a helpful resource for basic translations and context-based learning.
+
+### Limitations
+
+The dataset’s scope is limited to basic words and example phrases in specific categories. It will need to be expanded to include more comprehensive language features.
+
+### Recommendations
+
+Users should be aware of the dataset's limitations and use it for tasks involving basic word translation or context-based language learning. It is not intended for more complex linguistic analysis.
+
+## Citation [optional]
+
+**BibTeX:**
+
+[More Information Needed]
+
+**APA:**
+
+[More Information Needed]
+
+## Glossary [optional]
+
+- **Pathienni hi khat a ni hmasatak anih.**: The first day of the week is Sunday. (Hmar)
+
+## More Information [optional]
+
+For further information or to contribute to this dataset, please contact Donal Muolhoi at [email protected].
+
+## Dataset Card Authors [optional]
+
+Donal Muolhoi
+
+## Dataset Card Contact
+
+For any questions regarding this dataset, please contact Donal Muolhoi at [email protected].