Upload README.md with huggingface_hub

README.md

@@ -1,93 +1,48 @@
----
-dataset_info:
-  features:
-  - name: text
-    dtype: string
-  - name: id
-    dtype: string
-  - name: dump
-    dtype: string
-  - name: url
-    dtype: string
-  - name: date
-    dtype: string
-  - name: file_path
-    dtype: string
-  - name: offset
-    dtype: int64
-  - name: token_count
-    dtype: int64
-  - name: language
-    dtype: string
-  - name: page_average_lid
-    dtype: string
-  - name: page_average_lid_score
-    dtype: float64
-  - name: full_doc_lid
-    dtype: string
-  - name: full_doc_lid_score
-    dtype: float64
-  - name: per_page_languages
-    list: string
-  - name: is_truncated
-    dtype: bool
-  - name: extractor
-    dtype: string
-  - name: page_ends
-    list: int64
-  - name: fw_edu_scores
-    list: float64
-  - name: fw_edu_v2_scores
-    dtype: 'null'
-  - name: dclm_scores
-    dtype: 'null'
-  - name: ocr_quality_scores
-    dtype: 'null'
-  - name: minhash_cluster_size
-    dtype: int64
-  - name: duplicate_count
-    dtype: int64
-  - name: cysill_errors
-    list:
-    - name: following_hr_text
-      dtype: string
-    - name: human_readable
-      dtype: string
-    - name: human_readable_offset
-      dtype: int64
-    - name: is_spelling
-      dtype: bool
-    - name: message
-      dtype: string
-    - name: offset_end
-      dtype: int64
-    - name: offset_start
-      dtype: int64
-    - name: preceding_hr_text
-      dtype: string
-    - name: suggestions
-      list:
-      - name: human_readable
-        dtype: string
-      - name: replacement
-        struct:
-        - name: length_to_replace
-          dtype: int64
-        - name: offset
-          dtype: int64
-        - name: text
-          dtype: string
-  - name: cysill_errors_count
-    dtype: int64
-  splits:
-  - name: train
-    num_bytes: 32754975
-    num_examples: 184
-  download_size: 12449344
-  dataset_size: 32754975
-configs:
-- config_name: default
-  data_files:
-  - split: train
-    path: data/train-*
----
+# Dataset Card: finepdfs-cy-errors
+
+## Description
+
+This dataset contains Welsh-language text extracted from PDFs using rolmOCR, with automated spelling and grammar error annotations generated by Cysill (the Welsh spell checker). The dataset is derived from the Welsh (cym_Latn) subset of HuggingFaceFW/finepdfs, filtered to include only documents processed with the rolmOCR extractor.
+
+## Dataset Statistics
+
+### Corpus Size
+- **Total number of words**: 1,575,836
+- **Total number of errors found with Cysill**: 73,574
+- **Number of documents**: 183
+- **Average words per document**: 8611.13
+- **Average errors per document**: 402.04
+
+### Processing Details
+- **Source dataset**: HuggingFaceFW/finepdfs (cym_Latn subset, test split)
+- **Extractor filter**: rolmOCR only
+- **Spell checker**: Cysill v2 API
+- **Language**: Welsh (Cymraeg)
+
+## Fields
+
+- `text`: The extracted text content from the PDF
+- `cysill_errors`: List of error objects returned by Cysill API
+- `cysill_errors_count`: Number of errors detected in the text
+- (Additional fields inherited from finepdfs dataset)
+
+## Processing Configuration
+
+- Cysill API configuration:
+  - Format: text
+  - Language: cy (Welsh)
+  - Max errors per chunk: 1000
+  - Accept English: true
+  - Chunk size: 50,000 characters (split by paragraphs)
+
+## Usage
+
+This dataset can be used for:
+- Evaluating OCR quality for Welsh-language documents
+- Analyzing common spelling and grammar errors in Welsh text
+- Training or evaluating spell-checking and grammar-checking models for Welsh
+- Assessing the quality of PDF text extraction methods
+
+## Hub Location
+
+`techiaith/finepdfs-cy-errors`