Initialize portable humanoid RL framework with licenses, locks and CI
Core and layout checks / core (push) Has been cancelled
Core and layout checks / core (push) Has been cancelled
This commit is contained in:
@@ -0,0 +1,79 @@
|
||||
# Vendored backend sources and assets
|
||||
|
||||
Like Jumper's `rl/` layout, this project installs backend copies as **top-level packages** through
|
||||
`pip install -e .` / `uv sync`, not through working-directory-dependent import tricks.
|
||||
`rl/` deliberately has no `__init__.py`. Package discovery includes namespaces: upstream's
|
||||
`mjlab/scripts` has no initializer but still contains real source that must be included in wheels.
|
||||
|
||||
| Path | Source | Baseline | License |
|
||||
|---|---|---|---|
|
||||
| `rl/mjlab/` | [mujocolab/mjlab](https://github.com/mujocolab/mjlab) plus recorded local changes | 1.6.0, commit in `rl/upstream/import.json` | Apache-2.0; embedded components retain their licenses |
|
||||
| `rl/rsl_rl/` | Installed `rsl-rl-lib` release, checked against its distribution RECORD hashes | 5.5.1 | BSD-3-Clause |
|
||||
| `rl/mjlab/asset_zoo/robots/booster_t1/assets/` | [BoosterRobotics/booster_assets](https://github.com/BoosterRobotics/booster_assets) | `T1_23dof.xml` and its referenced meshes; commit recorded | BSD-3-Clause |
|
||||
| `rl/mjlab/asset_zoo/robots/unitree_g1/` | mjlab's adapted MuJoCo Menagerie model | Preserved with upstream mjlab assets | Unitree BSD-3-Clause |
|
||||
|
||||
## What was imported
|
||||
|
||||
The mjlab copy contains tracked package files from the validated checkout, **including its two
|
||||
modified runtime files**, plus the T1 robot/task Python modules. Unrelated private/untracked
|
||||
Apollo/R1 experiments, prompts, logs, environments and keyboard applications are not imported.
|
||||
Other tracked upstream example assets remain intact; their presence does not register them as
|
||||
supported Universal Humanoid tasks.
|
||||
|
||||
RSL-RL Python files were verified against the installed release's RECORD before copying. No
|
||||
algorithm changes were applied. Its release METADATA and upstream mjlab pyproject are preserved
|
||||
under `rl/upstream/`, without creating separately installed backend distributions.
|
||||
|
||||
## Explicit differences
|
||||
|
||||
| File | Origin / purpose |
|
||||
|---|---|
|
||||
| `rl/mjlab/sim/sim.py` | Retains the pre-existing local patch suppressing only LS_ITERATIONS/ITERATIONS warnings. This is **not** evidence of solver convergence; other overflow warnings remain. |
|
||||
| `rl/mjlab/tasks/velocity/mdp/velocity_command.py` | Retains configurable `min_forward_velocity`; T1 uses a smaller minimum than G1. |
|
||||
| `rl/mjlab/asset_zoo/robots/booster_t1/t1_constants.py` | The imported T1 adapter now defaults to bundled assets, with an explicit optional `BOOSTER_ASSETS_ROOT` override. No personal HOME fallback. |
|
||||
| `rl/mjlab/tasks/velocity/config/booster_t1/` | T1 environment, PPO configuration and reward extension, previously external/untracked, now included. |
|
||||
|
||||
The first two inherited changes are preserved as the actual upstream-relative diff in
|
||||
`rl/upstream/mjlab-local.patch`; their regression tests and the imported T1 test are retained in
|
||||
`rl/upstream/tests/` as reference material. They are not automatically mixed into this project's
|
||||
pytest suite. Our adapter/conformance/behavior tests exercise the supported integration.
|
||||
Changed runtime files carry `[uh-vendor]` notices. The initial source inventory is
|
||||
`rl/upstream/import.json`; the current distributable inventory is `rl/VENDOR.json`.
|
||||
|
||||
## Verify and update deliberately
|
||||
|
||||
```bash
|
||||
python3 tools/vendor_manifest.py
|
||||
./scripts/uh verify-vendor
|
||||
```
|
||||
|
||||
Built-wheel resource parity can also be checked with
|
||||
`python3 tools/check_wheel.py dist/universal_humanoid-0.2.0-py3-none-any.whl` after `uv build --wheel`.
|
||||
It checks all package sources, model resources and licenses against the checkout, catching missing
|
||||
namespace modules that an editable install could conceal.
|
||||
|
||||
Both inventory commands compare every non-cache file under `rl/` against recorded SHA-256 hashes; extra, missing and
|
||||
modified files fail. No updater runs automatically. For a reviewed vendor revision:
|
||||
|
||||
1. Record the upstream release/commit, licenses and inherited patches.
|
||||
2. Make changes in this repository only, adding a clear modification notice to changed source.
|
||||
3. Update this document and review the diff against the initial import inventory.
|
||||
4. Run the adapter, negative conformance, setup and GPU pipeline checks.
|
||||
5. Explicitly record the accepted files with `python3 tools/vendor_manifest.py --record`.
|
||||
6. If dependencies changed, regenerate `uv.lock` and its pip export, and repeat clean-install checks.
|
||||
|
||||
A hash inventory detects accidental drift; it does not prove safety or authenticate arbitrary code.
|
||||
A deliberate hash refresh without review defeats its purpose. Source snapshots/provenance now
|
||||
include RSL-RL source identity, robot declarations and the dependency lock, not just mjlab.
|
||||
|
||||
## Licensing and distribution
|
||||
|
||||
License texts travel inside both package directories and are included as wheel resources. The
|
||||
mjlab assets and Isaac Lab-derived helpers carry their corresponding license texts in
|
||||
`rl/mjlab/licenses/`; RSL-RL's dependencies and pfrl attribution are under `rl/rsl_rl/licenses/`.
|
||||
T1 assets carry their own `assets/LICENSE`. See [NOTICE.md](../NOTICE.md) for attribution.
|
||||
|
||||
The upstream licenses do not automatically choose a license for this project's original code or
|
||||
settle authorship of downstream additions. Select that license and review downstream attribution
|
||||
before announcing an open-source release. No credentials or proprietary robot transport code is
|
||||
included, and no physical deployment support is implied.
|
||||
Reference in New Issue
Block a user