Tighten finetuning HTTP API reference#10
Merged
Merged
Conversation
There was a problem hiding this comment.
Pull request overview
This PR tightens the finetuning HTTP API reference to be more “contract-focused” while updating several endpoint schemas/examples to reflect the current API (notably /finetunes/:finetuneId, /rollouts, and /train_step).
Changes:
- Corrects
GET /finetunes/:finetuneIdto show the wrapped response shape ({ "finetune": { ... } }). - Updates
/rolloutsdocs/examples (e.g.,num_rollouts,spatial_refs,max_tokensdefaults, rollout metadata note). - Expands
/train_stepdocumentation to cover both RL and SFT modes, adds a “Targets” subsection, and documents a non-empty response shape with metrics.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
9768b72 to
36115db
Compare
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.
Summary
This trims the finetuning HTTP API reference back toward Vik's tighter version while keeping the real API additions we still want to document.
A lot of the previous edits had drifted into a more verbose, overly detailed style. This PR rolls much of that back so the page reads like an HTTP reference again instead of a trainer/SDK handoff doc.
What changed
POST /train_stepso the RL example clearly shows bothrequestandrolloutsTargetssubsection for SFT with a small table and concrete snippets for query, point, and detectAccuracy fixes
GET /finetunes/:finetuneIdto show the actual wrapped response shape:{ "finetune": { ... } }max_objects: 50defaultmax_tokensfor point/detect in the request examples where that had been documented incorrectlymax_objectsas detect-only in the settings tableslower->slower trainingVerification
tuna/src/tuna/rl/api_types.pymd-api