Update README.md

README.md

@@ -34,4 +34,159 @@ tags:
 pretty_name: Climate Guard Toxic Agent
 size_categories:
 - 10K<n<100K
----
+---
+
+# Consolidated Climate Disinformation Dataset
+
+## Dataset Description
+
+This dataset is a comprehensive consolidation of multiple climate-related datasets, focusing on climate disinformation and factual climate information. It combines and standardizes data from various high-quality sources to create a robust resource for climate-related text classification tasks.
+
+### Dataset Sources
+
+The dataset incorporates data from the following sources:
+- Tonic Climate Guard Series:
+  - climate-guard-thinking_data_nocomment_qwen_toxic_agent
+  - climate-guard-synthetic_data_qwen_toxic_agent
+  - climate-guard-thinking_data_nocomment_intern_toxic_agent
+  - climate-guard-thinking_data_nocomment_phi4_toxic_agent
+  - climate-guard-thinking_data_nocomment_yi_toxic_agent
+  - climate-guard-synthetic_data_yi_toxic_agent
+- QuotaClimat/frugalaichallenge-text-train
+- Climate FEVER dataset
+- Quota Climat dataset (12% random sample)
+
+## Data Processing
+
+The dataset underwent several processing steps to ensure quality and consistency:
+
+1. **Text Cleaning**:
+   - Removed responses starting with apology phrases ("I'm sorry", "I am sorry", "I apologize", "Given the directive")
+   - Cleaned text between "---" markers
+   - Standardized text formatting
+
+2. **Label Standardization**:
+   - Maintained consistent label format across all sources
+   - Special handling for '0_not_relevant' labels from specific sources
+
+3. **Source Tracking**:
+   - Added source identifiers to track data origin
+   - Preserved dataset provenance information
+
+## Dataset Structure
+
+The dataset is split into training and testing sets with the following features:
+
+```python
+DatasetDict({
+    'train': Dataset({
+        features: ['identifier', 'text', 'label'],
+        num_examples: <num_examples>
+    }),
+    'test': Dataset({
+        features: ['identifier', 'text', 'label'],
+        num_examples: <num_examples>
+    })
+})
+```
+
+### Features:
+
+- **identifier**: String identifying the source dataset
+- **text**: The main text content
+- **label**: Classification label
+
+### Labels:
+
+- `0_not_relevant`
+- `1_not_happening`
+- `2_not_human`
+- `3_not_bad`
+- `4_solutions_harmful_unnecessary`
+- `5_science_is_unreliable`
+- `6_proponents_biased`
+- `7_fossil_fuels_needed`
+
+## Usage
+
+```python
+from datasets import load_dataset
+
+# Load the dataset
+dataset = load_dataset("your-username/consolidated-climate-dataset")
+
+# Access training data
+train_data = dataset['train']
+
+# Access test data
+test_data = dataset['test']
+```
+
+## Dataset Statistics
+
+```python
+# Example statistics (to be filled with actual numbers)
+Total examples: XXX
+Training examples: XXX
+Test examples: XXX
+Label distribution: {
+    "0_not_relevant": XXX,
+    "1_not_happening": XXX,
+    ...
+}
+```
+
+## Intended Uses
+
+This dataset is designed for:
+- Training climate disinformation detection models
+- Developing fact-checking systems
+- Analyzing climate-related discourse patterns
+- Research in climate communication
+
+## Limitations
+
+- The dataset may contain some inherent biases from source datasets
+- Some sources are synthetic or AI-generated data
+- Language is primarily English
+- Coverage may vary across different types of climate disinformation
+
+## Citation
+
+If you use this dataset, please cite both this consolidated version and the original source datasets:
+
+```bibtex
+@dataset{consolidated_climate_dataset,
+    author = {Your Name},
+    title = {Consolidated Climate Disinformation Dataset},
+    year = {2024},
+    publisher = {Hugging Face},
+    url = {https://huggingface.co/datasets/your-username/consolidated-climate-dataset}
+}
+```
+
+## License
+
+This dataset is released under the same licenses as its source datasets. Please refer to individual source datasets for specific license information.
+
+## Contact
+
+For questions or issues regarding this dataset, please open an issue on the dataset's GitHub repository or contact the maintainers through Hugging Face.
+
+## Acknowledgments
+
+We thank the creators and maintainers of all source datasets used in this consolidation:
+- The Tonic AI team
+- QuotaClimat team
+- Climate FEVER dataset creators
+- All other contributors to the source datasets
+
+## Updates and Maintenance
+
+This dataset will be periodically updated to:
+- Fix any identified issues
+- Include new relevant source datasets
+- Improve data quality and consistency
+
+Last updated: [Current Date]
+Version: 1.0.0