Repository navigation
docs: add design and quick-start guides; fix docker build paths - #5
Merged
Merged
Conversation
Co-authored-by: Cursor <cursoragent@cursor.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.
Problem
New users had no single place to learn how RoboSmith works or to get from a fresh GPU node to a first run.
docker/README.mdbuiltdocker/Dockerfile, which no longer exists, and the steps for GraspGen weights,the gfx950 GraspGen layer, and the rocRobo sidecar were not written down anywhere in the repository.
Change
docs/design.md: data flow, layer contracts, and the key concepts (asset affordances and metadata, CAPscenarios, the grasp filter pipeline, segment-level motion routing, the collision world, articulation, outputs),
plus current limits.
docs/quick-start.md: host layout → image per GPU arch → GraspGen weights → rocRobo sidecar →run_scenario.sh→ outputs, and troubleshooting for cold compile, dead serve, and straight-line fallback.docker/README.mdand theDockerfile.gfx950header build from the files that exist.Layer: docs and runtime images. No code changes.
Evidence
(
git ls-files/git grep -w); none missing.rocrobo_dev,/rocrobo/.jax_cache,ROCROBO_REQUEST_TIMEOUT_S=300, the*_rocm.pthpreference ingraspgen_wrapper.py, the dataset path inrun_generated_scenario.py, and the launcher defaults inrun_scenario.sh.AI use