Skip to content

docs: add the documentation for temperature rescales likelihood-score - #1734

Open
pavani42 wants to merge 1 commit into
generative-computing:mainfrom
pavani42:docs/1687-intrinsic-temperature-scoring
Open

pavani42 wants to merge 1 commit into
generative-computing:mainfrom
pavani42:docs/1687-intrinsic-temperature-scoring

Conversation

@pavani42

@pavani42 pavani42 commented Oct 13, 2026 •

Copy link
Copy Markdown

Pull Request

Issue

Fixes #1687

Description

Document how temperature and sampling options effect likelihood-based scores returned by adapter functions when using LocalHFBackend.

  • Clarify the model_options description in the check_certainty() and
    requirement_check() docstrings.
  • Add a "How temperature affects scores" section to the adapter functions
    guide (docs/docs/advanced/intrinsics.md), covering temperature and
    do_sample.

This covers the documentation part of #1687. Returning the sampled label or
answer-token distribution (the issue's second suggestion) is not included and
would need a separate API change.

Testing

  • Tests added to the respective file if code was changed
  • New code has 100% coverage if code was added
  • Ensure existing tests and github automation passes (a maintainer will kick off the github automation when the rest of the PR is populated)

Attribution

  • AI coding assistants used

…d outputs

requirement_check() and check_certainty() score from answer-token
probabilities, so temperature rescales the score without adding
randomness. Document this in the docstrings and the adapter guide.

Refs generative-computing#1687
Assisted-by: IBM Bob

Signed-off-by: pavani42 <sindiripavani01@gmail.com>
@pavani42
pavani42 requested a review from a team as a code owner October 13, 2026 19:18
@github-actions github-actions Bot added the documentation Improvements or additions to documentation label Oct 13, 2026
@ajbozarth
ajbozarth requested a review from planetf1 October 13, 2026 20:27

This branch has not been deployed

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

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

docs(intrinsics): document that temperature rescales (not randomises) likelihood-scored outputs on LocalHF

1 participant