|
a |
|
b/docs/source/tutorials/ReadMe.md |
|
|
1 |
# Here a list of tutorials on how to use MyoSuite |
|
|
2 |
|
|
|
3 |
## Requirements |
|
|
4 |
You need to install Jupyter Notebooks with: |
|
|
5 |
|
|
|
6 |
``` bash |
|
|
7 |
pip install jupyter |
|
|
8 |
``` |
|
|
9 |
or you can jumpstart with **ICRA2023 Colab Tutorial** [](https://colab.research.google.com/drive/1KGqZgSYgKXF-vaYC33GR9llDsIW9Rp-q) |
|
|
10 |
|
|
|
11 |
Note: in case the kernel for the environent is not recognized, you can install it with the following commands: |
|
|
12 |
|
|
|
13 |
``` bash |
|
|
14 |
pip install jupyter ipykernel |
|
|
15 |
python -m ipykernel install --user --name= < name of the environment > |
|
|
16 |
``` |
|
|
17 |
You can then remove it with: |
|
|
18 |
``` bash |
|
|
19 |
jupyter kernelspec uninstall myosuite |
|
|
20 |
``` |
|
|
21 |
|
|
|
22 |
You might need also to install ffmpeg to write videos to play them back in the notebooks. You can do it with |
|
|
23 |
``` bash |
|
|
24 |
conda install conda-forge::ffmpeg |
|
|
25 |
``` |
|
|
26 |
|
|
|
27 |
## Tutorials |
|
|
28 |
|
|
|
29 |
- [Get Started](./1_Get_Started.ipynb) |
|
|
30 |
- [Load a trained policy and play it](./2_Load_policy.ipynb) * |
|
|
31 |
- [Analyse movements from a trained policy](./3_Analyse_movements.ipynb) * |
|
|
32 |
- [Use the DEPRL baseline](./4a_deprl.ipynb). For this tutorial, `deprl` is needed. You can install it with `pip install deprl` |
|
|
33 |
- [Use the MyoReflex baseline](./4b_reflex/MyoSuite_MyoReflex_Walk.ipynb). For this tutorial, we provided a wrapper to use MyoReflex together with the tutorial file |
|
|
34 |
- [Train a new policy with stable baselines (SB)](./4c_Train_SB_policy.ipynb). For this tutorial, `stable-baselines3` is needed. You can install it with `pip install stable-baselines` |
|
|
35 |
- [Move single finger of the Hand](./5_Move_Hand_Fingers.ipynb) |
|
|
36 |
- [Train policies with SAR](./SAR/SAR%20tutorial.ipynb). All required installations are included within the SAR tutorial notebook. |
|
|
37 |
- [Replicate hand movements with inverse dynamics](./6_Inverse_Dynamics.ipynb). For this tutorial, `osqp`, `matplotlib` and `pandas` are needed. You can install it with `pip install osqp matplotlib pandas` |
|
|
38 |
- [Fatigue Modeling](./7_Fatigue_Modeling.ipynb) |
|
|
39 |
|
|
|
40 |
*For those tutorial, `mjrl` and `gym==0.13` are needed. You can install them with `pip install tabulate matplotlib torch gym==0.13 git+https://github.com/aravindr93/mjrl.git@pvr_beta_1vk` |