add-install-docker-ci-e2e
Installation
SKILL.md
Add Install, Docker Build, and CI for a New Model or Environment
Use this skill when adding a new model or new environment (or combination) to RLinf so that: (1) users can install it via requirements/install.sh, (2) a Docker image can be built for it (optional), (3) CI runs install, Docker build, and an end-to-end test.
1. Install script (requirements/install.sh)
-
Register model or env
- New model: add to
SUPPORTED_MODELS(e.g."dexbotic"). - New environment: add to
SUPPORTED_ENVS(e.g."maniskill_libero").
- New model: add to
-
Implement install logic
- New model: add
install_<model>_model()that switches onENV_NAMEand for each supported env: create venv, install common embodied deps, env-specific deps, and the model. Call it from the maincase "$MODEL"(add a newmodel_name)branch that runsinstall_<model>_model). - New env only (no new model): either add a new env branch inside an existing
install_*_model()or addinstall_<env>_env()and call it from the relevant model installers. If the env is used byinstall_env_only, add a branch ininstall_env_onlyfor that env.
- New model: add
-
Help text
print_helpshowsSUPPORTED_MODELSandSUPPORTED_ENVS; no change needed if you only added to those arrays.