nielsr HF Staff commited on
Commit
2ab5fc6
·
verified ·
1 Parent(s): 250750a

Add model card and metadata

Browse files

Hi, I'm Niels from the Hugging Face community science team.

I've opened this pull request to improve the model card for the **Garment Particles** project. This PR adds relevant metadata (pipeline tag and license) and provides a structured description including links to the paper, project page, and the official code repository. I have also included sample usage commands for inference as documented in the GitHub README.

This helps make the model more discoverable and easier to use for the community.

Files changed (1) hide show
  1. README.md +69 -0
README.md CHANGED
@@ -1,3 +1,72 @@
1
  ---
2
  license: mit
 
3
  ---
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
  ---
2
  license: mit
3
+ pipeline_tag: text-to-3d
4
  ---
5
+
6
+ # Garment Particles: A 2D–3D Symmetric Garment Representation for Generation and Editing
7
+
8
+ Official checkpoints for **Garment Particles**, a framework for garment design spanning intuitive creation from high-level intent (text, image, sketch) to complex low-level editing across 2D sewing patterns and 3D draped geometry.
9
+
10
+ - **Paper**: [Garment Particles: A 2D--3D Symmetric Garment Representation for Generation and Editing](https://huggingface.co/papers/2605.26391)
11
+ - **Project Page**: [https://garment-particles.github.io](https://garment-particles.github.io)
12
+ - **Code**: [https://github.com/garment-particles/GarmentParticles](https://github.com/garment-particles/GarmentParticles)
13
+
14
+ ## Overview
15
+ Garment Particles uses a 5D point-cloud representation to jointly encode 2D sewing patterns and 3D geometry. This representation enables Garment Particles Flow (GPF), a rectified flow framework that supports intuitive generation from high-level inputs (text, images, sketches) and various editing operations on 2D sewing patterns and 3D geometries.
16
+
17
+ ## Installation
18
+ To use these checkpoints, clone the [official repository](https://github.com/garment-particles/GarmentParticles) and install the dependencies:
19
+
20
+ ```bash
21
+ conda create -n interact_garment python=3.10
22
+ conda activate interact_garment
23
+ pip install torch torchvision
24
+ pip install -r src/requirements.txt
25
+ export PYTHONPATH=$PWD/src:$PYTHONPATH
26
+ ```
27
+
28
+ ## Sample Usage (Inference)
29
+
30
+ Download the checkpoints into `src/checkpoints/` and run the inference script from the `src` directory.
31
+
32
+ ### Text / Unconditional Generation
33
+ ```bash
34
+ torchrun --standalone --nproc_per_node=1 inference/infer_twostage.py \
35
+ eval.sample_per_batch=1 eval.n_samples=0 eval.evaluate=False \
36
+ train.exp_name=uncond_samples sample.num_sampling_steps=100 \
37
+ gpf_ckpt=null \
38
+ dataset.front_only=True dataset.use_all_captions=True \
39
+ dataset.img_drop_prob=1 dataset.text_drop_prob=1 \
40
+ model.use_qknorm=True \
41
+ edge_model.use_qknorm=True \
42
+ edge_model_ckpt=checkpoints/edge \
43
+ model=sparse_lightningdit_v3_xl1_w_text_fsdp2 \
44
+ pgf_weight_init=checkpoints/pgf_text \
45
+ --config-name sparselightningdit_xl_garment_particle_inference
46
+ ```
47
+
48
+ ### Image-Conditioned Generation
49
+ ```bash
50
+ torchrun --standalone --nproc_per_node=1 inference/infer_twostage.py \
51
+ eval.sample_per_batch=1 eval.n_samples=0 eval.evaluate=False \
52
+ train.exp_name=img_cond_samples sample.num_sampling_steps=100 \
53
+ gpf_ckpt=null \
54
+ dataset.front_only=True dataset.use_all_captions=True \
55
+ dataset.img_drop_prob=0 dataset.text_drop_prob=1 \
56
+ model.use_qknorm=True model.use_rope=False model.in_channels=6 model.freeze_everything=False \
57
+ edge_model.use_qknorm=True \
58
+ edge_model_ckpt=checkpoints/edge \
59
+ model=sparse_lightningdit_v3_xl1_w_img_text_v2 \
60
+ pgf_weight_init=checkpoints/pgf_image \
61
+ --config-name sparselightningdit_xl_garment_particle_inference
62
+ ```
63
+
64
+ ## Citation
65
+ ```bibtex
66
+ @inproceedings{garmentparticles2026,
67
+ title={Garment Particles: A 2D--3D Symmetric Garment Representation for Generation and Editing},
68
+ author={George Nakayama and others},
69
+ booktitle={SIGGRAPH Conference Papers},
70
+ year={2026}
71
+ }
72
+ ```