MimicKit
SoftwareMotion-imitation reinforcement-learning framework with DeepMimic, AMP, ASE and ADD implementations; simulator setup and external motion assets are separate requirements. [1]
Installation & first result →Official websiteGetting started
- For
- Researchers comparing motion-imitation algorithms and custom controller objectives [1]
- Source rights
- Named licenses are documented by part. Review licenses
- Unknowns
- operating system, compute requirements not fully established. Review gaps
Source researched · Not tested by us
Sources checked · Research details
Licenses & related hardware
- License
- Apache-2.0 · Details by part
Overview
MimicKit trains simulated motion controllers from reference movements. It includes DeepMimic, AMP, ASE and ADD, plus PPO and AWR learning algorithms. Its compact framework is useful for studying or changing motion-imitation methods; the README points readers wanting a more modular framework to ProtoMotions. [1]
Is this for you?
- Known limitations
- Motion joint order and character model must agree.
- Simulator-specific versions and complete compute requirements are not pinned by the reviewed guide.
- External motion/assets/checkpoint rights were not established by this source review.
- Simulation controller results do not establish physical robot deployment.
Editorial assessment from cited documentation; no runtime testing.
What you need
Installation & first result
Open the upstream getting-started guide [1] · Project documentation [1]
- Create an isolated environment matching the selected simulator and install it first.
- Install requirements.txt and obtain the linked assets and motion data under data/.
- Check engine_name, character file and motion_file in the chosen environment configuration.
- Use the documented four-environment model test before attempting the 4096-environment training example.
- Installation
Install a supported simulator in its own environment, then requirements and separately linked data assets.
Hardware, models & data
Project notes
Choose a simulator before installing the Python packages
This profile covers release v0 at commit 50b7b3d60c1ffe7f7b7159aebc273a926ce81fab, not newer unreviewed development changes. That release documents Isaac Gym and Isaac Lab backends and recommends separate Python environments for each. Install the simulator first, then requirements.txt, and set the configuration's engine_name to the matching backend. The example humanoid configuration selects Isaac Gym. [1] [2] [3] [6]
The runner defaults to cuda:0. Although its training interface accepts CPU and CUDA device names, that is not evidence that either simulator will run every workflow on a CPU. Exact simulator versions, Python versions, GPU memory and training costs need a configuration-specific check; the reviewed guide does not pin a complete working environment. [1] [4]
Try a saved controller before a large training job
The repository directs readers to a separate download for assets and motion data. The documented test uses four environments and data/models/deepmimic_humanoid_spinkick_model.pt, selected with the DeepMimic humanoid argument file. Confirm that the corresponding character, motion and model files are present before using that command. The full training example starts 4,096 environments, so it should not be treated as a minimal installation check. [1] [3]
For new motion data, inspect the clip with the view_motion environment first. Motion files store root position, root rotation and joint rotations; joint order follows the character XML's depth-first kinematic order, and three-dimensional rotations use exponential maps. A file loading successfully does not show that its joint ordering matches a different character. [1]
The example humanoid configuration uses position control at 30 Hz with simulation at 120 Hz. Those are settings for that simulated configuration, not a real-robot control contract. Training produces model parameters and logs; playback and training statistics need to be checked separately from any later hardware transfer. [1] [3]
Source and external assets have different review coverage
The repository code is Apache-2.0. We reviewed the repository source and license, but did not retrieve the separately hosted motion/asset package or pretrained model payloads. Our unauthenticated access check returned an access-denied response, which leaves a retrieval gap rather than proving general unavailability. [8] Their specific licensing and availability remain unverified; the code license is not a blanket grant for those external materials. No simulator installation, training run, model playback or robot deployment was performed. [1] [7]
What we checked
Source researched only; no installation, training, benchmark or physical hardware test performed. No affiliate links or reused media.
Not yet established
- Requirements: operating system
- Version-specific hardware compatibility (ecosystem tags alone do not establish it)
Updates
Source files and licenses
Apache-2.0 motion-imitation framework; externally hosted motion data, robot assets and pretrained models need separate rights and availability review.
| Layer | Availability / license |
|---|---|
| software | available · Apache-2.0 Repository materials only; external components retain their own terms. [7] |
| model weights | unavailable · License not fully assessed Upstream describes external data/model artifacts, but our unauthenticated retrieval returned access denied. This is a retrieval gap, not proof the artifacts are generally unavailable; payloads and terms were not inspected. [1] [8] |
| datasets | unavailable · License not fully assessed Upstream describes external data/model artifacts, but our unauthenticated retrieval returned access denied. This is a retrieval gap, not proof the artifacts are generally unavailable; payloads and terms were not inspected. [1] [8] |
| documentation | available · Apache-2.0 Repository materials only; external components retain their own terms. [7] |
References
Each source links to the exact revision we read. “Used for” shows where this page relies on it.
- S001 Framework and training guide
Revision, date & where cited
xbpeng/MimicKit contributors · github.com · revision
50b7b3d· Accessed Oct 17, 2026
Used for: Overview, Is this for you?, What you need, Installation & first result and 5 more - S002 Python dependencies
Revision, date & where cited
xbpeng/MimicKit contributors · github.com · revision
50b7b3d· Accessed Oct 17, 2026
Used for: What you need, Choose a simulator before installing the Python packages - S003 Humanoid environment and control settings
Revision, date & where cited
xbpeng/MimicKit contributors · github.com · revision
50b7b3d· Accessed Oct 17, 2026
Used for: Is this for you?, What you need, Installation & first result, Hardware, models & data and 2 more - S004 Training and evaluation entry point
Revision, date & where cited
xbpeng/MimicKit contributors · github.com · revision
50b7b3d· Accessed Oct 17, 2026
Used for: What you need, Choose a simulator before installing the Python packages - S007 Source license
Revision, date & where cited
xbpeng/MimicKit contributors · github.com · revision
50b7b3d· Accessed Oct 17, 2026
Used for: Source and external assets have different review coverage, Source files and licenses - S006 Reviewed release and revision
Revision, date & where cited
xbpeng/MimicKit / GitHub · github.com · revision
50b7b3d· v0 / · Accessed Oct 17, 2026
Used for: Choose a simulator before installing the Python packages, What we checked - S008 Linked external asset access check
Unauthenticated retrieval denied; artifact contents not inspected.Revision, date & where cited
MimicKit / Simon Fraser University SharePoint · 1sfu-my.sharepoint.com · HTTP headers, 2026-10-17 · Accessed Oct 17, 2026
Used for: Source and external assets have different review coverage, Source files and licenses
Correction guidance · Discussion is not enabled · Profile format 0.7.0-draft.5