docs(mri): document leaderboard jobs property#652
Merged
Conversation
Co-Authored-By: lino <lino@rapidata.ai>
ReviewDocs-only PR expanding documentation for the I cross-checked every technical claim in the new prose/code samples against the actual implementation:
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). |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
Expands the documentation for the
RapidataLeaderboard.jobsproperty added in #651.docs/mri.md— the "Retrieving Results" section now explains that each evaluation runs as a job and shows how to iterateleaderboard.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 viajob.get_results()/.to_pandas(), and notes that runs without an associated job are skipped.Notes
uv run --group docs mkdocs buildsucceeds (remaining warnings are pre-existing and unrelated).🔗 Session: https://session-ed5c819e.poseidon.rapidata.internal/