Skip to content

Commit 8eec3cf

Browse files
Docs commands update
1 parent 95d5060 commit 8eec3cf

File tree

1 file changed

+9
-3
lines changed

1 file changed

+9
-3
lines changed

docs/getting_started.md

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -245,6 +245,12 @@ python -c "import crisp_gym"
245245

246246
1. This will set some environment variable pre-installation as well as checking that you defined the previous script properly.
247247

248+
You can also check that your configs are set up with:
249+
250+
```sh
251+
pixi shell crisp-check-config
252+
```
253+
248254
If the previous steps worked, then you are good to go.
249255

250256
### Teleoperation: Record data in [LeRobotFormat](https://github.com/huggingface/lerobot)
@@ -263,7 +269,7 @@ For your specific setup you need to:
263269

264270
Then, to record data use:
265271
```sh
266-
pixi run -e humble-lerobot python scripts/record_lerobot_format_leader_follower.py \
272+
pixi run -e humble-lerobot crisp-record-leader-follower \
267273
--repo-id <your_account>/<repo_name> # (1)!
268274
```
269275

@@ -366,7 +372,7 @@ a similar record script to [`scripts/record_lerobot_format_leader_follower.py`](
366372

367373
You can use LeRobot train scripts to train a policy simply by running:
368374
```sh
369-
pixi run -e lerobot python -m lerobot.scripts.train \
375+
pixi run -e lerobot python -m lerobot.scripts.lerobot-train \
370376
--dataset.repo_id=<your_account>/<repo_name> \
371377
--policy.type=diffusion \
372378
--policy.push_to_hub=false
@@ -382,7 +388,7 @@ Check [LeRobot](https://github.com/huggingface/lerobot) for more information.
382388

383389
After training with LeRobot, you can deploy the policy with:
384390
```sh
385-
pixi run -e humble-lerobot python scripts/deploy_policy.py # (1)!
391+
pixi run -e humble-lerobot crisp-deploy-policy # (1)!
386392
```
387393

388394
1. The script will interactively allow you to choose a model inside `outputs/train`. If you want to explicitly pass a path you can override it with `--path`

0 commit comments

Comments
 (0)