Skip to content

This is the official repository of GarmentLab: A Unified Simulation and Benchmark for Garment Manipulation

Notifications You must be signed in to change notification settings

CHNxindong/GarmentLab

 
 

Repository files navigation

Garmentlab: A Unified Simulation and Benchmark for Garment Manipulation

NeurIPS 2024
   

teaser

We introduce GarmentLab, a unified simulation and benchmark designed to address the complexities of garment manipulation. Here are the key features and contributions of GarmentLab:

  • Realistic Simulation: Built on NVIDIA’s Isaac Sim, GarmentLab offers a highly-paralleled data collection pipeline and realistic rendering, supporting various sensors and robot operating systems (ROS). The simulation methods include Particle-Based Dynamics (PBD) and Finite Element Method (FEM) for diverse garment types, allowing for precise simulation of garment dynamics.

  • Diverse Task Coverage: GarmentLab supports a wide range of tasks involving interactions between garments, deformable objects, rigid bodies, fluids, and human bodies. It covers 11 categories of garments and includes various robotic manipulators, providing 20 tasks across 5 groups, including garment-garment and garment-avatar interactions.

  • Extensive Dataset and Assets: The benchmark includes a large-scale dataset of garments, robot models, and 3D assets. It features 20 scenes and over 9000 object models from diverse dataset (ClothesNet, Cloth3D, ShapeNet, PartNet-Mobility, etc), ensuring rich simulation content and diverse task scenarios.

  • Sim-to-Real Gap Bridging: To address the sim-to-real challenge, GarmentLab integrates methods like Teleoperation and Visual Sim-Real Alignment. These techniques enhance the real-world applicability of trained models by aligning simulation with real-world data.

  • Open Source and Community Contribution: GarmentLab aims to be an open-source project, providing comprehensive analysis and evaluation tools for future research. It supports the development of robust algorithms for garment manipulation by offering a realistic simulation environment and a rich set of assets.

This benchmark serves as a robust platform for advancing the field of robotic garment manipulation, providing researchers with the tools to explore and develop new methods for this challenging domain.

We provide brief guidance on this page. Please refer to our documentation for more information about garmentlab.

Image Name Description
Hang Hang the clothes on the clothesline
Fling Unfold the clothes and lay them flat on the floor
Wash Put the scarf into the sink and wash it clean
Store Grab the hat and put it in the closet
Fold Fold the flat-laid piece of clothing neatly
PhysicsGarment test the performance of garment simulation
PhysicsDerformable test the performance of Deformable simulation
PhysicsHat test the performance of Hat simulation
Mobile Flatten the tablecloth by a mobile Franka

Get Started

1. Install Isaac Sim-4.0.0

Note that our code is based on Isaac Sim-4.0.0, so you need to install Isaac Sim-4.0.0 first.

To install Isaac Sim, please follow the instructions provided in this tutorial

2. Clone the Code Repository

Clone the GarmentLab code repository from GitHub. Open your terminal and run the following command:

git clone https://github.com/GarmentLab/GarmentLab.git

This will download the code to your local machine. Navigate to the project directory:

cd GarmentLab

3. Download and Set Up Assets

Download the required assets from this Google Drive link. After downloading, extract the contents into the Assets folder within your project directory. Ensure that the folder structure is correct and that all files are properly placed.

4. Install Dependencies

After install the isaacsim and clone our code, you can locate the python executable in Isaac Sim. By default, this should be python.sh. We will refer to this path as PYTHON_PATH.

To set a PYTHON_PATH variable in the terminal that links to the python executable, we can run a command that resembles the following. Make sure to update the paths to your local path.

For Linux: alias PYTHON_PATH=~/.local/share/ov/pkg/isaac_sim-*/python.sh
For Windows: doskey PYTHON_PATH=C:\Users\user\AppData\Local\ov\pkg\isaac_sim-*\python.bat $*
For IsaacSim Docker: alias PYTHON_PATH=/isaac-sim/python.sh

Then you can install the required dependencies by running the following command:

PYTHON_PATH -m pip install open3d

5. Verify Installation

To verify that the installation was successful, we will run some sample code of isaacsim, you can run the following command:

PYTHON_PATH ~/.local/share/ov/pkg/isaac_sim-4.0.0/standalone_examples/api/omni.isaac.core/add_cubes.py

If the code runs successfully, you can see we add some cubes in the scene. If you encounter any issues, please refer to the Isaac Sim documentation.

6. Run the Demos

After setting up the environment, you can run the demos in the demo folder. For example, to run the Hang demo, you can run the following command:

Remember to replace path to your assets folder in the demo code.

PYTHON_PATH demo/HangDemo.py

You can find more details to setup here

BibTex

@inproceedings{lu2024garmentlab,
  title={Garmentlab: A Unified Simulation and Benchmark for Garment Manipulation},
  booktitle={Advances in Neural Information Processing Systems},
  author={Lu, Haoran and Wu, Ruihai and Li, Yitong and Li, Sijie and Zhu, Ziyu and Ning, Chuanruo and Shen, Yan and Luo, Longzan and Chen, Yuanpei and Dong, Hao},
  year={2024}
}

About

This is the official repository of GarmentLab: A Unified Simulation and Benchmark for Garment Manipulation

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Python 100.0%