docs: guide, environment, protocol and contributing pages match the code - #23
Merged
Merged
Conversation
…he code - commands that run as written, and the env and protocol contracts in full
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.
An audit of the user guide, environment, protocol and contributing pages against the code found commands that fail as written, and contracts that leave out what an env has to do. This fixes those pages, in both languages.
Commands that failed
dummy-v1, and every client command passes--server-host 127.0.0.1, since the default0.0.0.0cannot be connected to on Windows.plugrl-run-*commands afteruv syncwere not on PATH. Every page now runs them withuv run, from inside the repository.*_env.py, or a script ending incli.main().--runner.use-env-lock, not--use-env-lock.Contracts that were missing
best_reward_threshold_for_success, without whichrollout/successis always 0;reset_indices;seed_rngs/np_random;info(onlyepisode, as SPEC.md now says);--resumeand--exp-name, recording, and the robomimic variants.What was run. The dummy pair and the custom env were run end to end against a real server on this laptop. The custom env was run both out of tree and in tree, with 2 envs and with 2 processes. Every flag was checked against the real
--help. The LIBERO and robomimic commands were checked against their config classes, since those extras are not installed here.mkdocs build --strictpasses.Merge after these, because the pages describe their behaviour:
infocloses one connection, not the server);videoextra) and docs: checking a client is one command now #13 (the state-only robomimic variants).