aliberts HF staff commited on
Commit
21573fe
·
1 Parent(s): 81e6614

Update README

Browse files
Files changed (1) hide show
  1. README.md +47 -4
README.md CHANGED
@@ -1,12 +1,55 @@
1
  ---
2
- library_name: lerobot
 
 
3
  tags:
4
  - diffusion-policy
5
  - model_hub_mixin
6
  - pytorch_model_hub_mixin
7
  - robotics
 
8
  ---
 
9
 
10
- This model has been pushed to the Hub using the [PytorchModelHubMixin](https://huggingface.co/docs/huggingface_hub/package_reference/mixins#huggingface_hub.PyTorchModelHubMixin) integration:
11
- - Library: https://github.com/huggingface/lerobot
12
- - Docs: [More Information Needed]
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
  ---
2
+ license: apache-2.0
3
+ datasets:
4
+ - lerobot/pusht
5
  tags:
6
  - diffusion-policy
7
  - model_hub_mixin
8
  - pytorch_model_hub_mixin
9
  - robotics
10
+ pipeline_tag: robotics
11
  ---
12
+ # Model Card for Diffusion Policy / PushT
13
 
14
+ Diffusion Policy (as per [Diffusion Policy: Visuomotor Policy
15
+ Learning via Action Diffusion](https://arxiv.org/abs/2303.04137)) trained for the `PushT` environment from [gym-pusht](https://github.com/huggingface/gym-pusht).
16
+
17
+ ## How to Get Started with the Model
18
+
19
+ See the [LeRobot library](https://github.com/huggingface/lerobot) (particularly the [evaluation script](https://github.com/huggingface/lerobot/blob/main/lerobot/scripts/eval.py)) for instructions on how to load and evaluate this model.
20
+
21
+ ## Training Details
22
+
23
+ The model was trained using [LeRobot's training script](https://github.com/huggingface/lerobot/blob/main/lerobot/scripts/train.py) and with the [pusht](https://huggingface.co/datasets/lerobot/pusht) dataset, using this command:
24
+
25
+ ```bash
26
+ python lerobot/scripts/train.py \
27
+ --policy.type=diffusion \
28
+ --dataset.repo_id=lerobot/pusht \
29
+ --seed=100000 \
30
+ --env.type=pusht \
31
+ --batch_size=64 \
32
+ --offline.steps=200000 \
33
+ --eval_freq=25000 \
34
+ --save_freq=25000 \
35
+ --wandb.enable=true
36
+ ```
37
+
38
+
39
+ The training curves may be found at https://wandb.ai/aliberts/lerobot/runs/s7elvf4r.
40
+
41
+ ## Evaluation
42
+
43
+ The model was evaluated on the `PushT` environment from [gym-pusht](https://github.com/huggingface/gym-pusht) and compared to a similar model trained with the original [Diffusion Policy code](https://github.com/real-stanford/diffusion_policy). There are two evaluation metrics on a per-episode basis:
44
+
45
+ - Maximum overlap with target (seen as `eval/avg_max_reward` in the charts above). This ranges in [0, 1].
46
+ - Success: whether or not the maximum overlap is at least 95%.
47
+
48
+ Here are the metrics for 500 episodes worth of evaluation. The "Theirs" column is for an equivalent model trained on the original Diffusion Policy repository and evaluated on LeRobot (the model weights may be found in the [`original_dp_repo`](https://huggingface.co/lerobot/diffusion_pusht/tree/original_dp_repo) branch of this respository).
49
+
50
+ <blank>|Ours|Theirs
51
+ -|-|-
52
+ Average max. overlap ratio | 0.945 | 0.957
53
+ Success rate for 500 episodes (%) | 63.2 | 64.2
54
+
55
+ The results of each of the individual rollouts may be found in [eval_info.json](eval_info.json).