Create README.md

README.md

@@ -0,0 +1,79 @@
+---
+task_categories:
+- text-classification
+- feature-extraction
+language:
+- en
+---
+# Text Quality Meta-Analysis Dataset
+
+This dataset contains sentences with associated quality metrics derived from multiple sources and methods.
+
+## Dataset Summary
+
+The Sentence Quality Meta-Analysis Dataset combines text from various sources with quality scores from different models to create a comprehensive assessment of sentence quality. It includes text, individual model scores, sentence length, and a derived composite quality metric. It's an expanded and streamlined version of another dataset, [agentlans/text-quality](https://huggingface.co/datasets/agentlans/text-quality).
+
+"Quality" means that the sentence is legible English, not spam, and contains useful information.
+It doesn't necessarily mean that the sentence is grammatically or factually correct.
+
+## Supported Tasks
+
+This dataset is suitable for:
+
+- Sentence quality prediction
+- Text classification
+- Natural language processing model evaluation
+- Linguistic analysis of sentence structure and quality
+
+## Dataset Structure
+
+### Data Instances
+
+Each instance in the dataset contains:
+
+- `text` (string): The sentence text
+- `fineweb` (float): Quality score from [HuggingFaceFW/fineweb-edu-classifier](https://huggingface.co/HuggingFaceFW/fineweb-edu-classifier) after transformation
+- `nvidia` (float): Quality score from [nvidia/quality-classifier-deberta](https://huggingface.co/nvidia/quality-classifier-deberta) after transformation
+- `length` (float): Length of the sentence in characters after transformation
+- `quality` (float): Composite quality score derived from other metrics
+
+### Data Splits
+
+The dataset is divided into two main files:
+
+1. `all.csv`: Contains all processed sentences
+2. `train.csv`: A balanced subset for training, with up to 10 000 sentences per quality group
+
+## Dataset Creation
+
+### Source Data
+
+Sentences were collected from multiple sources:
+
+- [allenai/c4](https://huggingface.co/datasets/allenai/c4)
+- [HuggingFaceFW/fineweb-edu](https://huggingface.co/datasets/HuggingFaceFW/fineweb-edu)
+- [monology/pile-uncopyrighted](https://huggingface.co/datasets/monology/pile-uncopyrighted)
+
+### Annotations
+
+Quality scores were generated using:
+
+- HuggingFaceFW/fineweb-edu-classifier (logits)
+- nvidia/quality-classifier-deberta (difference of logits for "High" and "Low" classes)
+
+### Personal and Sensitive Information
+
+No personal or sensitive information is included in this dataset.
+
+## Considerations for Using the Data
+
+### Social Impact of Dataset
+
+This dataset can be used to improve natural language processing models and text quality assessment tools. However, users should be aware of potential biases in the source data and scoring models.
+Users should consider these potential biases when interpreting results or developing applications based on this data.
+
+### Other Known Limitations
+
+- The composite quality score is derived from limited sources and may not capture all aspects of text quality.
+- The dataset focuses only on English language sentences.
+- It doesn't differentiate between true and false sentences, only their potential information value.