Update README.md
Browse files
README.md
CHANGED
|
@@ -29,3 +29,161 @@ configs:
|
|
| 29 |
- split: test
|
| 30 |
path: data/test-*
|
| 31 |
---
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 29 |
- split: test
|
| 30 |
path: data/test-*
|
| 31 |
---
|
| 32 |
+
# Dataset Analysis Report
|
| 33 |
+
|
| 34 |
+
## Dataset Format
|
| 35 |
+
|
| 36 |
+
The dataset is provided in **Parquet** format with the following structure:
|
| 37 |
+
|
| 38 |
+
| Field | Description |
|
| 39 |
+
| ------------- | ----------------------------------------------- |
|
| 40 |
+
| `instruction` | Instruction or question provided to the model |
|
| 41 |
+
| `input` | Additional input or contextual information |
|
| 42 |
+
| `output` | Expected response generated for the instruction |
|
| 43 |
+
|
| 44 |
+
## Dataset Statistics
|
| 45 |
+
|
| 46 |
+
| Metric | Result |
|
| 47 |
+
| --------------------------- | -----: |
|
| 48 |
+
| Total rows | 1,000 |
|
| 49 |
+
| Valid rows | 1,000 |
|
| 50 |
+
| Invalid rows | 0 |
|
| 51 |
+
| Columns | 3 |
|
| 52 |
+
| Expected fields per row | 3 |
|
| 53 |
+
| Rows with missing fields | 0 |
|
| 54 |
+
| Rows with unexpected fields | 0 |
|
| 55 |
+
|
| 56 |
+
### Fields
|
| 57 |
+
|
| 58 |
+
```text
|
| 59 |
+
['input', 'instruction', 'output']
|
| 60 |
+
```
|
| 61 |
+
|
| 62 |
+
## Duplicate Analysis
|
| 63 |
+
|
| 64 |
+
| Check | Result |
|
| 65 |
+
| -------------------------------- | -----: |
|
| 66 |
+
| Exact duplicate rows | 0 |
|
| 67 |
+
| Duplicate groups | 0 |
|
| 68 |
+
| Duplicate instructions | 215 |
|
| 69 |
+
| Duplicate responses | 2 |
|
| 70 |
+
| Near-duplicate instruction pairs | 69 |
|
| 71 |
+
|
| 72 |
+
No exact duplicate rows were detected. However, **215 duplicate instructions**, **2 duplicate responses**, and **69 near-duplicate instruction pairs** were identified.
|
| 73 |
+
|
| 74 |
+
## Quality Analysis
|
| 75 |
+
|
| 76 |
+
The automated analysis identified the following quality flags:
|
| 77 |
+
|
| 78 |
+
| Quality Issue | Rows | Percentage |
|
| 79 |
+
| -------------------------------- | ----: | ---------: |
|
| 80 |
+
| English words detected | 1,000 | 100.00% |
|
| 81 |
+
| Missing values | 1,000 | 100.00% |
|
| 82 |
+
| Low Devanagari ratio | 93 | 9.30% |
|
| 83 |
+
| HTML noise | 21 | 2.10% |
|
| 84 |
+
| URLs detected | 16 | 1.60% |
|
| 85 |
+
| Potentially incomplete responses | 10 | 1.00% |
|
| 86 |
+
|
| 87 |
+
> **Important:** The `missing_values` check flagged all 1,000 rows. This means the automated analysis identified at least one field as missing according to its configured missing-value rules. The result should be manually reviewed, particularly for the `input` field, because an intentionally empty `input` may be a valid characteristic of an instruction/input/output dataset rather than an actual data-quality error.
|
| 88 |
+
|
| 89 |
+
## Analysis Summary
|
| 90 |
+
|
| 91 |
+
```text
|
| 92 |
+
Total rows : 1,000
|
| 93 |
+
Flagged rows : 1,000
|
| 94 |
+
Flagged percentage : 100.00%
|
| 95 |
+
|
| 96 |
+
Data status : ANALYSIS ONLY
|
| 97 |
+
Cleaning performed : NO
|
| 98 |
+
```
|
| 99 |
+
|
| 100 |
+
All 1,000 rows were flagged by at least one automated quality check. Being flagged does **not necessarily mean that every row is unusable**; it means that every row requires review according to the configured analysis rules.
|
| 101 |
+
|
| 102 |
+
## Overall Dataset Quality
|
| 103 |
+
|
| 104 |
+
| Metric | Result |
|
| 105 |
+
| --------------------- | -------------- |
|
| 106 |
+
| Overall Quality Score | 66.40 / 100 |
|
| 107 |
+
| Quality Grade | D |
|
| 108 |
+
| Dataset Status | NEEDS CLEANING |
|
| 109 |
+
|
| 110 |
+
### Strengths
|
| 111 |
+
|
| 112 |
+
* No exact duplicate rows detected.
|
| 113 |
+
* No possible PII detected.
|
| 114 |
+
* All rows follow the expected `instruction` / `input` / `output` schema.
|
| 115 |
+
* All 1,000 rows are valid records according to the analysis.
|
| 116 |
+
|
| 117 |
+
### Identified Issues
|
| 118 |
+
|
| 119 |
+
* 215 duplicate instructions detected.
|
| 120 |
+
* 2 duplicate responses detected.
|
| 121 |
+
* English words were detected in all 1,000 rows.
|
| 122 |
+
* 21 rows contain HTML noise.
|
| 123 |
+
* 16 rows contain URLs.
|
| 124 |
+
* 10 responses were potentially incomplete.
|
| 125 |
+
* 93 rows have a low Devanagari ratio.
|
| 126 |
+
* The automated analysis flagged missing values in all 1,000 rows.
|
| 127 |
+
* 69 near-duplicate instruction pairs were identified.
|
| 128 |
+
|
| 129 |
+
## Recommendation
|
| 130 |
+
|
| 131 |
+
Significant cleaning and manual review are recommended before using this dataset for model training.
|
| 132 |
+
|
| 133 |
+
Priority should be given to reviewing:
|
| 134 |
+
|
| 135 |
+
1. Duplicate and near-duplicate instructions.
|
| 136 |
+
2. The 100% missing-value flag, especially whether empty `input` fields are intentional.
|
| 137 |
+
3. English-word detection across the dataset.
|
| 138 |
+
4. Low-Devanagari-ratio records.
|
| 139 |
+
5. HTML noise and URLs.
|
| 140 |
+
6. Potentially incomplete responses.
|
| 141 |
+
|
| 142 |
+
## Analysis Method
|
| 143 |
+
|
| 144 |
+
The dataset was analyzed without modifying the original data.
|
| 145 |
+
|
| 146 |
+
The analysis included:
|
| 147 |
+
|
| 148 |
+
* Dataset structure and schema validation
|
| 149 |
+
* Missing-value detection
|
| 150 |
+
* Exact duplicate detection
|
| 151 |
+
* Duplicate instruction detection
|
| 152 |
+
* Duplicate response detection
|
| 153 |
+
* Near-duplicate instruction detection
|
| 154 |
+
* English-word detection
|
| 155 |
+
* Devanagari-ratio analysis
|
| 156 |
+
* HTML-noise detection
|
| 157 |
+
* URL detection
|
| 158 |
+
* Potential incomplete-response detection
|
| 159 |
+
* Possible PII detection
|
| 160 |
+
* Overall dataset quality scoring and grading
|
| 161 |
+
|
| 162 |
+
### Cleaning Status
|
| 163 |
+
|
| 164 |
+
**No cleaning, deletion, modification, or automatic correction was performed during this analysis.**
|
| 165 |
+
|
| 166 |
+
The analysis script only identified and flagged potential quality issues for subsequent manual review and cleaning.
|
| 167 |
+
|
| 168 |
+
## Analysis Outputs
|
| 169 |
+
|
| 170 |
+
The analysis generated the following files:
|
| 171 |
+
|
| 172 |
+
```text
|
| 173 |
+
analysis_report(train).json
|
| 174 |
+
flagged_rows(train).jsonl
|
| 175 |
+
```
|
| 176 |
+
|
| 177 |
+
`analysis_report(train).json` contains the complete dataset-level analysis results, including dataset structure, schema consistency, duplicate statistics, language analysis, quality flags, incomplete-response analysis, and the overall quality score.
|
| 178 |
+
|
| 179 |
+
`flagged_rows(train).jsonl` contains the individual records flagged by the automated quality checks for manual review.
|
| 180 |
+
|
| 181 |
+
## Final Assessment
|
| 182 |
+
|
| 183 |
+
**Overall Quality Score:** 66.40 / 100
|
| 184 |
+
**Grade:** D
|
| 185 |
+
**Status:** NEEDS CLEANING
|
| 186 |
+
|
| 187 |
+
The dataset has a valid and consistent three-column `instruction` / `input` / `output` structure with 1,000 valid rows and no exact duplicate rows. However, the automated analysis identified duplicate instructions, near-duplicate instructions, duplicate responses, English-word occurrences, missing-value flags, low Devanagari ratios, HTML noise, URLs, and potentially incomplete responses.
|
| 188 |
+
|
| 189 |
+
The dataset should therefore undergo **manual review and targeted cleaning** before being considered ready for model training.
|