Update docs for 0.1.6: board-less submit, mrg jobs, decoupled job status - #7
Merged
Conversation
CLI/SDK guides still described client-side board picking (find_idle_fpga, --fpga-id as a board request) and the old job/logs/cancel <fpga_id> [job_id] signature -- both replaced by the board-less build-slot pipeline. Rewrote run/status/jobs/job/logs/cancel in cli.md, App(fpga_id=...)'s real meaning (--no-program reconnect only) in sdk.md, and quickstart's "picks an idle board" line to match. Added a 0.1.6 changelog entry. Also fixed reference/cloud.md's mkdocstrings member list: NoFPGAAvailableError no longer exists in mrg.cloud (removed with find_idle_fpga), and Stream was missing despite being a real, current export. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
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
docs/guides/cli.mdanddocs/guides/sdk.mdstill described the pre-0.1.6client-side board picking (
find_idle_fpga,--fpga-id/App(fpga_id=...)as a way to request a board for a fresh build) and the old
job/logs/cancel <fpga_id> [job_id]CLI signature. Rewrote all of it tomatch the real board-less build-slot pipeline:
fpga_idis discovered fromthe completed job, not picked;
--fpga-idonly matters for the--no-programreconnect case;job/logs/canceltake a barejob_id;added the missing
mrg jobscommand.docs/guides/quickstart.md: fixed the "picks an idle board automatically"line to match.
## 0.1.6changelog entry.docs/reference/cloud.md: fixed the mkdocstrings member list --NoFPGAAvailableErrorno longer exists inmrg.cloud(removed along withfind_idle_fpga), andStreamwas missing despite being a real, currentexport.
mkdocs build --strictpasses.Separate finding, not fixed here
src/manhattan_reasoning_gym/bench/silicon.py(CloudSilicon, thesandbox-to-real-silicon broker backend) still calls
_client.find_idle_fpga()and the old
_client.submit(fpga_id, path, ...)signature -- both removed inthe board-less refactor. This is dead code today (raises
AttributeErrorthemoment it runs) with zero test coverage, and isn't part of
reference/bench.md'sdocumented member list, so it's a real SDK bug rather than a docs issue. Flagging
it here rather than fixing it silently -- happy to open a follow-up PR for it if
wanted.
Test plan
mkdocs build --strict(with_code/refreshed to the real 0.1.6source) -- no warnings or errors
_cli.py/_app.py/_client.pysource (argparse definitions, docstrings)🤖 Generated with Claude Code