Skip to main content

A pytorch library that implements differentiable and learnable robot models, which allows users to learn parameters of analytical robot models, and/or propagate gradients through analytical robot computations such as forward kinematics.

Project description

differentiable robot model

CircleCI Code style: black

Differentiable and learnable robot model. Our differentiable robot model implements computations such as forward kinematics and inverse dynamics, in a fully differentiable way. We also allow to specify
parameters (kinematics or dynamics parameters), which can then be identified from data (see examples folder).

Currently, our code should work with any kinematic trees. This package comes with wrappers specifically for:

  • TriFinger Edu
  • Kuka iiwa
  • Franka Panda
  • Allegro Hand
  • Fetch Arm
  • a 2-link toy robot

You can find the documentation here: Differentiable-Robot-Model Documentation

Installation

Requirements: python>= 3.7

clone this repo and install from source:

git clone git@github.com:facebookresearch/differentiable-robot-model.git
cd differentiable-robot-model
python setup.py develop

Examples

2 examples scripts show the learning of kinematics parameters

python examples/learn_kinematics_of_iiwa.py

and the learning of dynamics parameters

python examples/learn_dynamics_of_iiwa.py

L4DC paper and experiments

the notebook experiments/l4dc-sim-experiments shows a set of experiments that are similar to what we presented in our L4DC paper

@InProceedings{pmlr-v120-sutanto20a, 
    title = {Encoding Physical Constraints in Differentiable Newton-Euler Algorithm}, 
    author = {Sutanto, Giovanni and Wang, Austin and Lin, Yixin and Mukadam, Mustafa and Sukhatme, Gaurav and Rai, Akshara and Meier, Franziska}, 
    pages = {804--813}, 
    year = {2020},
    editor = {Alexandre M. Bayen and Ali Jadbabaie and George Pappas and Pablo A. Parrilo and Benjamin Recht and Claire Tomlin and Melanie Zeilinger}, 
    volume = {120}, 
    series = {Proceedings of Machine Learning Research}, 
    address = {The Cloud}, month = {10--11 Jun}, 
    publisher = {PMLR}, pdf = {http://proceedings.mlr.press/v120/sutanto20a/sutanto20a.pdf},
    url = {http://proceedings.mlr.press/v120/sutanto20a.html}, 
}

Testing

running pytest in the top-level folder will run our differentiable robot model tests, which compare computations against pybullet.

Code Contribution

We enforce linters for our code. The formatting test will not pass if your code does not conform.

To make this easy for yourself, you can either

  • Add the formattings to your IDE
  • Install the git pre-commit hooks by running
    pip install pre-commit
    pre-commit install
    

For Python code, use black.

To enforce this in VSCode, install black, set your Python formatter to black and set Format On Save to true.

To format manually, run: black .

License

differentiable-robot-model is released under the MIT license. See LICENSE for additional details about it. See also our Terms of Use and Privacy Policy.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

differentiable-robot-model-0.2.3.tar.gz (24.3 MB view details)

Uploaded Source

Built Distribution

differentiable_robot_model-0.2.3-py3-none-any.whl (24.4 MB view details)

Uploaded Python 3

File details

Details for the file differentiable-robot-model-0.2.3.tar.gz.

File metadata

File hashes

Hashes for differentiable-robot-model-0.2.3.tar.gz
Algorithm Hash digest
SHA256 3257568352f5a9c7acfa2bb8c0edf6a3fa49d21441ab46ee217c4e3beddcba0a
MD5 f9b64155e2e79f4b3846c0e6b4dd1c44
BLAKE2b-256 0db06e8e3a27625a86814723d8be35a829174629467d3eba3a61d5218f13a761

See more details on using hashes here.

File details

Details for the file differentiable_robot_model-0.2.3-py3-none-any.whl.

File metadata

File hashes

Hashes for differentiable_robot_model-0.2.3-py3-none-any.whl
Algorithm Hash digest
SHA256 547f0c74da6133be79b951d86cad5f44c2b43d0d221959d7a367692f48e39e5d
MD5 6474cddd5c2445fd7ac92839d5b612f6
BLAKE2b-256 2c9be325b0a519920f8967572a9fa8cf1c3eb3f512e7aa900b97af235eed58ad

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page