Alina Lozovskaya commited on
Commit
55ea540
·
1 Parent(s): b08cbfb

Include reachy_mini_wireless into README

Browse files
Files changed (1) hide show
  1. README.md +10 -5
README.md CHANGED
@@ -32,12 +32,13 @@ source .venv/bin/activate
32
  uv sync
33
  ```
34
 
35
- To include optional vision dependencies:
36
  ```
37
- uv sync --extra local_vision # For local PyTorch/Transformers vision
38
- uv sync --extra yolo_vision # For YOLO-based vision
39
- uv sync --extra mediapipe_vision # For MediaPipe-based vision
40
- uv sync --extra all_vision # For all vision features
 
41
  ```
42
 
43
  You can combine extras or include dev dependencies:
@@ -56,6 +57,9 @@ pip install -e .
56
  Install optional extras depending on the feature set you need:
57
 
58
  ```bash
 
 
 
59
  # Vision stacks (choose at least one if you plan to run face tracking)
60
  pip install -e .[local_vision]
61
  pip install -e .[yolo_vision]
@@ -72,6 +76,7 @@ Some wheels (e.g. PyTorch) are large and require compatible CUDA or CPU builds
72
 
73
  | Extra | Purpose | Notes |
74
  |-------|---------|-------|
 
75
  | `local_vision` | Run the local VLM (SmolVLM2) through PyTorch/Transformers. | GPU recommended; ensure compatible PyTorch builds for your platform.
76
  | `yolo_vision` | YOLOv8 tracking via `ultralytics` and `supervision`. | CPU friendly; supports the `--head-tracker yolo` option.
77
  | `mediapipe_vision` | Lightweight landmark tracking with MediaPipe. | Works on CPU; enables `--head-tracker mediapipe`.
 
32
  uv sync
33
  ```
34
 
35
+ To include optional dependencies:
36
  ```
37
+ uv sync --extra reachy_mini_wireless # For wireless Reachy Mini with GStreamer support
38
+ uv sync --extra local_vision # For local PyTorch/Transformers vision
39
+ uv sync --extra yolo_vision # For YOLO-based vision
40
+ uv sync --extra mediapipe_vision # For MediaPipe-based vision
41
+ uv sync --extra all_vision # For all vision features
42
  ```
43
 
44
  You can combine extras or include dev dependencies:
 
57
  Install optional extras depending on the feature set you need:
58
 
59
  ```bash
60
+ # Wireless Reachy Mini support
61
+ pip install -e .[reachy_mini_wireless]
62
+
63
  # Vision stacks (choose at least one if you plan to run face tracking)
64
  pip install -e .[local_vision]
65
  pip install -e .[yolo_vision]
 
76
 
77
  | Extra | Purpose | Notes |
78
  |-------|---------|-------|
79
+ | `reachy_mini_wireless` | Wireless Reachy Mini with GStreamer support. | Required for wireless versions of Reachy Mini, includes GStreamer dependencies.
80
  | `local_vision` | Run the local VLM (SmolVLM2) through PyTorch/Transformers. | GPU recommended; ensure compatible PyTorch builds for your platform.
81
  | `yolo_vision` | YOLOv8 tracking via `ultralytics` and `supervision`. | CPU friendly; supports the `--head-tracker yolo` option.
82
  | `mediapipe_vision` | Lightweight landmark tracking with MediaPipe. | Works on CPU; enables `--head-tracker mediapipe`.