google-deepmind/mujoco google-deepmind/mujoco

  • Stars
    star
    7,069
  • Rank 5,257 (Top 0.2 %)
  • Language
    C++
  • License
    Apache License 2.0
  • Created over 2 years ago
  • Updated about 1 month ago
Twitter logo Share LinkedIn logo Share Facebook logo Share
google-deepmind/mujoco
github

google-deepmind

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

Multi-Joint dynamics with Contact. A general purpose physics simulator.

MuJoCo

MuJoCo stands for Multi-Joint dynamics with Contact. It is a general purpose physics engine that aims to facilitate research and development in robotics, biomechanics, graphics and animation, machine learning, and other areas which demand fast and accurate simulation of articulated structures interacting with their environment.

This repository is maintained by DeepMind.

MuJoCo has a C API and is intended for researchers and developers. The runtime simulation module is tuned to maximize performance and operates on low-level data structures that are preallocated by the built-in XML compiler. The library includes interactive visualization with a native GUI, rendered in OpenGL. MuJoCo further exposes a large number of utility functions for computing physics-related quantities.

We also provide Python bindings and a plug-in for the Unity game engine.

Documentation

MuJoCo's documentation is available at mujoco.readthedocs.io, which serves webpages derived from the documentation source files.

Getting Started

There are two easy ways to get started with MuJoCo:

  1. Run simulate on your machine. This video shows a screen capture of simulate, MuJoCo's native interactive viewer. Follow the steps described in the Getting Started section of the documentation to get simulate running on your machine.

  2. Explore our online IPython notebooks. If you are a Python user, you might want to start with our tutorial notebooks running on Google Colab:

  • The first tutorial focuses on the basics of MuJoCo: Open In Colab
  • For a more advanced example, see the LQR tutorial which creates an LQR controlled to balance a humanoid on one leg using MuJoCo's dynamics derivatives: Open In Colab

Installation

Prebuilt binaries

Versioned releases are available as precompiled binaries from the GitHub releases page, built for Linux (x86-64 and AArch64), Windows (x86-64 only), and macOS (universal). This is the recommended way to use the software.

Building from source

Users who wish to build MuJoCo from source should consult the build from source section of the documentation. However, please note that the commit at the tip of the main branch may be unstable.

Python (>= 3.7)

The native Python bindings, which come pre-packaged with a copy of MuJoCo, can be installed from PyPI via:

pip install mujoco

Note that Pre-built Linux wheels target manylinux2014, see here for compatible distributions. For more information such as building the bindings from source, see the Python Bindings section of the documentation.

Asking Questions

We welcome community engagement: questions, requests for help, bug reports and feature requests. To read more about bug reports, feature requests and more ambitious contributions, please see our contributors guide.

Questions and requests for help are welcome on the GitHub issues and discussions pages. Issues should be focused on a specific problem or question, while discussions should address wider concerns that might require input from multiple participants.

Here are some guidelines for asking good questions:

  1. Search for existing questions or issues that touch on the same subject.

    You can add comments to existing threads or start new ones. If you start a new thread and there are existing relevant threads, please link to them.

  2. Use a clear and specific title. Try to include keywords that will make your question easy for other to find in the future.

  3. Introduce yourself and your project more generally.

    If your level of expertise is exceptional (either high or low), and it might be relevant to what we can assume you know, please state that as well.

  4. Take a step back and tell us what you're trying to accomplish, if we understand you goal we might suggest a different type of solution than the one you are having problems with

  5. Make it easy for others to reproduce the problem or understand your question.

    If this requires a model, please include it. Try to make the model minimal: remove elements that are unrelated to your question. Pure XML models should be inlined. Models requiring binary assets (meshes, textures), should be attached as a .zip file. Please make sure the included model is loadable before you attach it.

  6. Include an illustrative screenshot or video, if relevant.

  7. Tell us how you are accessing MuJoCo (C API, Python bindings, etc.) and which MuJoCo version and operating system you are using.

Related software

MuJoCo forms the backbone of many environment packages, but these are too many to list here individually. Below we focus on bindings and converters.

Bindings

These packages give users of various languages access to MuJoCo functionality:

First-party bindings:

Third-party bindings:

Converters

  • OpenSim: O2MConverter converts openSIM models to MJCF.
  • SDFormat: gz-mujoco is a two-way SDFormat <-> MJCF conversion tool.
  • OBJ: obj2mjcf a script for converting composite OBJ files into a loadable MJCF model.

Citation

If you use MuJoCo for published research, please cite:

@inproceedings{todorov2012mujoco,
  title={MuJoCo: A physics engine for model-based control},
  author={Todorov, Emanuel and Erez, Tom and Tassa, Yuval},
  booktitle={2012 IEEE/RSJ International Conference on Intelligent Robots and Systems},
  pages={5026--5033},
  year={2012},
  organization={IEEE},
  doi={10.1109/IROS.2012.6386109}
}

License and Disclaimer

Copyright 2021 DeepMind Technologies Limited.

Box collision code (engine_collision_box.c) is Copyright 2016 Svetoslav Kolev.

ReStructuredText documents, images, and videos in the doc directory are made available under the terms of the Creative Commons Attribution 4.0 (CC BY 4.0) license. You may obtain a copy of the License at https://creativecommons.org/licenses/by/4.0/legalcode.

Source code is licensed under the Apache License, Version 2.0. You may obtain a copy of the License at https://www.apache.org/licenses/LICENSE-2.0.

This is not an officially supported Google product.

More Repositories

1

deepmind-research

This repository contains implementations and illustrative code to accompany DeepMind publications
Jupyter Notebook
12,791
star
2

alphafold

Open source code for AlphaFold.
Python
11,697
star
3

sonnet

TensorFlow-based neural network library
Python
9,682
star
4

pysc2

StarCraft II Learning Environment
Python
7,904
star
5

lab

A customisable 3D platform for agent-based AI research
C
7,012
star
6

graph_nets

Build Graph Nets in Tensorflow
Python
5,325
star
7

graphcast

Python
4,201
star
8

learning-to-learn

Learning to Learn in TensorFlow
Python
4,063
star
9

open_spiel

OpenSpiel is a collection of environments and algorithms for research in general reinforcement learning and search/planning in games.
C++
4,003
star
10

alphageometry

Python
3,580
star
11

dm_control

Google DeepMind's software stack for physics-based simulation and Reinforcement Learning environments, using MuJoCo.
Python
3,473
star
12

acme

A library of reinforcement learning components and agents
Python
3,372
star
13

trfl

TensorFlow Reinforcement Learning
Python
3,139
star
14

dm-haiku

JAX-based neural network library
Python
2,697
star
15

alphatensor

Python
2,616
star
16

dnc

A TensorFlow implementation of the Differentiable Neural Computer.
Python
2,478
star
17

mctx

Monte Carlo tree search in JAX
Python
2,179
star
18

gemma

Open weights LLM from Google DeepMind.
Jupyter Notebook
2,023
star
19

code_contests

C++
2,010
star
20

kinetics-i3d

Convolutional neural network model for video classification trained on the Kinetics dataset.
Python
1,639
star
21

mathematics_dataset

This dataset code generates mathematical question and answer pairs, from a range of question types at roughly school-level difficulty.
Python
1,621
star
22

optax

Optax is a gradient processing and optimization library for JAX.
Python
1,476
star
23

bsuite

bsuite is a collection of carefully-designed experiments that investigate core capabilities of a reinforcement learning (RL) agent
Python
1,457
star
24

educational

Jupyter Notebook
1,382
star
25

jraph

A Graph Neural Network Library in Jax
Python
1,306
star
26

rc-data

Question answering dataset featured in "Teaching Machines to Read and Comprehend
Python
1,285
star
27

rlax

Python
1,155
star
28

tapnet

Tracking Any Point (TAP)
Python
1,033
star
29

scalable_agent

A TensorFlow implementation of Scalable Distributed Deep-RL with Importance Weighted Actor-Learner Architectures.
Python
972
star
30

neural-processes

This repository contains notebook implementations of the following Neural Process variants: Conditional Neural Processes (CNPs), Neural Processes (NPs), Attentive Neural Processes (ANPs).
Jupyter Notebook
966
star
31

android_env

RL research on Android devices.
Python
946
star
32

mujoco_menagerie

A collection of high-quality models for the MuJoCo physics engine, curated by Google DeepMind.
Jupyter Notebook
926
star
33

dramatron

Dramatron uses large language models to generate coherent scripts and screenplays.
Jupyter Notebook
904
star
34

tree

tree is a library for working with nested data structures
Python
891
star
35

xmanager

A platform for managing machine learning experiments
Python
794
star
36

mujoco_mpc

Real-time behaviour synthesis with MuJoCo, using Predictive Control
C++
771
star
37

materials_discovery

Python
770
star
38

reverb

Reverb is an efficient and easy-to-use data storage and transport system designed for machine learning research
C++
692
star
39

chex

Python
686
star
40

alphadev

Python
662
star
41

pycolab

A highly-customisable gridworld game engine with some batteries included. Make your own gridworld games to test reinforcement learning agents!
Python
654
star
42

ferminet

An implementation of the Fermionic Neural Network for ab-initio electronic structure calculations
Python
643
star
43

hanabi-learning-environment

hanabi_learning_environment is a research platform for Hanabi experiments.
Python
614
star
44

funsearch

Jupyter Notebook
611
star
45

ai-safety-gridworlds

This is a suite of reinforcement learning environments illustrating various safety properties of intelligent agents.
Python
577
star
46

dqn

Lua/Torch implementation of DQN (Nature, 2015)
Lua
546
star
47

ithaca

Restoring and attributing ancient texts using deep neural networks
Jupyter Notebook
535
star
48

meltingpot

A suite of test scenarios for multi-agent reinforcement learning.
Python
516
star
49

recurrentgemma

Open weights language model from Google DeepMind, based on Griffin.
Python
505
star
50

distrax

Python
504
star
51

surface-distance

Library to compute surface distance based performance metrics for segmentation tasks.
Python
493
star
52

dsprites-dataset

Dataset to assess the disentanglement properties of unsupervised learning methods
Jupyter Notebook
463
star
53

tracr

Python
460
star
54

alphamissense

Python
450
star
55

narrativeqa

This repository contains the NarrativeQA dataset. It includes the list of documents with Wikipedia summaries, links to full stories, and questions and answers.
Shell
432
star
56

lab2d

A customisable 2D platform for agent-based AI research
C++
415
star
57

open_x_embodiment

Jupyter Notebook
409
star
58

dqn_zoo

DQN Zoo is a collection of reference implementations of reinforcement learning agents developed at DeepMind based on the Deep Q-Network (DQN) agent.
Python
406
star
59

clrs

Python
376
star
60

spriteworld

Spriteworld: a flexible, configurable python-based reinforcement learning environment
Python
366
star
61

dm_pix

PIX is an image processing library in JAX, for JAX.
Python
363
star
62

concordia

A library for generative social simulation
Python
351
star
63

mathematics_conjectures

Jupyter Notebook
348
star
64

alphastar

Python
335
star
65

spiral

We provide a pre-trained model for unconditional 19-step generation of CelebA-HQ images
C++
327
star
66

dm_env

A Python interface for reinforcement learning environments
Python
326
star
67

uncertain_ground_truth

Dermatology ddx dataset, Jax implementations of Monte Carlo conformal prediction, plausibility regions and statistical annotation aggregation from our recent work on uncertain ground truth (TMLR'23 and ArXiv pre-print).
Python
315
star
68

dm_robotics

Libraries, tools and tasks created and used at DeepMind Robotics.
Python
314
star
69

long-form-factuality

Benchmarking long-form factuality in large language models. Original code for our paper "Long-form factuality in large language models".
Python
314
star
70

launchpad

Python
305
star
71

leo

Implementation of Meta-Learning with Latent Embedding Optimization
Python
299
star
72

streetlearn

A C++/Python implementation of the StreetLearn environment based on images from Street View, as well as a TensorFlow implementation of goal-driven navigation agents solving the task published in “Learning to Navigate in Cities Without a Map”, NeurIPS 2018
C++
279
star
73

gqn-datasets

Datasets used to train Generative Query Networks (GQNs) in the ‘Neural Scene Representation and Rendering’ paper.
Python
269
star
74

enn

Python
265
star
75

multi_object_datasets

Multi-object image datasets with ground-truth segmentation masks and generative factors.
Python
247
star
76

AQuA

A algebraic word problem dataset, with multiple choice questions annotated with rationales.
238
star
77

card2code

A code generation dataset for generating the code that implements Hearthstone and Magic The Gathering card effects.
236
star
78

grid-cells

Implementation of the supervised learning experiments in Vector-based navigation using grid-like representations in artificial agents, as published at https://www.nature.com/articles/s41586-018-0102-6
Python
236
star
79

arnheim

Jupyter Notebook
235
star
80

synjax

Python
231
star
81

torch-hdf5

Torch interface to HDF5 library
Lua
231
star
82

dm_memorytasks

A set of 13 diverse machine-learning tasks that require memory to solve.
Python
220
star
83

Temporal-3D-Pose-Kinetics

Exploiting temporal context for 3D human pose estimation in the wild: 3D poses for the Kinetics dataset
Python
214
star
84

opro

official code for "Large Language Models as Optimizers"
Python
199
star
85

dm_alchemy

DeepMind Alchemy task environment: a meta-reinforcement learning benchmark
Python
197
star
86

neural_testbed

Jupyter Notebook
187
star
87

kfac-jax

Second Order Optimization and Curvature Estimation with K-FAC in JAX.
Python
187
star
88

pg19

179
star
89

jmp

JMP is a Mixed Precision library for JAX.
Python
171
star
90

xquad

171
star
91

spectral_inference_networks

Implementation of Spectral Inference Networks, ICLR 2019
Python
165
star
92

abstract-reasoning-matrices

Progressive matrices dataset, as described in: Measuring abstract reasoning in neural networks (Barrett*, Hill*, Santoro*, Morcos, Lillicrap), ICML2018
162
star
93

xitari

This is the 0.4 release of the Arcade Learning Environment (ALE), a platform designed for AI research. ALE is based on Stella, an Atari 2600 VCS emulator.
C++
159
star
94

tensor_annotations

Annotating tensor shapes using Python types
Python
159
star
95

neural_networks_chomsky_hierarchy

Neural Networks and the Chomsky Hierarchy
Python
155
star
96

symplectic-gradient-adjustment

A colab that implements the Symplectic Gradient Adjustment optimizer from "The mechanics of n-player differentiable games"
Jupyter Notebook
150
star
97

mc_gradients

Jupyter Notebook
149
star
98

interval-bound-propagation

This repository contains a simple implementation of Interval Bound Propagation (IBP) using TensorFlow: https://arxiv.org/abs/1810.12715
Python
148
star
99

s6

C++
146
star
100

perception_test

Jupyter Notebook
146
star