Skip to content

quality-report: no threshold watches editor_truncated_rate #159

Description

@bbertucc

/v1/quality gained editor_truncated_rate in #151: the share of documents where a correction round's response hit the model's output ceiling, so the round was discarded and the document shipped as it entered that round, with <!-- @editor-truncated --> in it. Nothing reads it. .github/workflows/quality-report.yml has thresholds for unresolved_rate, links_dropped_rate, lint_error_rate, mean_rounds and per-rule share, so a rise in truncated rounds is the one quality regression in the tally that files no issue.

It was left out of #151 on purpose. Every other threshold in that workflow is a number someone chose against observed rates, and the file says so; picking one for a metric with no history means picking a number that is either so loose it never fires or so tight it files an issue in its first week. A month of real values is the input this needs.

What to do once there are numbers:

  • Add EDITOR_TRUNCATED_RATE_MAX alongside the other *_MAX inputs and into the THRESHOLDS object.
  • Add a finding branch. Suggested severity 2, between dropped links and unresolved: like a dropped link this is content loss — corrections the editor actually made were thrown away — but unlike a dropped link the source content is still present, so it does not outrank it.
  • Title has to be stable in the sense the comment above sev insists on: no rate and no threshold in it. Something like "Quality regression: correction rounds are being discarded at the output ceiling".
  • The body already gets metric/value/threshold, which is where the numbers belong.

Before choosing the number, note that this rate is not independent of document length: the editor's output length follows the length of the document it is rewriting, not the number of issues in it, so a week of unusually long inputs moves this rate without anything being wrong with the pipeline. Whatever threshold is chosen should be loose enough to survive that, or the finding should say so in its body.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementNew feature or request

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions