Skip to content

Commit

Permalink
fix readme and installation (#75)
Browse files Browse the repository at this point in the history
* add  dependency and move  to optional

* remove comments

* add all suites

* Adding links to the various env suites

* update instructino for pip install & cloning

* Moving the FAW link to wiki

Removed the dangling set/faq.md 
Pointing the link to the wiki now

* update command for direct python module invocation

---------

Co-authored-by: Vittorio Caggiano <caggiano@fb.com>
Co-authored-by: Vikash Kumar <vikash@cs.washington.edu>
  • Loading branch information
3 people committed Apr 10, 2023
1 parent 73c22ad commit 7eda971
Show file tree
Hide file tree
Showing 2 changed files with 33 additions and 11 deletions.
37 changes: 29 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,18 +19,39 @@ License :: Under Apache License, Version 2.0 (the "License"); you may not use th
``` bash
# Install RoboHive and demo an environemnt
pip install robohive
cd robohive
python robohive/utils/examine_env.py -e FrankaReachRandom-v0
python -m robohive.utils.examine_env -e FrankaReachRandom-v0
```
See here for [detailed installation instructions](./setup/README.md) and [frequently asked questions](./setup/FAQ.md).

or, alternatively,

``` bash
git clone --recursive https://github.com/vikashplus/robohive.git; cd robohive
pip install -e .
python -m robohive.utils.examine_env -e FrankaReachRandom-v0
```


See here for [detailed installation instructions](./setup/README.md) and [frequently asked questions](https://github.com/vikashplus/robohive/wiki/6.-Tutorials-&-FAQs#installation).

# Suites
*RoboHive* contains a variety of environement, which are organized as suites. Each suites is a collection of loosely related environements. Following suites are provided at the moment with plans to improve the diversity of the collection.

## 1. Hand Manipulation Suite
HMS contains a collection of environement centered around dexterous manipulation with anthroporphic 24 degrees of freedom [Adroit Hand](https://vikashplus.github.io/P_Hand.html). These environments were designed for the publication: [Learning Complex Dexterous Manipulation with Deep Reinforcement Learning and Demonstrations, RSS2018](https://sites.google.com/corp/view/deeprl-dexterous-manipulation).
## - Hand Manipulation Suite

This suite contains a collection of environement centered around dexterous manipulation. Standard ADROIT benchmarks introduced in [Learning Complex Dexterous Manipulation with Deep Reinforcement Learning and Demonstrations, RSS2018](https://sites.google.com/corp/view/deeprl-dexterous-manipulation).) are a part of this suite
## - Arm Manipulation Suite

This suite contains a collection of environement centered around Arm+Gripper manipulation.

## - Myo Suite

This suite contains a collection of environements related to biomechanics. Standard [MyoSuite benchmarks](https://sites.google.com/view/myosuite) are a part of this suite

## - MultiTask Suite

Hand-Manipulation-Suite Tasks [(video)](https://youtu.be/jJtBll8l_OM)
![Alt text](robohive/envs/hands/assets/tasks.jpg?raw=false "Adroit Tasks")
This suite contains a collection of environement centered around multi-tassk. Standard [RelayKitchen benchmarks](https://relay-policy-learning.github.io/) are a part of this suite
## - TCDM Suite (WIP)
This suite contains a collection of environement centered around dexterous manipulation. Standard [TCDM benchmarks](https://pregrasps.github.io/) are a part of this suite

## 2. More coming soon
## - ROBEL Suite (Coming soon)
This suite contains a collection of environement centered around real world locomotion and manipulation. Standard [ROBEL benchmarks](http://roboticsbenchmarks.org/) are a part of this suite
7 changes: 4 additions & 3 deletions setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -39,19 +39,20 @@ def package_files(directory):
install_requires=[
'click',
'gym==0.13',
'mujoco==2.3.3',
# 'mujoco-py<2.2,>=2.1',
'free-mujoco-py',
'termcolor',
'sk-video',
'flatten_dict',
'matplotlib',
'ffmpeg',
'absl-py',
'r3m @ git+https://github.com/facebookresearch/r3m.git',
# 'data_tools @ git+https://github.com/fairinternal/data_tools.git',
'h5py==3.7.0',
],
extras_require={
'mujoco':[
'mujoco==2.3.3'
],
'a0': [
'pycapnp==1.1.0',
'alephzero', # real_sense subscribers dependency
Expand Down

0 comments on commit 7eda971

Please sign in to comment.