Image-to-Text
Transformers
Sinhala
trocr
ocr
sinhala
printed-text
vision-encoder-decoder
sinhala-print-trocr / REPRODUCIBILITY_CHECKLIST.md
kaan84's picture
Add Phase 0 research package
18fcd7f verified
|
Raw
History Blame
1.61 kB

Reproducibility Checklist

Complete every item before public release.

Claims and scope

  • Primary research question is stated.
  • Confirmatory hypotheses are stated before training.
  • In-scope and out-of-scope uses are stated.
  • Final claims match the evaluation unit.

Data

  • Immutable model and dataset revisions recorded.
  • Train and validation indices committed.
  • Split-index SHA-256 checksums recorded.
  • Real line benchmark frozen before prediction review.
  • Exclusion rules and counts reported.
  • Dataset licenses and attributions included.

Training

  • Seeds and fixed hyperparameters declared.
  • Hardware and runtime recorded.
  • Dependency versions recorded.
  • Checkpoints saved in safetensors format.
  • TensorBoard logs retained under runs/.
  • Three seeded runs completed.

Evaluation

  • CER is the primary metric.
  • WER is secondary.
  • Text normalization is specified.
  • Raw and normalized results reported.
  • Paired bootstrap confidence intervals reported.
  • Baselines run on identical evaluation units.
  • Period-level sample counts reported.
  • Error analysis follows the pre-declared taxonomy.

Publication

  • Intermediate checkpoint license clarified.
  • Model-card metadata updated with the final license.
  • Real results added to model-index.
  • Inference example tested from a clean environment.
  • Intended use, limitations, bias, and responsible-use sections reviewed.
  • DOI generated after the repository becomes stable.
  • Final citation added.