finished version 0.1.

robfiras · Dec 16, 2023 · 2ad5237 · 2ad5237
1 parent a3ce2cb
commit 2ad5237
Show file tree

Hide file tree

Showing 2 changed files with 28 additions and 9 deletions.
diff --git a/README.md b/README.md
@@ -20,19 +20,38 @@ enabling evaluation across a spectrum of difficulty levels.
 
 ## Installation
 
-To install this repository, clone it and then run:
+You have the choice to install the latest release via PyPI by running 
+
+```bash
+pip install loco-mujoco 
+```
+
+or you do an editable installation by cloning this repository and then running:
 
 ```bash
 cd loco-mujoco
 pip install -e . 
 ```
 
-Now you have to download and install the datasets by running
+### Download the Datasets
+You have the choice of downloading all datasets available or only the ones you need.
+
+To install all datasets run:  
+```bash
+loco-mujoco-download
+```
+
+To install only the real (motion capture, no actions) datasets run:  
+```bash
+loco-mujoco-download-real
+```
 
+To install only the perfect (ground-truth with actions) datasets run:  
 ```bash
-python download_datasets.py
+loco-mujoco-download-perfect
 ```
 
+### Installing the Baselines
 If you also want to run the baselines, you have to install our imitation learning library [imitation_lib](https://github.com/robfiras/ls-iq). You find example files for training the baselines for any LocoMuJoCo task [here](examples/imitation_learning).
 
 To verify that everything is installed correctly, run the examples such as:

diff --git a/loco_mujoco/environments/README.md b/loco_mujoco/environments/README.md
@@ -5,13 +5,13 @@ The status of a dataset can be seen down below. ✅ means it is already availabl
  | Image | Task-IDs | Status of Datasets | Description|
  |---|---|---|---|
  | ![out5](https://github.com/robfiras/loco-mujoco/assets/69359729/cdcd4617-c18a-448d-b42a-ea01384016b0) | HumanoidMuscle.walk </br> HumanoidMuscle.run </br> HumanoidMuscle4Ages.walk.4 </br> HumanoidMuscle.run </br> HumanoidMuscle4Ages.run.4 | real: ✅  <br /> perfect: ✅   <br /> preference: 🔶| Task of an adult **Muscle** Humanoid Walking or Running Straight. |
- | ![out4](https://github.com/robfiras/loco-mujoco/assets/69359729/1bdebeb1-401c-439e-8f2e-7197fd34c5e5) | HumanoidMuscle4Ages.walk.3 </br> HumanoidMuscle4Ages.run.3  | real: ✅  <br /> perfect: 🔶  <br /> preference: ✅ | Task of a (~12 year old) **Muscle** Humanoid Walking or Running Straight. |
- | ![out9](https://github.com/robfiras/loco-mujoco/assets/69359729/2c7aeb58-65a6-427c-8b12-197c96410cd8) | HumanoidMuscle4Ages.walk.2 </br> HumanoidMuscle4Ages.run.2 | real: ✅  <br /> perfect: 🔶  <br /> preference: ✅ | Task of a (~5-6 year old) **Muscle** Humanoid Walking or Running Straight. |
- | ![out9](https://github.com/robfiras/loco-mujoco/assets/69359729/600a917f-c784-4b5e-ac99-9472711de843) | HumanoidMuscle4Ages.walk.1 </br> HumanoidMuscle4Ages.run.1 | real: ✅  <br /> perfect: 🔶  <br /> preference: ✅ | Task of a (~2 year old) **Muscle** Humanoid Walking or Running Straight. |
+ | ![out4](https://github.com/robfiras/loco-mujoco/assets/69359729/1bdebeb1-401c-439e-8f2e-7197fd34c5e5) | HumanoidMuscle4Ages.walk.3 </br> HumanoidMuscle4Ages.run.3  | real: ✅  <br /> perfect: ✅  <br /> preference: 🔶 | Task of a (~12 year old) **Muscle** Humanoid Walking or Running Straight. |
+ | ![out9](https://github.com/robfiras/loco-mujoco/assets/69359729/2c7aeb58-65a6-427c-8b12-197c96410cd8) | HumanoidMuscle4Ages.walk.2 </br> HumanoidMuscle4Ages.run.2 | real: ✅  <br /> perfect: ✅  <br /> preference: 🔶 | Task of a (~5-6 year old) **Muscle** Humanoid Walking or Running Straight. |
+ | ![out9](https://github.com/robfiras/loco-mujoco/assets/69359729/600a917f-c784-4b5e-ac99-9472711de843) | HumanoidMuscle4Ages.walk.1 </br> HumanoidMuscle4Ages.run.1 | real: ✅  <br /> perfect: ✅  <br /> preference: 🔶 | Task of a (~2 year old) **Muscle** Humanoid Walking or Running Straight. |
  | ![out39](https://github.com/robfiras/loco-mujoco/assets/69359729/cf32520f-5a2e-401a-9f2e-b8033ef7109c) | HumanoidTorque.walk </br> HumanoidTorque.run </br> HumanoidTorque4Ages.walk.4 </br> HumanoidTorque.run </br> HumanoidTorque4Ages.run.4 | real: ✅  <br /> perfect: ✅   <br /> preference: 🔶| Task of an adult **Torque** Humanoid Walking or Running Straight. |
- | ![out3](https://github.com/robfiras/loco-mujoco/assets/69359729/352f3594-8903-4eaf-a223-f751b590f4ec) | HumanoidTorque4Ages.walk.3 </br> HumanoidTorque4Ages.run.3  | real: ✅  <br /> perfect: 🔶  <br /> preference: ✅ | Task of a (~12 year old) **Torque** Humanoid Walking or Running Straight. |
- | ![out5](https://github.com/robfiras/loco-mujoco/assets/69359729/06c83af9-3c45-43a1-8173-aa1d8771fe4c) | HumanoidTorque4Ages.walk.2 </br> HumanoidTorque4Ages.run.2 | real: ✅  <br /> perfect: 🔶  <br /> preference: ✅ | Task of a (~5-6 year old) **Torque** Humanoid Walking or Running Straight. |
- | ![out3](https://github.com/robfiras/loco-mujoco/assets/69359729/5ec93baa-bed8-4d9f-b983-3bc12264b9b6) | HumanoidTorque4Ages.walk.1 </br> HumanoidTorque4Ages.run.1 | real: ✅  <br /> perfect: 🔶  <br /> preference: ✅ | Task of a (~2 year old) **Torque** Humanoid Walking or Running Straight. |
+ | ![out3](https://github.com/robfiras/loco-mujoco/assets/69359729/352f3594-8903-4eaf-a223-f751b590f4ec) | HumanoidTorque4Ages.walk.3 </br> HumanoidTorque4Ages.run.3  | real: ✅  <br /> perfect: ✅  <br /> preference: 🔶 | Task of a (~12 year old) **Torque** Humanoid Walking or Running Straight. |
+ | ![out5](https://github.com/robfiras/loco-mujoco/assets/69359729/06c83af9-3c45-43a1-8173-aa1d8771fe4c) | HumanoidTorque4Ages.walk.2 </br> HumanoidTorque4Ages.run.2 | real: ✅  <br /> perfect: ✅  <br /> preference: 🔶 | Task of a (~5-6 year old) **Torque** Humanoid Walking or Running Straight. |
+ | ![out3](https://github.com/robfiras/loco-mujoco/assets/69359729/5ec93baa-bed8-4d9f-b983-3bc12264b9b6) | HumanoidTorque4Ages.walk.1 </br> HumanoidTorque4Ages.run.1 | real: ✅  <br /> perfect: ✅  <br /> preference: 🔶 | Task of a (~2 year old) **Torque** Humanoid Walking or Running Straight. |
  | ![out8](https://github.com/robfiras/loco-mujoco/assets/69359729/fed0315c-921e-4b2e-a9c2-54b85198ef65) | UnitreeH1.walk  | real: ✅  <br /> perfect: ✅   <br /> preference: 🔶| UnitreeH1 Straight Walking Task. |
  | ![out9](https://github.com/robfiras/loco-mujoco/assets/69359729/ab0dec59-fc24-4763-8ff6-38d58ac3b3de) | UnitreeH1.run  | real: ✅  <br /> perfect: ✅   <br /> preference: 🔶| UnitreeH1 Straight Running Task. |
  | ![out3](https://github.com/robfiras/loco-mujoco/assets/69359729/851ff3c0-d05f-4de1-a00b-7b3204056e2f) | UnitreeH1.carry | real: ✅  <br /> perfect: ✅   <br /> preference: 🔶| UnitreeH1 Carry Task. |