Upload README.md with huggingface_hub

README.md

@@ -1,19 +1,91 @@
----
-dataset_info:
-  features:
-  - name: शब्द
-    dtype: string
-  - name: विलोम
-    dtype: string
-  splits:
-  - name: train
-    num_bytes: 103458
-    num_examples: 2491
-  download_size: 49814
-  dataset_size: 103458
-configs:
-- config_name: default
-  data_files:
-  - split: train
-    path: data/train-*
----
+# Hindi Antonyms Dataset (हिंदी विलोम शब्दकोश)
+
+## Overview
+
+This dataset contains a comprehensive collection of Hindi words and their antonyms (विलोम शब्द). It is designed to assist NLP research, language learning, and applications focused on Hindi language processing. The dataset provides word-antonym pairs that can be used for tasks like:
+
+- Semantic analysis
+- Language learning and education
+- Text enrichment
+- Linguistic research
+- Vocabulary expansion
+
+## Dataset Structure
+
+The dataset contains the following columns:
+
+- `शब्द` (Word): The Hindi word
+- `विलोम` (Antonym): The antonym of the given word
+
+## Dataset Statistics
+
+- Total word pairs: ~2500
+- Format: Available in parquet format
+- Split: Single train split (100% of data)
+
+
+## Example Entries
+
+| शब्द (Word) | विलोम (Antonym) |
+|------------|-----------------|
+| अनादि      | आदि              |
+| अमृत       | विष               |
+| अकाल       | सुकाल             |
+| अंकुश      | निरंकुश            |
+| अनुकूल     | प्रतिकूल           |
+
+## Usage
+
+```python
+from datasets import load_dataset
+
+# Load the dataset
+dataset = load_dataset("Process-Venue/hindi-antonyms")
+
+# Access the training split
+train_data = dataset["train"]
+
+# Get a sample
+sample = train_data[0]
+print(f"Word: {sample['शब्द']}, Antonym: {sample['विलोम']}")
+```
+
+## Source and Preparation
+
+This dataset was compiled from various Hindi language resources and educational materials. It was converted from a text file to a structured parquet format with standardized train/validation/test splits to facilitate machine learning applications.
+
+## License
+
+This dataset is shared under [Creative Commons Attribution 4.0 International License](https://creativecommons.org/licenses/by/4.0/).
+
+## Citation
+
+If you use this dataset in your research or application, please cite:
+
+```
+@misc{hindi-antonyms-dataset,
+  title={Hindi Antonyms Dataset},
+  author={Process Venue},
+  year={2025},
+  howpublished={HuggingFace Datasets},
+  url={https://huggingface.co/datasets/Process-Venue//hindi-antonyms}
+  website={https://www.processvenue.com/}
+}
+```
+
+
+## Contact
+
+We are here to help! Our team is ready to assist you with:
+
+- **Custom Dataset Creation**: Need a specialized dataset? We can help you build it.
+- **Data Enhancement**: We can expand or customize this dataset for your specific requirements.
+- **Technical Support**: Questions about implementation or integration? We're happy to assist.
+- **Collaboration Opportunities**: Interested in partnering on language technology projects? Let's talk!
+
+For questions, suggestions, or personalized dataset requests, please:
+- Open an issue on the dataset repository
+- Contact us directly at: [email protected]
+- Visit our website: [www.processvenue.com](https://www.processvenue.com/)
+
+We welcome feedback and are committed to supporting the NLP and language learning communities.