Skip to content

docs(mri): document leaderboard jobs property#652

Merged
LinoGiger merged 1 commit into
mainfrom
docs(mri)/document-leaderboard-jobs-property
Jul 6, 2026
Merged

docs(mri): document leaderboard jobs property#652
LinoGiger merged 1 commit into
mainfrom
docs(mri)/document-leaderboard-jobs-property

Conversation

@RapidPoseidon

Copy link
Copy Markdown
Contributor

What

Expands the documentation for the RapidataLeaderboard.jobs property added in #651.

  • docs/mri.md — the "Retrieving Results" section now explains that each evaluation runs as a job and shows how to iterate leaderboard.jobs, with a pointer to the advanced guide.
  • docs/mri_advanced.md — adds an "Accessing the Underlying Jobs" section covering how to reach the raw comparison results behind the standings via job.get_results() / .to_pandas(), and notes that runs without an associated job are skipped.

Notes

  • uv run --group docs mkdocs build succeeds (remaining warnings are pre-existing and unrelated).
  • Docs-only change.

🔗 Session: https://session-ed5c819e.poseidon.rapidata.internal/

Co-Authored-By: lino <lino@rapidata.ai>
@claude

claude Bot commented Jul 6, 2026

Copy link
Copy Markdown

Review

Docs-only PR expanding documentation for the RapidataLeaderboard.jobs property (added in #651) — a short mention in docs/mri.md plus a full "Accessing the Underlying Jobs" section in docs/mri_advanced.md.

I cross-checked every technical claim in the new prose/code samples against the actual implementation:

  • RapidataLeaderboard.jobs (rapidata_leaderboard.py) returns list[RapidataJob], sorted via sort=["-created_at"] — confirms the "most recent first" claim.
  • Runs without a job_id are filtered out (if run.job_id is not None) — confirms the "runs without an associated job are skipped" claim.
  • RapidataJob.name, .get_status(), .view(), and .get_results() -> RapidataResults all exist as documented.
  • RapidataResults.to_pandas() exists, matching the advanced-guide example.
  • get_status() == "Completed" is a real, exact enum value (AudienceJobState.COMPLETED = 'Completed'), so the if job.get_status() != "Completed": continue snippet is correct.
  • The mri_advanced.md#accessing-the-underlying-jobs anchor link matches the new heading's generated slug.
  • Code fences in mri.md are balanced after splitting the single block into prose + two blocks.

No correctness, security, or convention issues found — nothing to flag. Nice, focused addition that follows the CLAUDE.md guidance to stay concise and avoid repeating information (the intro page links out to the advanced page rather than duplicating detail).

@LinoGiger LinoGiger marked this pull request as ready for review July 6, 2026 14:29
@LinoGiger LinoGiger self-requested a review as a code owner July 6, 2026 14:29
@LinoGiger LinoGiger merged commit 48470bf into main Jul 6, 2026
2 checks passed
@LinoGiger LinoGiger deleted the docs(mri)/document-leaderboard-jobs-property branch July 6, 2026 14:30
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.

2 participants