Alina Lozovskaya commited on
Commit
122f0d8
·
1 Parent(s): 436b1d6

Update Runtime Options in README

Browse files
Files changed (1) hide show
  1. README.md +15 -6
README.md CHANGED
@@ -14,9 +14,18 @@ pip install -e .
14
  reachy-mini-conversation-demo
15
  ```
16
 
17
- ## Runtime toggles
18
- You can pass flags to control runtime behavior:
19
- - `--sim` - run in simulation mode (no real robot needed).
20
- - `--vision` - enable vision system.
21
- - `--head-tracking` - enable head tracking (ignored if `--sim` is active).
22
- - `--debug` - enable debug logging (default is INFO).
 
 
 
 
 
 
 
 
 
 
14
  reachy-mini-conversation-demo
15
  ```
16
 
17
+ ## Runtime Options
18
+
19
+ | Option | Values | Default | Description |
20
+ |--------|--------|---------|-------------|
21
+ | `--sim` | *(flag)* | off | Run in **simulation mode** (no physical robot required). |
22
+ | `--vision` | *(flag)* | off | Enable the **vision system** (must be paired with `--vision-provider`). |
23
+ | `--vision-provider` | `local`, `openai` | `local` | Select vision backend:<br>• **local** → Hugging Face VLM (SmolVLM2) runs on your machine.<br>• **openai** → OpenAI multimodal models via API (requires `OPENAI_API_KEY`). |
24
+ | `--head-tracking` | *(flag)* | off | Enable **head tracking** (ignored when `--sim` is active). |
25
+ | `--debug` | *(flag)* | off | Enable **debug logging** (default log level is INFO). |
26
+
27
+ ## Examples
28
+ - Simulated run with OpenAI Vision:
29
+ ```
30
+ reachy-mini-conversation-demo --sim --vision --vision-provider=openai
31
+ ```