Update README.md

README.md

@@ -1,3 +1,81 @@
 ---
 license: apache-2.0
+language:
+- en
+tags:
+- robotics
+- reinforcement learning
+- embodied ai
+- computer vision
+- simulation
+- Embodied AI
+size_categories:
+- 1M<n<10M
+task_categories:
+- reinforcement-learning
+- robotics
+viewer: false
 ---
+
+# ManiSkill Data
+
+![teaser](https://github.com/haosulab/ManiSkill2/blob/main/figures/teaser_v2.jpg?raw=true)
+
+[![PyPI version](https://badge.fury.io/py/mani-skill2.svg)](https://badge.fury.io/py/mani-skill2) [![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/haosulab/ManiSkill2/blob/main/examples/tutorials/1_quickstart.ipynb)
+[![Docs status](https://img.shields.io/badge/docs-passing-brightgreen.svg)](https://haosulab.github.io/ManiSkill2)
+[![Discord](https://img.shields.io/discord/996566046414753822?logo=discord)](https://discord.gg/x8yUZe5AdN)
+<!-- [![Docs](https://github.com/haosulab/ManiSkill2/actions/workflows/gh-pages.yml/badge.svg)](https://haosulab.github.io/ManiSkill2) -->
+
+ManiSkill is a unified benchmark for learning generalizable robotic manipulation skills powered by [SAPIEN](https://sapien.ucsd.edu/). **It features 20 out-of-box task families with 2000+ diverse object models and 4M+ demonstration frames**. Moreover, it empowers fast visual input learning algorithms so that **a CNN-based policy can collect samples at about 2000 FPS with 1 GPU and 16 processes on a workstation**. The benchmark can be used to study a wide range of algorithms: 2D & 3D vision-based reinforcement learning, imitation learning, sense-plan-act, etc.
+This is the huggingface datasets page for all data related to [ManiSkill2](https://github.com/haosulab/ManiSkill2), 
+including **assets, robot demonstrations, and pretrained models.** Note previously there is a ManiSkill and ManiSkill2, we are rebranding it all to just ManiSkill and the python package versioning tells you which iteration.
+
+For detailed information about ManiSkill, head over to our [GitHub repository](https://github.com/haosulab/ManiSkill2), [website](https://maniskill2.github.io/), or [ICLR 2023 paper](https://arxiv.org/abs/2302.04659)
+[documentation](https://maniskill.readthedocs.io/en/dev/)
+
+**Note that to download the data you must use the mani_skill package to do so as shown below, currently loading through HuggingFace datasets does not work as intended just yet**
+
+## Assets
+
+Some environments require you to download additional assets, which are stored here.
+
+You can download task-specific assets by running 
+
+```
+python -m mani_skill.utils.download_asset ${ENV_ID}
+```
+
+## Demonstration Data
+
+We provide a command line tool (mani_skill.utils.download_demo) to download demonstrations from here.
+
+```
+# Download the demonstration dataset for a specific task
+python -m mani_skill2.utils.download_demo ${ENV_ID}
+# Download the demonstration datasets for all rigid-body tasks to "./demos"
+python -m mani_skill2.utils.download_demo rigid_body -o ./demos
+```
+
+To learn how to use the demonstrations and what environments are available, go to the demonstrations documentation page: https://maniskill.readthedocs.io/en/dev/user_guide/datasets/datasets.html
+
+
+## License
+
+All rigid body environments in ManiSkill are licensed under fully permissive licenses (e.g., Apache-2.0).
+
+The assets are licensed under [CC BY-NC 4.0](https://creativecommons.org/licenses/by-nc/4.0/legalcode).
+
+## Citation
+
+If you use ManiSkill or its assets, models, and demonstrations, please cite using the following BibTeX entry for now:
+
+```
+@inproceedings{gu2023maniskill2,
+  title={ManiSkill2: A Unified Benchmark for Generalizable Manipulation Skills},
+  author={Gu, Jiayuan and Xiang, Fanbo and Li, Xuanlin and Ling, Zhan and Liu, Xiqiaing and Mu, Tongzhou and Tang, Yihe and Tao, Stone and Wei, Xinyue and Yao, Yunchao and Yuan, Xiaodi and Xie, Pengwei and Huang, Zhiao and Chen, Rui and Su, Hao},
+  booktitle={International Conference on Learning Representations},
+  year={2023}
+}
+```
+
+A ManiSkill3 bibtex will be made later.