Skip to content

Commit a5fdae7

Browse files
committed
fix urls dora-rs/dora and dora-rs/node-hub
1 parent 46884f7 commit a5fdae7

File tree

10 files changed

+100
-67
lines changed

10 files changed

+100
-67
lines changed

README.md

Lines changed: 51 additions & 46 deletions
Large diffs are not rendered by default.

dora-distil-whisper/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,10 +19,10 @@ This node is supposed to be used as follows:
1919
## Examples
2020
2121
- speech to text
22-
- github: https://github.com/dora-rs/dora/blob/main/examples/speech-to-text
22+
- github: https://github.com/dora-rs/node-hub/blob/main/examples/speech-to-text
2323
- website: https://dora-rs.ai/docs/examples/stt
2424
- vision language model
25-
- github: https://github.com/dora-rs/dora/blob/main/examples/vlm
25+
- github: https://github.com/dora-rs/node-hub/blob/main/examples/vlm
2626
- website: https://dora-rs.ai/docs/examples/vlm
2727
2828
## License

dora-microphone/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ There's a maximum amount of voice duration, to avoid having no input for too lon
3131
## Reference documentation
3232
3333
- dora-microphone
34-
- github: https://github.com/dora-rs/dora/blob/main/node-hub/dora-microphone
34+
- github: https://github.com/dora-rs/node-hub/blob/main/node-hub/dora-microphone
3535
- website: http://dora-rs.ai/docs/nodes/microphone
3636
- sounddevice
3737
- website: https://python-sounddevice.readthedocs.io/en/0.5.1/
@@ -40,7 +40,7 @@ There's a maximum amount of voice duration, to avoid having no input for too lon
4040
## Examples
4141
4242
- Speech to Text
43-
- github: https://github.com/dora-rs/dora/blob/main/examples/speech-to-text
43+
- github: https://github.com/dora-rs/node-hub/blob/main/examples/speech-to-text
4444
- website: https://dora-rs.ai/docs/examples/stt
4545
4646
## License

dora-qwen2-5-vl/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,5 +28,5 @@ This node is supposed to be used as follows:
2828
## Examples
2929
3030
- Vision Language Model
31-
- Github: https://github.com/dora-rs/dora/blob/main/examples/vlm
31+
- Github: https://github.com/dora-rs/node-hub/blob/main/examples/vlm
3232
- Website: https://dora-rs.ai/docs/examples/vlm

dora-qwenvl/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,5 +28,5 @@ This node is supposed to be used as follows:
2828
## Examples
2929
3030
- Vision Language Model
31-
- Github: https://github.com/dora-rs/dora/blob/main/examples/vlm
31+
- Github: https://github.com/dora-rs/node-hub/blob/main/examples/vlm
3232
- Website: https://dora-rs.ai/docs/examples/vlm

dora-rdt-1b/tests/test_dora_rdt_1b.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ def test_download_policy():
4141

4242
def test_download_vision_model():
4343
# Skip vision test as it is currently failing on macOS
44-
# See: https://github.com/dora-rs/dora/actions/runs/13484462433/job/37673857429
44+
# See: https://github.com/dora-rs/node-hub/actions/runs/13484462433/job/37673857429
4545
"""TODO: Add docstring."""
4646
from dora_rdt_1b.main import get_vision_model
4747

dora-rerun/README.md

Lines changed: 37 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,7 @@ This version introduces significant breaking changes to align with Rerun SDK v0.
1818
- This allows gradual migration at your own pace
1919

2020
Example migration:
21+
2122
```yaml
2223
# Old way (still works silently):
2324
inputs:
@@ -41,6 +42,7 @@ The move from input-name-based visualization to explicit primitive metadata was
4142
- Adding new visualization types required careful naming coordination
4243
4344
**Pros of the new primitive-based system:**
45+
4446
- ✅ **Explicit intent**: Clear specification of visualization type via metadata
4547
- ✅ **Flexible naming**: Input names can be descriptive (e.g., `front_camera`, `rear_camera`) rather than generic
4648
- ✅ **Proper hierarchies**: Entity paths and relationships are correctly maintained in Rerun
@@ -49,12 +51,14 @@ The move from input-name-based visualization to explicit primitive metadata was
4951
- ✅ **Better error messages**: System can report exactly what primitive was expected vs received
5052

5153
**Cons to consider:**
54+
5255
- ❌ **Breaking change**: All nodes sending to dora-rerun must be updated
5356
- ❌ **More verbose**: Requires metadata on every input
5457
- ❌ **Migration effort**: Existing systems need code changes
5558
- ❌ **Coordination required**: Senders and receivers must agree on primitive types
5659

5760
**Maintainer considerations:**
61+
5862
- This change prioritizes explicit configuration over convention
5963
- The migration path is straightforward but requires touching many files
6064
- Future primitive additions won't break existing code
@@ -67,12 +71,14 @@ The primitive-based system was battle-tested by porting [Peng](https://github.co
6771
![Peng Quadrotor in Dora-Rerun](./docs/peng-dora.jpg)
6872

6973
The visualization shows:
74+
7075
- **3D Scene (left)**: Real-time quadrotor position, orientation, and trajectory with proper hierarchical entity paths
7176
- **Depth Camera (top right)**: Simulated depth sensor data for obstacle avoidance
7277
- **Telemetry (bottom)**: Time-series data including position, velocity, and orientation streams
7378
- **Control Signals**: Real-time visualization of motor commands and control loops
7479

7580
This integration required the new primitive system to handle:
81+
7682
- Multiple coordinate frames (world, body, camera)
7783
- Hierarchical sensor configurations
7884
- High-frequency telemetry data
@@ -81,6 +87,7 @@ This integration required the new primitive system to handle:
8187
Without the explicit primitive system, maintaining proper hierarchies and multiple sensor streams would have been challenging with the previous naming-convention-based approach.
8288

8389
**Citation:**
90+
8491
```bibtex
8592
@software{peng_quad,
8693
author = {Yang Zhou},
@@ -95,22 +102,26 @@ Without the explicit primitive system, maintaining proper hierarchies and multip
95102
### Major Breaking Changes
96103

97104
1. **Primitive-based Visualization System**
105+
98106
- **BREAKING**: All inputs now require a `primitive` metadata field to specify the visualization type
99107
- Previously, visualization type was inferred from the input ID (e.g., "image", "depth", "boxes2d")
100108
- Now you must explicitly specify: `metadata: { "primitive": "image" }` (or "depth", "boxes2d", etc.)
101109
- This change allows more flexible naming of inputs and clearer intent
102110

103111
2. **Rerun SDK Upgrade**
112+
104113
- Updated from Rerun v0.23.3 to v0.24.0
105114
- Updated Python dependency from `rerun_sdk>=0.23.1` to `rerun_sdk>=0.24.0`
106115

107116
3. **New 3D Boxes Support**
117+
108118
- Added comprehensive 3D bounding box visualization with multiple format support
109119
- Supports three formats: "center_half_size" (default), "center_size", and "min_max"
110120
- Configurable rendering: wireframe (default) or solid fill
111121
- Support for per-box colors and labels
112122

113123
4. **Enhanced Depth Visualization**
124+
114125
- Depth data now supports pinhole camera setup for proper 3D reconstruction
115126
- Requires Float32Array format (previously supported Float64 and UInt16)
116127
- New metadata fields for camera configuration:
@@ -127,16 +138,18 @@ Without the explicit primitive system, maintaining proper hierarchies and multip
127138
### Migration Guide
128139

129140
#### Before (old system):
141+
130142
```yaml
131143
nodes:
132144
- id: rerun
133145
inputs:
134-
image: camera/image # Type inferred from "image" in ID
135-
depth: sensor/depth # Type inferred from "depth" in ID
136-
boxes2d: detector/boxes2d # Type inferred from "boxes2d" in ID
146+
image: camera/image # Type inferred from "image" in ID
147+
depth: sensor/depth # Type inferred from "depth" in ID
148+
boxes2d: detector/boxes2d # Type inferred from "boxes2d" in ID
137149
```
138150

139151
#### After (new system):
152+
140153
```yaml
141154
nodes:
142155
- id: rerun
@@ -153,19 +166,22 @@ nodes:
153166
### Migration Status
154167

155168
**Successfully tested examples:**
169+
156170
- ✅ examples/rerun-viewer/dataflow.yml - Basic camera visualization
157171
- ✅ examples/camera/dataflow_rerun.yml - Camera with rerun
158172
- ✅ examples/python-dataflow/dataflow.yml - Camera + YOLO object detection
159173
- ✅ examples/python-multi-env/dataflow.yml - Multi-environment setup
160174

161175
**Updated but NOT tested examples:**
176+
162177
- 🔧 examples/keyboard/dataflow.yml - Updated dora-keyboard to send primitive metadata (requires Linux/X11 for testing)
163-
- 🔧 examples/translation/* - Updated dora-distil-whisper and dora-argotranslate to send primitive metadata
178+
- 🔧 examples/translation/\* - Updated dora-distil-whisper and dora-argotranslate to send primitive metadata
164179
- 🔧 examples/reachy2-remote/dataflow_reachy.yml - Updated multiple nodes (dora-reachy2, dora-qwen2-5-vl, dora-sam2, parse_bbox.py, parse_whisper.py)
165180
- 🔧 examples/lebai/graphs/dataflow_full.yml - Updated dora-qwenvl, llama-factory-recorder, key_interpolation.py
166-
- 🔧 examples/av1-encoding/* - Updated dora-dav1d and dora-rav1e to send primitive metadata
181+
- 🔧 examples/av1-encoding/\* - Updated dora-dav1d and dora-rav1e to send primitive metadata
167182

168183
Key changes made:
184+
169185
1. Added `-e` flag to local package installs in dataflows for development
170186
2. Updated node packages to include `"primitive"` metadata:
171187
- opencv-video-capture: adds `"primitive": "image"`
@@ -211,11 +227,13 @@ pip install dora-rerun
211227
All inputs require a `"primitive"` field in the metadata to specify the visualization type:
212228

213229
### 1. image
230+
214231
- **Data**: UInt8Array
215232
- **Required metadata**: `{ "primitive": "image", "width": int, "height": int, "encoding": str }`
216233
- **Supported encodings**: "bgr8", "rgb8", "jpeg", "png", "avif"
217234

218-
### 2. depth
235+
### 2. depth
236+
219237
- **Data**: Float32Array
220238
- **Required metadata**: `{ "primitive": "depth", "width": int, "height": int }`
221239
- **Optional metadata for 3D reconstruction**:
@@ -225,15 +243,18 @@ All inputs require a `"primitive"` field in the metadata to specify the visualiz
225243
- `"principal_point"`: [cx, cy] principal point
226244

227245
### 3. text
246+
228247
- **Data**: StringArray
229248
- **Required metadata**: `{ "primitive": "text" }`
230249

231250
### 4. boxes2d
251+
232252
- **Data**: StructArray or Float32Array
233253
- **Required metadata**: `{ "primitive": "boxes2d", "format": str }`
234254
- **Formats**: "xyxy" (default), "xywh"
235255

236256
### 5. boxes3d
257+
237258
- **Data**: Float32Array or StructArray
238259
- **Required metadata**: `{ "primitive": "boxes3d" }`
239260
- **Optional metadata**:
@@ -242,35 +263,42 @@ All inputs require a `"primitive"` field in the metadata to specify the visualiz
242263
- `"color"`: [r, g, b] RGB values 0-255
243264

244265
### 6. masks
266+
245267
- **Data**: UInt8Array
246268
- **Required metadata**: `{ "primitive": "masks", "width": int, "height": int }`
247269

248270
### 7. jointstate
271+
249272
- **Data**: Float32Array
250273
- **Required metadata**: `{ "primitive": "jointstate" }`
251274
- **Note**: Requires URDF configuration (see below)
252275

253276
### 8. pose
277+
254278
- **Data**: Float32Array (7 values: [x, y, z, qx, qy, qz, qw])
255279
- **Required metadata**: `{ "primitive": "pose" }`
256280

257281
### 9. series
282+
258283
- **Data**: Float32Array
259284
- **Required metadata**: `{ "primitive": "series" }`
260285
- **Note**: Currently logs only the first value as a scalar
261286

262287
### 10. points3d
288+
263289
- **Data**: Float32Array (xyz triplets)
264290
- **Required metadata**: `{ "primitive": "points3d" }`
265291
- **Optional metadata**:
266292
- `"color"`: [r, g, b] RGB values 0-255
267293
- `"radii"`: list of float radius values
268294

269295
### 11. points2d
296+
270297
- **Data**: Float32Array (xy pairs)
271298
- **Required metadata**: `{ "primitive": "points2d" }`
272299

273300
### 12. lines3d
301+
274302
- **Data**: Float32Array (xyz triplets defining line segments)
275303
- **Required metadata**: `{ "primitive": "lines3d" }`
276304
- **Optional metadata**:
@@ -313,7 +341,7 @@ Make sure to name the dataflow as follows:
313341
## Reference documentation
314342

315343
- dora-rerun
316-
- github: https://github.com/dora-rs/dora/blob/main/node-hub/dora-rerun
344+
- github: https://github.com/dora-rs/node-hub/blob/main/node-hub/dora-rerun
317345
- website: http://dora-rs.ai/docs/nodes/rerun
318346
- rerun
319347
- github: https://github.com/rerun-io/rerun
@@ -322,10 +350,10 @@ Make sure to name the dataflow as follows:
322350
## Examples
323351

324352
- speech to text
325-
- github: https://github.com/dora-rs/dora/blob/main/examples/speech-to-text
353+
- github: https://github.com/dora-rs/node-hub/blob/main/examples/speech-to-text
326354
- website: https://dora-rs.ai/docs/examples/stt
327355
- vision language model
328-
- github: https://github.com/dora-rs/dora/blob/main/examples/vlm
356+
- github: https://github.com/dora-rs/node-hub/blob/main/examples/vlm
329357
- website: https://dora-rs.ai/docs/examples/vlm
330358

331359
## License

dora-vad/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -29,15 +29,15 @@ There's a maximum amount of voice duration, to avoid having no input for too lon
2929
## Reference documentation
3030
3131
- dora-sidero
32-
- github: https://github.com/dora-rs/dora/blob/main/node-hub/dora-vad
32+
- github: https://github.com/dora-rs/node-hub/blob/main/node-hub/dora-vad
3333
- website: http://dora-rs.ai/docs/nodes/sidero
3434
- Sidero
3535
- github https://github.com/snakers4/silero-vad
3636
3737
## Examples
3838
3939
- Speech to Text
40-
- github: https://github.com/dora-rs/dora/blob/main/examples/speech-to-text
40+
- github: https://github.com/dora-rs/node-hub/blob/main/examples/speech-to-text
4141
- website: https://dora-rs.ai/docs/examples/stt
4242
4343
## License

examples/object-detection/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,6 @@ To run:
44

55
```bash
66
uv venv --seed -p 3.11
7-
dora build https://raw.githubusercontent.com/dora-rs/dora/refs/heads/main/examples/object-detection/yolo.yml --uv
7+
dora build https://raw.githubusercontent.com/dora-rs/node-hub/refs/heads/main/examples/object-detection/yolo.yml --uv
88
dora run yolo.yml --uv
99
```

examples/vlm/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,6 @@ dora run qwen2-5-vl-vision-only-dev.yml --uv
1414

1515
```bash
1616
uv venv -p 3.11 --seed
17-
dora build https://raw.githubusercontent.com/dora-rs/dora/main/examples/vlm/qwenvl.yml --uv
18-
dora run https://raw.githubusercontent.com/dora-rs/dora/main/examples/vlm/qwenvl.yml --uv
17+
dora build https://raw.githubusercontent.com/dora-rs/node-hub/main/examples/vlm/qwenvl.yml --uv
18+
dora run https://raw.githubusercontent.com/dora-rs/node-hub/main/examples/vlm/qwenvl.yml --uv
1919
```

0 commit comments

Comments
 (0)