You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
Commit 5b55efd
Browse filesBrowse the repository at this point in the historyBrowse files
@@ -23,7 +25,7 @@ We also provide two tools to support robot model development:
23
25
24
26
---
25
27
26
-
## Quick Start
28
+
## 🚀 Quick Start
27
29
28
30
```bash
29
31
git clone https://github.com/Robot-cpp/robot.cpp
@@ -37,7 +39,7 @@ This section introduces three usage paths to help you quickly understand the rep
37
39
* Using `model-server` in a simulation platform, using LIBERO as the example.
38
40
* Using `model-server` on a real robot, using SO-101 as the example.
39
41
40
-
### Start model-server and connect a dummy client
42
+
### 🔌 Start model-server and connect a dummy client
41
43
42
44
We use SmolVLA GGUF files as the example for starting `model-server`.
43
45
@@ -111,17 +113,17 @@ Then run:
111
113
bash robot_client/shell/cpp_client_example.sh
112
114
```
113
115
114
-
### Using model-server in simulation, using LIBERO as the example
116
+
### 🧪 Using model-server in simulation, using LIBERO as the example
115
117
116
118
See the [LIBERO simulation evaluation guide](eval/libero/README.md).
117
119
118
-
### Using model-server on real hardware, using SO-101 as the example
120
+
### 🦾 Using model-server on real hardware, using SO-101 as the example
119
121
120
122
See the [SO-101 deployment guide](eval/lerobot_so101/README.md). A video tutorial is also planned (bilibili link).
121
123
122
124
---
123
125
124
-
## Performance
126
+
## ⚡ Performance
125
127
126
128
We benchmark Robot.cpp on several platforms. Each measurement uses 5 warmup runs and 100 loop runs. The reported latency is the average time from receiving the image, through preprocessing and forward inference, to producing a usable action chunk, measured in milliseconds. All state projectors remain in f32 precision.
127
129
@@ -142,7 +144,7 @@ For SmolVLA preprocessing, we follow the official default setting: images are fi
142
144
143
145
---
144
146
145
-
## Model Zoo
147
+
## 🧩 Model Zoo
146
148
147
149
This section lists converted GGUF models that can be used directly with `model-server` for smoke tests and quick starts. For your own real-world scenarios, we recommend using [`hf2gguf`](tools/hf2gguf/README.md) to generate your own GGUF models. Different components can also use different precisions; in practice, the best precision choice is often component-specific. In our examples, the state projector always stays in f32, while the other GGUF files follow the listed precision. You can mix and match them to explore better accuracy/performance tradeoffs.
148
150
@@ -157,7 +159,7 @@ This section lists converted GGUF models that can be used directly with `model-s
157
159
158
160
---
159
161
160
-
## Repository Layout
162
+
## 🗂️ Repository Layout
161
163
162
164
Key directories:
163
165
@@ -199,7 +201,7 @@ robot.cpp/
199
201
200
202
---
201
203
202
-
## Extension and Contribution
204
+
## 🌱 Extension and Contribution
203
205
204
206
Robot.cpp welcomes community contributions for new model runtimes, platform adapters, evaluation flows, model conversion tools, and performance optimization. We aim to keep the core inference framework lightweight, cross-platform, and easy to reproduce, while allowing different robot models and platforms to connect through a unified interface.
205
207
@@ -212,15 +214,15 @@ Issues and PRs are welcome. For larger model-architecture changes, protocol chan
212
214
213
215
---
214
216
215
-
## License
217
+
## 📄 License
216
218
217
219
Robot.cpp source code is released under the Apache License, Version 2.0. See [LICENSE](LICENSE) for the full license text.
218
220
219
221
This repository also includes third-party open-source components, each under its own license. See the license files under `third_party/` for details.
220
222
221
223
---
222
224
223
-
## Acknowledgements
225
+
## 🙏 Acknowledgements
224
226
225
227
Robot.cpp's design and implementation benefit from several excellent open-source projects:
0 commit comments