search

OCR-D / quiver-back-end

The back end of the OCR-D quality dashboard webapp.
MIT License
1 stars 2 forks source link

feat: add metrics_definitions.json #36

Closed mweidling closed 2 years ago

mweidling commented 2 years ago

This PR adds a metrics_definitions.json that holds a short description (taken from the ocrd_eval.schema.json) as well as a link to the more elaborate definitions (currently pointing to a test instance) to the repository.

Closes OCR-D/zenhub#132

kba commented 2 years ago

Could we not add this info to the schema directly? Why do we need two places with the same information?

kba commented 2 years ago

JSON Schema has at least three fields we could use for this, title, description and $comment. Or we could just extend the schema schema and add a label field.

Also, while not a priority, it's probably wise to start with support for multiple languages, a construct like

wer:
  description:
    en: Number of words with errors divided by number of words
    de: Anzahl von falsch erkannten Worten geteilt durch die Anzahl von Wörtern
  label:
    en: Word Error Rate
    de: Wortfehlerrate
  title:
    en: WER
    de: WFR :)
mweidling commented 2 years ago

Could we not add this info to the schema directly? Why do we need two places with the same information?

You're right, I will improve this in the course of the sprint. As I tried to explain in the planning this is just a quick and dirty approach since @paulpestov wanted to have some data for his presentation tomorrow.