Rodrigo Agerri commited on
Commit
ca7fbdd
·
1 Parent(s): 0e7aaf6

polished readme

Browse files
Files changed (1) hide show
  1. README.md +22 -32
README.md CHANGED
@@ -54,7 +54,7 @@ configs:
54
 
55
  # CRITICS Science MT Benchmark (critics-SciMTBench)
56
 
57
- **A multilingual benchmark for evaluating machine translation of scientific text into Spanish and Basque.** Developed in the context of **CRITICS — Critical Science Without Borders**, a project on LLM-based access to scientific knowledge across linguistic boundaries.
58
 
59
  > **Evaluation-only release.** The benchmark must not be used for model training, fine-tuning, adaptation, or synthetic training-data generation. Access controls and the rights status of underlying source material require independent attention; see [Access, permitted use, and rights](#access-permitted-use-and-rights).
60
 
@@ -62,7 +62,7 @@ configs:
62
  |---|---|
63
  | Source language | English (`en`) |
64
  | Target languages | Spanish (`es`); Basque (`eu`) |
65
- | Main task | Scientific machine translation evaluation |
66
  | Source domains | Scientific excerpts originating from arXiv and ChemRxiv |
67
  | Available configurations | `en-es`, `en-eu` |
68
  | Available splits | `test` only for each configuration |
@@ -72,21 +72,18 @@ configs:
72
 
73
  ## 1. Dataset overview
74
 
75
- **critics-SciMTBench** is a working evaluation resource for scientific machine translation. The supplied dataset-card description identifies English scientific excerpts and corresponding machine-translated texts in Spanish and Basque, with provision for human-post-edited references when independently supplied and approved. At the present stage, human references are `null`; this is **not** a reference-based benchmark release.
76
 
77
  The resource is intended to support research on scientific translation in multilingual contexts, particularly translation quality, terminology, and reliable assessment of scientific content. The broader CRITICS project also investigates document-level translation and multidimensional evaluation methods. These are *project research objectives*, not measured capabilities or validated results of the present dataset.
78
 
79
  ### Scope and present limitations
80
 
81
  - The published dataset configurations are **English–Spanish** and **English–Basque**; neither additional language pairs nor reference translations should be inferred from the project-level language agenda.
82
- - Both configurations expose a `test` split; there are no advertised `train` or `validation` partitions.
83
- - The source documentation describes **10 input batches** and identifiers stable at the sample and batch level; original article/document keys remain provisional until reconciled.
84
- - No automatic quality scores, human agreement statistics, linguistic-domain breakdowns, or benchmark results are claimed here because they are not established by the supplied documentation.
85
 
86
  ## 2. Loading the dataset
87
 
88
- The following examples use the actual Hugging Face repository identifier and the configurations declared in this card. **Access requires repository approval and authentication if gating is enabled in the repository settings.**
89
-
90
  ```bash
91
  pip install -U datasets huggingface_hub
92
  hf auth login
@@ -112,7 +109,6 @@ To inspect the English source for the first record (using the field name describ
112
  ```python
113
  print(en_eu[0]["source_text"])
114
  ```
115
-
116
  **Do not combine the two language-pair configurations as if they were independent source documents.** Related records may originate from the same English excerpts; preserve sample and batch IDs when carrying out cross-language comparisons or computing uncertainty estimates.
117
 
118
  ### Obtaining supplementary files
@@ -130,7 +126,7 @@ local_repo = snapshot_download(
130
  print(local_repo)
131
  ```
132
 
133
- The directories below describe the **working repository organization** in the supplied README. Their presence in the currently published Hub repository has not been independently verified; check the repository's **Files and versions** tab before relying on these paths.
134
 
135
  ```text
136
  critics_science_mt_benchmark/
@@ -141,14 +137,12 @@ critics_science_mt_benchmark/
141
  │ ├── pairs/
142
  │ │ ├── en-es/test.jsonl # Config: en-es
143
  │ │ ��── en-eu/test.jsonl # Config: en-eu
144
- │ ├── canonical/ # Optional; rights review required
145
  │ └── reports/ # Structural ingestion reports
146
- ├── original_input/ # Original files from 10 batches; optional
147
- └── post_edits/ # Optional restricted human references
148
  ```
149
 
150
- Original source files, canonical multi-language exports, and post-edited references are **not automatically included** in either `test` configuration. Do not publish rights-restricted originals or protected references merely to make the repository structure match this illustration.
151
-
152
  ## 3. Data organization and provenance
153
 
154
  The dataset is organized by **translation direction**, with two language-pair JSONL evaluation files:
@@ -158,29 +152,25 @@ The dataset is organized by **translation direction**, with two language-pair JS
158
  | `en-es` | English | Spanish | `test` | `data/pairs/en-es/test.jsonl` |
159
  | `en-eu` | English | Basque | `test` | `data/pairs/en-eu/test.jsonl` |
160
 
161
- The source material is described as coming from **arXiv and ChemRxiv**. The working pipeline distinguishes original input batches, a canonical multilingual representation, and pairwise evaluation exports. The original files are intended to be preserved unchanged; the canonical representation is an authoritative *derived* internal format and need not be published.
162
-
163
- A provisional article or document key is not a verified bibliographic identifier. Resolve article attribution and applicable licenses at the article level before any broader release of texts or translated derivatives.
164
 
165
  ### References and scoring
166
 
167
- Human-post-edited reference translations are currently **unavailable** (`null` in the supplied description). Therefore:
168
 
169
- - Do not treat an existing MT output as a gold-standard translation.
170
- - Do not report reference-based quality metrics as if verified human references were present.
171
- - If reference translations are incorporated later, document who produced or reviewed them, the associated rights, revision history, and the evaluation protocol.
172
- - Keep protected evaluation references out of training corpora, synthetic-data pipelines, and public search indexes.
173
 
174
  ## 4. CRITICS project
175
 
176
- **CRITICS — Critical Science Without Borders** (*LLMs for Translation of Scientific Knowledge in Multilingual Contexts*) is a research project funded under **CHIST-ERA IV Cofund 2025**, within the **Science in your Own Language (SOL)** topic. Its aim is to improve multilingual access to scientific knowledge while supporting scientific literacy, evidence-based argumentation, and critical thinking.
177
 
178
  | Project detail | Information |
179
  |---|---|
180
  | Project name | Critical Science Without Borders (CRITICS) |
181
  | Programme | CHIST-ERA IV Cofund 2025 - Science in your Own Language (SOL) |
182
  | Project period | 15 December 2025 - 14 December 2028 (36 months) |
183
- | Project coordinator| Rodrigo Agerri HiTZ Center - Ixa, University of the Basque Country EHU|
184
  | Project website | [hitz.eus/critics](https://hitz.eus/critics) |
185
 
186
  ### Consortium and research responsibilities
@@ -192,24 +182,24 @@ Human-post-edited reference translations are currently **unavailable** (`null` i
192
  | **CNRS and UCA** | France | Argument mining and assessment (WP4) |
193
  | **Zurich University of Applied Sciences (ZHAW)** | Switzerland | Evaluation and applications (WP5–WP6) |
194
 
195
- The project pursues four connected objectives:
196
 
197
  1. **LLM-based translation of scientific documents**, emphasizing document-level fidelity and specialized terminology in low- and medium-resource language settings.
198
  2. **Argument mining and misconception detection**, focusing on evidence-based reasoning and scientific discourse.
199
  3. **Automatic assessment and critical-thinking support**, including critical questions, feedback, and consistent evaluation across languages.
200
  4. **Evaluation and benchmarking**, investigating methods beyond traditional reference-overlap metrics, including multidimensional LLM-as-a-judge methods and human comparison.
201
 
202
- **How this dataset contributes:** critics-SciMTBench provides scientific-text evaluation material for the translation and benchmarking strand of CRITICS. It is complementary to, but distinct from, the [CRITICS Science Assessments dataset](https://huggingface.co/datasets/HiTZ/critics_science_assessments), which focuses on classifying student responses against assessment rubrics. The scientific translation benchmark does **not** itself supply instructor assessments or automatically generated feedback.
203
 
204
  For more information: [CRITICS project website](https://hitz.eus/critics) · [HiTZ Center](https://www.hitz.eus/)
205
 
206
- ## 5. Intended use and methodological precautions
207
 
208
- **Permitted goal (subject to repository access conditions and underlying rights):** evaluate and compare scientific machine translation systems, including careful analysis of terminology, semantic preservation, and cross-language behavior.
209
 
210
  **Not permitted under the stated benchmark-use conditions:** use for training, fine-tuning, model adaptation, or synthetic training-data generation; republish, mirror, or transfer benchmark texts or derivatives to publicly crawlable repositories or training corpora.
211
 
212
- Evaluation users should report the language-pair configuration, dataset revision, batch/sample identifiers where relevant, model and decoding configuration, evaluation prompts or scoring protocol, and any human review procedures. Avoid presenting experimental model outputs as human reference translations.
213
 
214
  ## 6. Access, permitted use, and rights
215
 
@@ -217,9 +207,9 @@ The benchmark is intended to be distributed as **gated, evaluation-only material
217
 
218
  **Source and derivative rights remain under review.** arXiv and ChemRxiv host materials under potentially different article-level terms. Online availability does not itself authorize redistribution, translation, or relicensing. Before releasing any scientific excerpt or derivative, check the specific work's license, permissions, and any third-party content.
219
 
220
- **License metadata note:** The supplied README contained a conflict: `license: cc-by-4.0` in YAML but prose stating that article-level redistribution licenses remain unresolved. This revised draft uses `license: other` **provisionally** to avoid asserting CC BY 4.0 for all underlying material. This is not a legal license grant. The maintainer must select and document appropriate licensing or access terms once the source-rights review is complete. The evaluation-only conditions may impose restrictions that are not compatible with an unrestricted CC BY 4.0 claim.
221
 
222
- ## 7. Citation and maintenance
223
 
224
  If you use this benchmark, cite the **CRITICS project**, a published paper coming soon.
225
 
 
54
 
55
  # CRITICS Science MT Benchmark (critics-SciMTBench)
56
 
57
+ **A multilingual benchmark for document-level evaluation of machine translation of scientific text into Spanish and Basque.** Developed in the context of **CRITICS - Critical Science Without Borders**, a project on LLM-based access to scientific knowledge across linguistic boundaries.
58
 
59
  > **Evaluation-only release.** The benchmark must not be used for model training, fine-tuning, adaptation, or synthetic training-data generation. Access controls and the rights status of underlying source material require independent attention; see [Access, permitted use, and rights](#access-permitted-use-and-rights).
60
 
 
62
  |---|---|
63
  | Source language | English (`en`) |
64
  | Target languages | Spanish (`es`); Basque (`eu`) |
65
+ | Main task | Scientific machine translation evaluation at document level|
66
  | Source domains | Scientific excerpts originating from arXiv and ChemRxiv |
67
  | Available configurations | `en-es`, `en-eu` |
68
  | Available splits | `test` only for each configuration |
 
72
 
73
  ## 1. Dataset overview
74
 
75
+ **critics-SciMTBench** is a working evaluation resource for **scientific machine translation at document level**. Currently it contains English scientific excerpts and corresponding machine-translated texts in Spanish and Basque, with provision for human-post-edited references when independently supplied and approved. At the present stage, human references are `null`; this is **not** a reference-based benchmark release.
76
 
77
  The resource is intended to support research on scientific translation in multilingual contexts, particularly translation quality, terminology, and reliable assessment of scientific content. The broader CRITICS project also investigates document-level translation and multidimensional evaluation methods. These are *project research objectives*, not measured capabilities or validated results of the present dataset.
78
 
79
  ### Scope and present limitations
80
 
81
  - The published dataset configurations are **English–Spanish** and **English–Basque**; neither additional language pairs nor reference translations should be inferred from the project-level language agenda.
82
+ - Both configurations expose a `test` split; there are no `train` or `validation` partitions available.
83
+ - No automatic quality scores, human agreement statistics, linguistic-domain breakdowns, or benchmark results are coming soon.
 
84
 
85
  ## 2. Loading the dataset
86
 
 
 
87
  ```bash
88
  pip install -U datasets huggingface_hub
89
  hf auth login
 
109
  ```python
110
  print(en_eu[0]["source_text"])
111
  ```
 
112
  **Do not combine the two language-pair configurations as if they were independent source documents.** Related records may originate from the same English excerpts; preserve sample and batch IDs when carrying out cross-language comparisons or computing uncertainty estimates.
113
 
114
  ### Obtaining supplementary files
 
126
  print(local_repo)
127
  ```
128
 
129
+ The directories below describe the **working repository organization**:
130
 
131
  ```text
132
  critics_science_mt_benchmark/
 
137
  │ ├── pairs/
138
  │ │ ├── en-es/test.jsonl # Config: en-es
139
  │ │ ��── en-eu/test.jsonl # Config: en-eu
140
+ │ ├── canonical/ # canonical files generated from the original input (batches)
141
  │ └── reports/ # Structural ingestion reports
142
+ ├── original_input/ # Original files from 10 batches
143
+ └── post_edits/ # human validated reference translations
144
  ```
145
 
 
 
146
  ## 3. Data organization and provenance
147
 
148
  The dataset is organized by **translation direction**, with two language-pair JSONL evaluation files:
 
152
  | `en-es` | English | Spanish | `test` | `data/pairs/en-es/test.jsonl` |
153
  | `en-eu` | English | Basque | `test` | `data/pairs/en-eu/test.jsonl` |
154
 
155
+ The source material is extracted from **arXiv and ChemRxiv**. The working pipeline distinguishes original input batches, a canonical multilingual representation, and pairwise evaluation exports for training and inference with language models. The original files are intended to be preserved unchanged; the canonical representation is an authoritative *derived* internal format.
 
 
156
 
157
  ### References and scoring
158
 
159
+ Human-post-edited reference translations are currently **work in progress** (`null` in the supplied description). Therefore:
160
 
161
+ - Available MT outputs should be used as gold-standard or human-validated reference translations.
162
+ - Reference-based quality metrics should not be reported as if verified human references were present.
 
 
163
 
164
  ## 4. CRITICS project
165
 
166
+ **CRITICS - Critical Science Without Borders** (*LLMs for Translation of Scientific Knowledge in Multilingual Contexts*) is a research project funded under **CHIST-ERA IV Cofund 2025**, within the **Science in your Own Language (SOL)** topic. Its aim is to improve multilingual access to scientific knowledge while supporting scientific literacy, evidence-based argumentation, and critical thinking.
167
 
168
  | Project detail | Information |
169
  |---|---|
170
  | Project name | Critical Science Without Borders (CRITICS) |
171
  | Programme | CHIST-ERA IV Cofund 2025 - Science in your Own Language (SOL) |
172
  | Project period | 15 December 2025 - 14 December 2028 (36 months) |
173
+ | **Project coordinator**| **Rodrigo Agerri** HiTZ Center - Ixa, University of the Basque Country EHU|
174
  | Project website | [hitz.eus/critics](https://hitz.eus/critics) |
175
 
176
  ### Consortium and research responsibilities
 
182
  | **CNRS and UCA** | France | Argument mining and assessment (WP4) |
183
  | **Zurich University of Applied Sciences (ZHAW)** | Switzerland | Evaluation and applications (WP5–WP6) |
184
 
185
+ The project states four connected objectives:
186
 
187
  1. **LLM-based translation of scientific documents**, emphasizing document-level fidelity and specialized terminology in low- and medium-resource language settings.
188
  2. **Argument mining and misconception detection**, focusing on evidence-based reasoning and scientific discourse.
189
  3. **Automatic assessment and critical-thinking support**, including critical questions, feedback, and consistent evaluation across languages.
190
  4. **Evaluation and benchmarking**, investigating methods beyond traditional reference-overlap metrics, including multidimensional LLM-as-a-judge methods and human comparison.
191
 
192
+ **How this dataset contributes:** critics-SciMTBench provides scientific-text evaluation material for the translation and benchmarking of MT at document level. It is complementary to, but distinct from, the [CRITICS Science Assessments dataset](https://huggingface.co/datasets/HiTZ/critics_science_assessments), which focuses on student responses with respect to data-induced assessment rubrics.
193
 
194
  For more information: [CRITICS project website](https://hitz.eus/critics) · [HiTZ Center](https://www.hitz.eus/)
195
 
196
+ ## 5. Intended use
197
 
198
+ **Permitted goal (subject to repository access conditions and underlying rights):** evaluate and compare scientific machine translation systems at document level, including careful analysis of terminology, semantic preservation, and cross-language behavior.
199
 
200
  **Not permitted under the stated benchmark-use conditions:** use for training, fine-tuning, model adaptation, or synthetic training-data generation; republish, mirror, or transfer benchmark texts or derivatives to publicly crawlable repositories or training corpora.
201
 
202
+ Evaluation users should report the language-pair configuration, dataset revision, batch/sample identifiers where relevant, model and decoding configuration, evaluation prompts or scoring protocol, and any human review procedures.
203
 
204
  ## 6. Access, permitted use, and rights
205
 
 
207
 
208
  **Source and derivative rights remain under review.** arXiv and ChemRxiv host materials under potentially different article-level terms. Online availability does not itself authorize redistribution, translation, or relicensing. Before releasing any scientific excerpt or derivative, check the specific work's license, permissions, and any third-party content.
209
 
210
+ **License metadata note:** Remains pending to select and document appropriate licensing or access terms once the source-rights review (arXiv and ChemRxiv) is complete.
211
 
212
+ ## 7. Citation
213
 
214
  If you use this benchmark, cite the **CRITICS project**, a published paper coming soon.
215