Skip to content

docs: document the score scales (FineScore, Rating, Rating10, Rating20) - #99

Merged
YoanSallami merged 2 commits into
mainfrom
docs/score-types
Aug 21, 2026
Merged

docs: document the score scales (FineScore, Rating, Rating10, Rating20)#99
YoanSallami merged 2 commits into
mainfrom
docs/score-types

Conversation

@YoanSallami

@YoanSallami YoanSallami commented Aug 21, 2026

Copy link
Copy Markdown
Contributor

Summary

Follow-up to #98: user-facing docs for the new score scales and the score_type argument, plus a fix for the broken source-snippet syntax across the docs.

  • New API page Data Models API → Score Data Models rendering synalinks.src.backend.pydantic.metrics: Score, FineScore, Rating, Rating10, Rating20, plus get_score_type / normalize_score. Listed in the Data Models API index and the mkdocs nav.
  • Data Models guide (guide 2): Rating row in the types table; a paragraph after the Score section introducing the sibling scales and score_type; summary bullet updated.
  • Modules guide (guide 4): SelfCritique section explains the default Score reward and how score_type changes the scale (instructions + schema follow, value normalized to 0..1).
  • Rewards guide (guide 13): LMAsJudge section gets a score_type=synalinks.Rating example and the normalization note.
  • Source-snippet line anchors of the three edited guides recomputed; their Colab notebooks regenerated (data_models, modules, rewards). Other notebooks were left untouched even though the generator would reformat them (cell ids / unicode escaping drift vs. what's committed), to keep this PR to the docs change.
  • Snippet syntax fix (57 pages): the "Source" blocks used --8 < --"path:N", which pymdownx snippets does not recognize, so the literal marker rendered instead of the code. Restored --8<-- "path:N" (and the :source section form) everywhere, and recomputed the three anchors that had gone stale (RLM agent, Deep Agent, Python Synthesis guides).

Test plan

  • uv run zensical build --clean succeeds (with check_paths: true, so every snippet path resolves); the new page renders all scales/helpers and the three guide pages show the new text
  • Rendered guide/example pages now contain the expanded source code and no raw --8<-- markers
  • Guides still parse and pass ruff
  • No em dashes introduced

🤖 Generated with Claude Code

YoanSallami and others added 2 commits August 21, 2026 15:02
Add a "Score Data Models" API page rendering `backend.pydantic.metrics`
(the `Score`/`FineScore`/`Rating*` scales plus `get_score_type` and
`normalize_score`), list it in the Data Models API index and nav, and
mention the new scales and the `score_type` argument where users meet
them: the Data Models guide (Score section, types table, summary), the
Modules guide (SelfCritique) and the Rewards guide (LMAsJudge).

Recompute the source-snippet line anchors of the three edited guides and
regenerate their Colab notebooks.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
The "Source" block of 57 pages used `--8 < --"path:N"`, which pymdownx
snippets does not recognize, so the literal marker was rendered instead of
the code. Restore `--8<-- "path:N"` (and the `:source` section form), and
recompute the three line anchors that had gone stale (RLM agent, Deep
Agent, Python Synthesis guides) now that the snippets are live again.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
@YoanSallami
YoanSallami merged commit a4c02f9 into main Aug 21, 2026
6 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant