SO101 pick-and-place: archive study source and reproduction guide outside NeDM results PR
6039542 verified |
Download so101_pick_place/code/README.md from uwsbel/NeDM: direct link, hf CLI and curl.
- Browser
- Download file 14.2 kB
-
https://huggingface.co/datasets/uwsbel/NeDM/resolve/main/so101_pick_place/code/README.md
- Command line
-
hf download hf://datasets/uwsbel/NeDM/so101_pick_place/code/README.md
-
curl -L -o README.md https://huggingface.co/datasets/uwsbel/NeDM/resolve/main/so101_pick_place/code/README.md
14.2 kB
| # NeDM — Neural Reduced Dynamics for Complex Robot Control | |
| Code and artifacts for *Learning the Right Abstraction: Neural Reduced Dynamics | |
| for Complex Robot Control* (Zhang and Negrut). | |
| **Project page: <https://uwsbel.github.io/NeDM/>** — figures, and the nine | |
| side-by-side Chrono rollouts behind the Study Case I result. Its source is | |
| [`web/`](web/README.md). | |
| High-fidelity Chrono trajectories are distilled into a task-specific neural | |
| reduced dynamics model (NN-ROM); the model is frozen and replicated into a | |
| vectorized environment where a control policy is trained with PPO; the trained | |
| policy is then returned to the full Chrono system for closed-loop validation. | |
| Two study cases instantiate the pipeline across three control tasks: | |
| - **Study Case I** — terrain-aware HMMWV trajectory tracking on rigid, bumpy and | |
| deformable CRM terrain. A 15-D reduced state carries body motion plus a | |
| per-wheel terramechanics block; a two-class terrain code resolves the | |
| rigid-vs-CRM ambiguity. One policy trained inside the conditioned model beats | |
| both single-terrain specialists on all three terrains, including zero-shot | |
| bumpy. | |
| - **Study Case II** — an M113 tracked vehicle with a front-mounted 4-DOF arm, | |
| driven by two independent tasks. A 3-D planar state serves base goal reaching | |
| (100/100 goals in Chrono at 0.75 m); an 8-D joint-space state serves arm | |
| end-effector reaching (97/100 at 0.05 m, zero contacts or joint-limit | |
| violations), with the end-effector recovered by forward kinematics rather than | |
| learned. | |
| **Follow-on work, not part of the paper:** [`traversing/`](traversing/README.md) | |
| records an off-road traversing study. A learned route-risk planner picks routes | |
| across generated hill-and-crater terrain in Chrono, on rigid ground and CRM | |
| soil, with results that vary by vehicle and ground. Separately, a route tracker | |
| trained with PPO inside a learned reduced dynamics model is compared with PID: | |
| it tracks routes more closely on rigid ground but completes fewer routes on | |
| soil. The folder records milestones, evidence and limits through 2026-09-28. | |
| The study's data and models are in the `traversing/` folder of the Hugging Face | |
| dataset; its training and evaluation code is in `src/nedm/traversing/`. | |
| **Follow-on work, not part of the paper:** [`contact_nrd/`](contact_nrd/README.md) | |
| extends neural reduced dynamics (NRD) to contacts that start and stop: a bouncing ball, two pool balls, | |
| an SO101 arm that pushes a T, and a Unitree G1 humanoid that a frozen walking policy drives in MuJoCo. | |
| A core network, a collision network and a contact network, with one design for all four cases, predict | |
| each 20 ms step. The first three cases share one training config; G1 has its own. The data, test sets | |
| and trained models are in the `contact_nrd/` folder of the Hugging Face dataset; the code is in | |
| `src/nedm/contact_nrd/`. | |
| **Follow-on work, not part of the paper:** [`so101_push_rl/`](so101_push_rl/README.md) | |
| trains one PPO policy inside a contact NRD of the SO101 arm and the T, then | |
| checks it in Chrono: it pushes the T to small and large translation and rotation | |
| goals (82–96 % of the sealed test goals of each trained goal type). The NRD, its | |
| training data, the RL inputs, the policies and the Chrono evaluations are in the | |
| `so101_push_rl/` folder of the Hugging Face dataset; the code is in | |
| `src/nedm/so101_push_rl/`, `scripts/so101_push_rl/` and `configs/so101_push_rl/`. | |
| **Follow-on work, not part of the paper:** [`g1_footstep_rl/`](g1_footstep_rl/README.md) | |
| trains a footstep policy with PPO inside the G1 contact NRD, then checks it in MuJoCo. The policy sets | |
| the velocity command of the frozen walking policy (HOMIE) so that the feet land on given footprints, on | |
| a flat floor and on planks with gaps: it completes 92–100 % of the development courses of each course | |
| type, a hand-written footstep controller 0–28 %. The policies, RL inputs, MuJoCo results and videos are | |
| in the `g1_footstep_rl/` folder of the Hugging Face dataset; the code is in `src/nedm/g1_footstep_rl/`, | |
| `scripts/g1_footstep_rl/` and `configs/g1_footstep_rl/`. | |
| **Follow-on work, not part of the paper:** [`so101_pick_place/`](so101_pick_place/README.md) | |
| trains a camera policy for a real SO101 arm only inside a contact NRD of the arm and a cube: a state | |
| teacher with PPO, then a camera student with online DAgger on ray-traced images of a calibrated copy of | |
| the real scene. With no real image in training, the student placed the cube on the plate in 36 of 50 | |
| episodes of a stress test on the real arm (72 %; 95 % interval 58–83 %). The NRD, its data and sealed | |
| test set, every teacher and student checkpoint, the robot bundle, the robot logs and videos are in the | |
| `so101_pick_place/` folder of the Hugging Face dataset; the code is in `src/nedm/so101_policy/`, | |
| `src/nedm/render/`, `src/nedm/contact_nrd/collect/`, `scripts/so101_pick_place/` and `scripts/so101_policy/`. | |
| **[docs/progress.md](docs/progress.md) is the reproduction record** — every stage | |
| output with the artifact that produced it and the command that regenerates it. | |
| Start there. | |
| ## Environment | |
| ```bash | |
| conda env create -f environment.nedm.yml | |
| conda activate nedm | |
| git lfs install && git lfs pull | |
| ``` | |
| `environment.nedm.yml` (env `nedm`, pychrono 10.0.0 from the `projectchrono` | |
| channel) is what everything runs in: data collection, training, RL, and | |
| Chrono-backed evaluation. `environment.yml` (env `tutorial`, pychrono 9.0.1) and | |
| `environment.lock.yml` are retained for the earliest datasets, which were | |
| collected under it. | |
| Project Chrono itself is a local dependency, not vendored — collection configs | |
| expect a checkout at `chrono/` and read `chrono/data` for vehicle assets. | |
| ## Layout | |
| Code, scripts and configs are grouped by study. `core` holds what both paper studies share. | |
| | Path | Contents | | |
| |---|---| | |
| | `src/nedm/core/` | Shared by both paper studies: preprocessing, the causal-transformer dynamics model and the trainer with rollout-based checkpoint selection (`training/`); the frozen NN-ROM loader and default paths (`rl/`); the scenario generator, the Hugging Face release helpers and the Blender export | | |
| | `src/nedm/hmmwv/` | Study Case I: HMMWV scene builders and data collectors (`hmmwv_data`, `hmmwv_crm`); the vectorized NN-ROM tracking environment, its Chrono-backed twins and the reference sets (`rl/`) | | |
| | `src/nedm/tracked_arm/` | Study Case II: M113 and arm data collectors (`tracked_vehicle_data`, `arm_data`); the 4-DOF gripper arm imported from SolidWorks (`arm_model/`); the goal and arm environments, arm forward kinematics and the clearance shield (`rl/`) | | |
| | `src/nedm/traversing/` | Traversing study code: model training (`training/`) and the Chrono evaluation class (`evaluation/`) | | |
| | `src/nedm/contact_nrd/` | Contact NRD: the three networks, training, test scores and the data download | | |
| | `src/nedm/so101_push_rl/` | SO101 push-T PPO inside the contact NRD: the NRD environment, action decoder, arm kinematics, reward and rules | | |
| | `src/nedm/g1_footstep_rl/` | G1 footstep PPO inside the contact NRD: courses and scorer, the NRD environment, the HOMIE copy, leg kinematics, the MuJoCo scene and runner, the hand-written footstep baseline (H-FS) | | |
| | `configs/hmmwv/`, `configs/tracked_arm/` | Collection and training configs | | |
| | `configs/contact_nrd/` | Training configs of the contact NRD (one for the first three cases, one for G1) and the G1 evaluation block | | |
| | `configs/so101_push_rl/` | Environment config, the two PPO curricula and the arm and T settings | | |
| | `configs/g1_footstep_rl/` | Environment config, PPO curriculum, MuJoCo scene and HOMIE sources of the G1 footstep study | | |
| | `traversing/` | Traversing study documents, results and release manifest | | |
| | `contact_nrd/` | Contact NRD design, results, the four study cases, the G1 data format and release manifest | | |
| | `so101_push_rl/` | SO101 push-T PPO study: results, the NRD it used and release manifest | | |
| | `g1_footstep_rl/` | G1 footstep PPO study: results, training, the NRD and HOMIE, release manifest | | |
| | `artifacts/` | Checkpoints, run metadata and Chrono evaluation output (datasets are on Hugging Face, see below) | | |
| `scripts/` is organised by study (`core/`, `hmmwv/`, `tracked_arm/`, `traversing/`, `so101_push_rl/`, | |
| `g1_footstep_rl/`), then by pipeline stage, in the order you would run them: | |
| | Path | Contents | | |
| |---|---| | |
| | `scripts/hmmwv/collection/` | Shard planners and Chrono collectors for the flat, bumpy and CRM datasets, plus their validators and small-scale smoke tests | | |
| | `scripts/tracked_arm/collection/` | The M113 drive collector (the arm collector is `python -m nedm.tracked_arm.arm_data`) | | |
| | `scripts/core/preprocess/` | Raw episodes → processed caches (all three dynamics models) | | |
| | `scripts/hmmwv/preprocess/`, `scripts/tracked_arm/preprocess/` | RL reference-set builders; arm FK geometry extraction | | |
| | `scripts/core/training/` | The dynamics trainer (all three dynamics models) | | |
| | `scripts/hmmwv/training/`, `scripts/tracked_arm/training/` | The three PPO trainers, and the launchers holding each run's exact hyperparameters | | |
| | `scripts/hmmwv/ablations/`, `scripts/tracked_arm/ablations/` | Config generation, sweep runners and ranking for Appendices C–E and the specialist comparison; the arm q-input probe | | |
| | `scripts/core/evaluation/` | Open-loop rollout eval of a dynamics checkpoint | | |
| | `scripts/hmmwv/evaluation/`, `scripts/tracked_arm/evaluation/` | Chrono closed-loop transfer, open-loop arm eval, and the seeded 100-goal benchmarks | | |
| | `scripts/hmmwv/figures/`, `scripts/tracked_arm/figures/` | The eleven generators behind the manuscript's plotted figures, plus the Blender renderers | | |
| | `scripts/core/throughput/`, `scripts/hmmwv/throughput/` | Chrono and NN-ROM throughput probes (Appendix A) and the context-truncation sweep | | |
| | `scripts/hmmwv/cluster/`, `scripts/tracked_arm/cluster/` | SLURM array jobs for the collections that only run at cluster scale | | |
| | `scripts/so101_push_rl/` | The SO101 push-T PPO trainer and `reproduce.sh` (download, training, NRD validation) | | |
| | `scripts/g1_footstep_rl/` | The G1 footstep PPO trainer, the MuJoCo evaluation, the H-FS parameter search, the bank builders, the HOMIE fetch and `reproduce.sh` | | |
| | `scripts/hmmwv/validation/` | Chrono validation harnesses for the tire-force channels (not a unit-test suite) | | |
| | `scripts/core/release/` | The Hugging Face dataset release: raw CSV → Parquet export, validation, upload, and the download/rehydrate helper | | |
| | `scripts/traversing/` | The traversing study's result recount (`analysis/`) and release download/verification (`release/`) | | |
| Every script under `scripts/core/`, `scripts/hmmwv/` and `scripts/tracked_arm/` reproduces something the paper | |
| reports; nothing else is kept. The ablation *artifacts* and *configs* keep their original `ablation_ofat` name | |
| because it is recorded inside the run metadata. | |
| The paper was produced with the earlier stage-first layout (`scripts/<stage>/`, `src/nedm/{training,rl}/`, | |
| `src/arm_model/`, `test/`, `blender-render/`). That layout is kept at the GitHub tag | |
| [`paper-v1`](https://github.com/uwsbel/NeDM/tree/paper-v1); the Hugging Face dataset card | |
| (`docs/hf_dataset_card.md`, mirrored on the Hub) still names its paths. | |
| ## Datasets | |
| All five datasets the paper's dynamics models train on are published at | |
| **<https://huggingface.co/datasets/harryzhang1018/NeDM>** (70 GB: every recorded channel as | |
| float32 Parquet plus the four processed training caches; the dataset card documents schemas, | |
| splits and provenance). Nothing needs to be re-collected: | |
| ```bash | |
| conda activate nedm | |
| # the exact .npy caches the deployed models trained on -> artifacts/training_datasets/ | |
| PYTHONPATH=src python scripts/core/release/download_nedm_datasets.py --dataset all --no-raw --processed | |
| # a raw dataset as the collectors' per-episode CSV tree -> artifacts/datasets/ (preprocess etc. run unchanged) | |
| PYTHONPATH=src python scripts/core/release/download_nedm_datasets.py --dataset tracked --rehydrate | |
| ``` | |
| `docs/hf_dataset_card.md` is the source of the Hub README; `scripts/core/release/export_hf_dataset.py` | |
| + `validate_hf_export.py` + `upload_hf_dataset.sh` regenerate and publish the release. | |
| ## Quick start | |
| Collect a small dataset, build its cache, and train: | |
| ```bash | |
| conda activate nedm | |
| python scripts/hmmwv/collection/collect_hmmwv_dataset.py --config configs/hmmwv/hmmwv_overfit_v1.json | |
| python scripts/core/preprocess/build_hmmwv_training_dataset.py --help | |
| PYTHONPATH=src python scripts/core/training/train_hmmwv_dynamics.py \ | |
| --config configs/hmmwv/hmmwv_transformer_v07_tire_normal_force_omega_300g_crm2000_mix25_rebal_rollout_onehot.json | |
| ``` | |
| The full flat collection is cluster-scale (~305 GB of CSV; download it from Hugging Face | |
| instead, see above); `scripts/hmmwv/cluster/collect_hmmwv_tire300g.sh` is the job that produced it and | |
| `scripts/hmmwv/collection/smoke_test_hmmwv_bumpy10g.sh` rehearses the same path at small scale. | |
| Evaluate a trained policy back in Chrono: | |
| ```bash | |
| PYTHONPATH=src python scripts/hmmwv/evaluation/eval_hmmwv_rl_chrono_tracking.py --help # Study Case I | |
| PYTHONPATH=src python scripts/tracked_arm/evaluation/benchmark_tracked_goal_chrono.py --help # Study Case II, base | |
| PYTHONPATH=src python scripts/tracked_arm/evaluation/benchmark_arm_reach_chrono.py --help # Study Case II, arm | |
| ``` | |
| ## Further reading | |
| - [docs/model_checkpoints.md](docs/model_checkpoints.md) — the deployed checkpoints and how to load them | |
| - [docs/data_collection_pipeline.md](docs/data_collection_pipeline.md), [docs/hmmwv_crm_data_collection_pipeline.md](docs/hmmwv_crm_data_collection_pipeline.md) — collection design | |
| - [docs/hmmwv_training_pipeline.md](docs/hmmwv_training_pipeline.md), [docs/rl_tracking.md](docs/rl_tracking.md) — Study Case I | |
| - [docs/arm-dyn-model.md](docs/arm-dyn-model.md), [docs/arm-reaching-rl-plan.md](docs/arm-reaching-rl-plan.md), [docs/tracked_vehicle_nn_rom_rl_plan.md](docs/tracked_vehicle_nn_rom_rl_plan.md) — Study Case II | |
| - [docs/ablation_ofat_plan.md](docs/ablation_ofat_plan.md) — the ablation protocol | |
| - [deep-research-report-vehicle.md](deep-research-report-vehicle.md) — background survey on learned vehicle dynamics | |