Readme
RoboPianist is a new benchmarking suite for high-dimensional control, targeted at testing high spatial and temporal precision, coordination, and planning, all with an underactuated system frequently making-and-breaking contacts. The proposed challenge is mastering the piano through bi-manual dexterity, using a pair of simulated anthropomorphic robot hands.
This codebase contains software and tasks for the benchmark, and is powered by MuJoCo.
bash scripts/install_deps.sh to update your installation.We've created an introductory Colab notebook that demonstrates how to use RoboPianist. It includes code for loading and customizing a piano playing task, and a demonstration of a pretrained policy playing a short snippet of Twinkle Twinkle Little Star. Click the button below to get started!
RoboPianist is supported on both Linux and macOS and can be installed with Python >= 3.8. We recommend using Miniconda to manage your Python environment.
The recommended way to install this package is from source. Start by cloning the repository:
git clone https://github.com/google-research/robopianist.git && cd robopianist
Next, install the prerequisite dependencies:
git submodule init && git submodule update
bash scripts/install_deps.sh
Finally, create a new conda environment and install RoboPianist in editable mode:
conda create -n pianist python=3.10
conda activate pianist
pip install -e ".[dev]"
To test your installation, run make test and verify that all tests pass.
First, install the prerequisite dependencies:
bash <(curl -s https://raw.githubusercontent.com/google-research/robopianist/main/scripts/install_deps.sh) --no-soundfonts
Next, create a new conda environment and install RoboPianist:
conda create -n pianist python=3.10
conda activate pianist
pip install --upgrade robopianist
We recommend installing additional soundfonts to improve the quality of the synthesized audio. You can easily do this using the RoboPianist CLI:
robopianist soundfont --download
For more soundfont-related commands, see docs/soundfonts.md.
The PIG dataset cannot be redistributed on GitHub due to licensing restrictions. See docs/dataset for instructions on where to download it and how to preprocess it.
RoboPianist comes with a command line interface (CLI) that can be used to download additional soundfonts, play MIDI files, preprocess the PIG dataset, and more. For more information, see docs/cli.md.
We welcome contributions to RoboPianist. Please see docs/contributing.md for more information.
See docs/faq.md for a list of frequently asked questions.
If you use RoboPianist in your work, please use the following citation:
@inproceedings{robopianist2023,
author = {Zakka, Kevin and Wu, Philipp and Smith, Laura and Gileadi, Nimrod and Howell, Taylor and Peng, Xue Bin and Singh, Sumeet and Tassa, Yuval and Florence, Pete and Zeng, Andy and Abbeel, Pieter},
title = {RoboPianist: Dexterous Piano Playing with Deep Reinforcement Learning},
booktitle = {Conference on Robot Learning (CoRL)},
year = {2023},
}
We would like to thank the following people for making this project possible:
MuJoco Menagerie's license can be found here. Soundfont licensing information can be found here. MIDI licensing information can be found here. All other code is licensed under an Apache-2.0 License.
This is not an officially supported Google product.
FAQs
A benchmark for high-dimensional robot control
We found that robopianist demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
CISA launched a new project called Vulnrichment to enrich CVEs with details that help prioritize patching and mitigation efforts, as the NVD backlog of unenriched CVEs awaiting analysis surpasses 10,000.
Security News
Socket is joining forces with CISA and other industry leaders at the RSA Conference to sign the Secure by Design pledge, committing to uphold the highest security standards in our products.
Research
The Socket research team breaks down a sampling of malicious packages that download and execute files, among other suspicious behaviors, targeting the popular Discord platform.