docs: expand model interface, safety, and attribution
Browse files
NOTICE
ADDED
|
@@ -0,0 +1,11 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
MimicIK / NatureIK model checkpoint collection
|
| 2 |
+
|
| 3 |
+
NatureIK software and release materials:
|
| 4 |
+
Copyright (c) 2026 FNii Lab, The Chinese University of Hong Kong, Shenzhen.
|
| 5 |
+
Jiahao (Geo) Yang.
|
| 6 |
+
|
| 7 |
+
This project incorporates and adapts MIP software:
|
| 8 |
+
Copyright (c) 2025 Chaoyi Pan.
|
| 9 |
+
|
| 10 |
+
Both source components are distributed under the MIT License. See LICENSE and
|
| 11 |
+
the source repository for the applicable notices and permission terms.
|
README.md
CHANGED
|
@@ -31,6 +31,20 @@ Release code revision: `fd6f8d026475b1cd0da01a1ea1aa41b015faa348`
|
|
| 31 |
|
| 32 |
The release contains 185 weight files plus 67 YAML configuration/provenance files. Datasets, W&B run data, raw training logs, cached outputs, and local environments are intentionally excluded.
|
| 33 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 34 |
## Important experiment semantics
|
| 35 |
|
| 36 |
- `models/comparison_imports/joint_loss_nostatic_20260807/` is the Aug-2026 NoStatic model trained with a single joint update: `MIP loss + 0.1 * FK loss`, followed by one backward pass and one optimizer step.
|
|
@@ -44,6 +58,8 @@ The release contains 185 weight files plus 67 YAML configuration/provenance file
|
|
| 44 |
- The 224-episode tok2 evaluation set used in recent comparisons is a held-out validation subset (61,317 frames), not an independent test set.
|
| 45 |
- Datasets are not included in this model repository. YAML files preserve the original local paths for provenance; replace those paths for your machine.
|
| 46 |
|
|
|
|
|
|
|
| 47 |
## Loading a checkpoint
|
| 48 |
|
| 49 |
Download the desired file and load it with the matching NatureIK code and YAML configuration:
|
|
@@ -67,6 +83,12 @@ print(bundle.keys())
|
|
| 67 |
|
| 68 |
Checkpoint formats differ by model family. MIP bundles include model/EMA state and normalization data; diffusion UNet files use their corresponding Lightning-style checkpoint format. Use each checkpoint with its adjacent YAML configuration.
|
| 69 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 70 |
## License
|
| 71 |
|
| 72 |
-
MIT. See
|
|
|
|
| 31 |
|
| 32 |
The release contains 185 weight files plus 67 YAML configuration/provenance files. Datasets, W&B run data, raw training logs, cached outputs, and local environments are intentionally excluded.
|
| 33 |
|
| 34 |
+
## Model interface
|
| 35 |
+
|
| 36 |
+
The AIRBOT IK checkpoints are single-arm policies:
|
| 37 |
+
|
| 38 |
+
- observation: 20D = current joints (6) + current end-effector pose (XYZ + quaternion, 7) + target end-effector pose (XYZ + quaternion, 7)
|
| 39 |
+
- action: 6D delta-joint command
|
| 40 |
+
- quaternion convention: XYZW
|
| 41 |
+
- position/joint units: metres/radians
|
| 42 |
+
- kinematic asset: `play_g2_usb_cam`, end-effector link `end_link`
|
| 43 |
+
|
| 44 |
+
The dual-arm service evaluates two single-arm observations with `batch=2`, then combines the two 6D joint outputs with two external gripper values to form a 14D robot command. The gripper dimensions are not predicted by these IK checkpoints.
|
| 45 |
+
|
| 46 |
+
SudeepDiT depth (for example, 8 transformer layers) describes network architecture. MIP sampling steps describe iterative inference. These are independent settings.
|
| 47 |
+
|
| 48 |
## Important experiment semantics
|
| 49 |
|
| 50 |
- `models/comparison_imports/joint_loss_nostatic_20260807/` is the Aug-2026 NoStatic model trained with a single joint update: `MIP loss + 0.1 * FK loss`, followed by one backward pass and one optimizer step.
|
|
|
|
| 58 |
- The 224-episode tok2 evaluation set used in recent comparisons is a held-out validation subset (61,317 frames), not an independent test set.
|
| 59 |
- Datasets are not included in this model repository. YAML files preserve the original local paths for provenance; replace those paths for your machine.
|
| 60 |
|
| 61 |
+
Representative training environments were Python 3.12/3.13 with PyTorch 2.11–2.13 and CUDA 13 builds. Use the adjacent YAML and the matching NatureIK code for exact architecture and preprocessing details; do not mix normalizers between checkpoints.
|
| 62 |
+
|
| 63 |
## Loading a checkpoint
|
| 64 |
|
| 65 |
Download the desired file and load it with the matching NatureIK code and YAML configuration:
|
|
|
|
| 83 |
|
| 84 |
Checkpoint formats differ by model family. MIP bundles include model/EMA state and normalization data; diffusion UNet files use their corresponding Lightning-style checkpoint format. Use each checkpoint with its adjacent YAML configuration.
|
| 85 |
|
| 86 |
+
## Safety and limitations
|
| 87 |
+
|
| 88 |
+
These checkpoints are research artifacts. They do not guarantee collision or self-collision avoidance, joint-limit compliance, singularity handling, calibration robustness, workspace validity, or safe behavior on physical hardware. Offline teacher-forced validation does not establish closed-loop robot safety. Apply velocity/acceleration/position limits, workspace clamps, collision checking, an emergency stop, and human supervision before hardware use.
|
| 89 |
+
|
| 90 |
+
Performance outside the training robots, URDF, calibration, payload, cameras, and workspace is not established. PyTorch `.pt`/`.ckpt` files can execute code during deserialization; verify file origin and hashes and only load artifacts you trust.
|
| 91 |
+
|
| 92 |
## License
|
| 93 |
|
| 94 |
+
MIT. See `LICENSE` and `NOTICE` for attribution and the NatureIK source repository for source licensing.
|