From 660c4418daac0a3de9e2d05a07af9a1b51bcd177 Mon Sep 17 00:00:00 2001 From: Junjia Liu <24936522+Skylark0924@users.noreply.github.com> Date: Thu, 25 Apr 2024 14:41:12 +0800 Subject: [PATCH] Update README.md --- README.md | 12 ++++++++++-- 1 file changed, 10 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 6ce1cbe20..bd7ad294f 100644 --- a/README.md +++ b/README.md @@ -62,8 +62,11 @@ To give you a quick overview of the pipeline of `rofunc`, we provide an interest from human demonstration. You can find it in the [Quick start](https://rofunc.readthedocs.io/en/latest/quickstart.html) section of the documentation. -The available functions and plans can be found as follows. + +
+The available functions and plans can be found as follows. + > **Note** > ✅: Achieved 🔃: Reformatting ⛔: TODO @@ -96,16 +99,21 @@ The available functions and plans can be found as follows. | | | [`AMP(RofuncRL)`](https://rofunc.readthedocs.io/en/latest/lfd/RofuncRL/AMP.html) | ✅ | | | | | | | | | | [`ASE(RofuncRL)`](https://rofunc.readthedocs.io/en/latest/lfd/RofuncRL/ASE.html) | ✅ | | | | | | | | | | `ODTrans(RofuncRL)` | ⛔ | | | | | | | +
## RofuncRL `RofuncRL` is one of the most important sub-packages of `Rofunc`. It is a modular easy-to-use Reinforcement Learning sub-package designed for Robot Learning tasks. It has been tested with simulators like `OpenAIGym`, `IsaacGym`, `OmniIsaacGym` (see [example gallery](https://rofunc.readthedocs.io/en/latest/examples/learning_rl/index.html)), and also differentiable simulators like `PlasticineLab` and `DiffCloth`. Here is a list of robot tasks trained by `RofuncRL`: + > **Note**\ > You can customize your own project based on RofuncRL by following the [**RofuncRL customize tutorial**](https://rofunc.readthedocs.io/en/latest/tutorial/customizeRL.html).\ > We also provide a [**RofuncRL-based repository template**](https://github.com/Skylark0924/RofuncRL-template) to generate your own repository following the RofuncRL structure by one click.\ > For more details, please check [**the documentation for RofuncRL**](https://rofunc.readthedocs.io/en/latest/examples/learning_rl/index.html). +
+The list of all supported tasks. + | Tasks | Animation | Performance | [ModelZoo](https://github.com/Skylark0924/Rofunc/blob/main/rofunc/config/learning/model_zoo.json) | |-------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------|---------------------------------------------------------------------------------------------------| | Ant | ![](doc/img/task_gifs/AntRofuncRLPPO.gif) | | ✅ | @@ -149,7 +157,7 @@ The available functions and plans can be found as follows. | BiShadowHand
Switch | ![](doc/img/task_gifs/BiShadowHandSwitchRofuncRLPPO.gif) | | ✅ | | BiShadowHand
TwoCatchUnderarm | ![](doc/img/task_gifs/BiShadowHandTwoCatchUnderarmRofuncRLPPO.gif) | | ✅ | - +
## Star History