Skip to content

Commit 5b55efd

Browse files
committed
doc
1 parent 9749c8e commit 5b55efd

2 files changed

Lines changed: 18 additions & 12 deletions

File tree

‎README.md‎

Lines changed: 14 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
1-
# Robot.cpp
1+
<p align="right">
2+
<strong>English</strong> | <a href="README_zh.md">简体中文</a>
3+
</p>
24

3-
[中文](README_zh.md)
5+
# 🤖 Robot.cpp
46

57
[Demo placeholder]
68

@@ -23,7 +25,7 @@ We also provide two tools to support robot model development:
2325

2426
---
2527

26-
## Quick Start
28+
## 🚀 Quick Start
2729

2830
```bash
2931
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
3739
* Using `model-server` in a simulation platform, using LIBERO as the example.
3840
* Using `model-server` on a real robot, using SO-101 as the example.
3941

40-
### Start model-server and connect a dummy client
42+
### 🔌 Start model-server and connect a dummy client
4143

4244
We use SmolVLA GGUF files as the example for starting `model-server`.
4345

@@ -111,17 +113,17 @@ Then run:
111113
bash robot_client/shell/cpp_client_example.sh
112114
```
113115

114-
### Using model-server in simulation, using LIBERO as the example
116+
### 🧪 Using model-server in simulation, using LIBERO as the example
115117

116118
See the [LIBERO simulation evaluation guide](eval/libero/README.md).
117119

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
119121

120122
See the [SO-101 deployment guide](eval/lerobot_so101/README.md). A video tutorial is also planned (bilibili link).
121123

122124
---
123125

124-
## Performance
126+
## ⚡ Performance
125127

126128
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.
127129

@@ -142,7 +144,7 @@ For SmolVLA preprocessing, we follow the official default setting: images are fi
142144
143145
---
144146

145-
## Model Zoo
147+
## 🧩 Model Zoo
146148

147149
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.
148150

@@ -157,7 +159,7 @@ This section lists converted GGUF models that can be used directly with `model-s
157159

158160
---
159161

160-
## Repository Layout
162+
## 🗂️ Repository Layout
161163

162164
Key directories:
163165

@@ -199,7 +201,7 @@ robot.cpp/
199201

200202
---
201203

202-
## Extension and Contribution
204+
## 🌱 Extension and Contribution
203205

204206
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.
205207

@@ -212,15 +214,15 @@ Issues and PRs are welcome. For larger model-architecture changes, protocol chan
212214

213215
---
214216

215-
## License
217+
## 📄 License
216218

217219
Robot.cpp source code is released under the Apache License, Version 2.0. See [LICENSE](LICENSE) for the full license text.
218220

219221
This repository also includes third-party open-source components, each under its own license. See the license files under `third_party/` for details.
220222

221223
---
222224

223-
## Acknowledgements
225+
## 🙏 Acknowledgements
224226

225227
Robot.cpp's design and implementation benefit from several excellent open-source projects:
226228

‎README_zh.md‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
<p align="right">
2+
<a href="README.md">English</a> | <strong>简体中文</strong>
3+
</p>
4+
15
# 🤖 Robot.cpp
26

37
【demo 位置】

0 commit comments

Comments
 (0)