clean

Author: lxsy-xcy

.gitignore

@@ -25,3 +25,4 @@ checkpoints/
 .vscode/
 
 local_*
+.DS_Store

README.md

@@ -9,7 +9,7 @@
 <h3 align="center">Run your robot model on any device, easily.</h3>
 
 <p align="center">
-  <strong>English</strong> | <a href="README_zh.md">简体中文</a>
+  <strong>English</strong> | <a href="README_ZH.md">简体中文</a>
 </p>
 
 <p align="center">
@@ -73,7 +73,7 @@ There are two ways to start `model-server`.
 
 ##### Option 1: Download a prebuilt binary
 
-For several platforms and configurations, we provide prebuilt `model-server` binaries on the release page.
+For several platforms and configurations, we provide prebuilt `model-server` binaries on the [release page](https://github.com/Robot-cpp/robot.cpp/releases/latest).
 
 After downloading, run `model-server` like this:
 
@@ -227,7 +227,7 @@ Robot.cpp welcomes community contributions for new model runtimes, platform adap
 
 If you want to extend this project, start with these documents:
 
-* [How to add a new model](src/readme.md)
+* [How to add a new model](src/README.md)
 * How to add a new platform: [real robot](eval/README.md), [simulation](eval/HOW_TO_ADD_NEW_SIM.md).
 
 Issues and PRs are welcome. For larger model-architecture changes, protocol changes, or platform abstraction changes, we recommend opening an issue first to align on the interface boundary.

README_zh.md

@@ -29,7 +29,7 @@
 
 Robot.cpp是一个轻量化的on-device机器人模型推理框架，在llama.cpp的基础上进行开发，继承了其零依赖、轻量化的哲学，无需python相关的依赖配置，即可完成机器人模型推理，这使得其在跨平台尤其是环境配置复杂的边缘设备上具有优势。
 
-具体而言，robot.cpp最核心的概念是 [`model-server`](robot_server/README_zh.md)，其为最主要的统一模型接口。在实际工作，仅需要启动 `model-server`，其会监听机器人发送的推理请求，即接受机器人传来的observation，在下层model进行forward计算，返回model生成的action。整体通信设计上为了轻量化零依赖采用手写TCP协议的方式。
+具体而言，robot.cpp最核心的概念是 [`model-server`](robot_server/README_ZH.md)，其为最主要的统一模型接口。在实际工作，仅需要启动 `model-server`，其会监听机器人发送的推理请求，即接受机器人传来的observation，在下层model进行forward计算，返回model生成的action。整体通信设计上为了轻量化零依赖采用手写TCP协议的方式。
 
 对于如何在机器人上使用，我们亦都提供了一些示例，分别提供了libero和低成本的SO-101的示例作为仿真与真机的使用模板。具体而言，我们采用以下概念组织：
 
@@ -40,8 +40,8 @@ Robot.cpp是一个轻量化的on-device机器人模型推理框架，在llama.cp
 
 工具上，我们亦都提供了两种工具帮助更好地对机器人模型进行开发：
 
-* [`hf2gguf`](tools/hf2gguf/README_zh.md)：用来将safetensor格式的checkpoint转化成项目所需的gguf格式。
-* [`quant`](tools/quant/README_zh.md)：对模型的任意tensor族群进行选择性quant的工具，用户仅需要调整yaml进行需求配置即可完成量化gguf的生成。
+* [`hf2gguf`](tools/hf2gguf/README_ZH.md)：用来将safetensor格式的checkpoint转化成项目所需的gguf格式。
+* [`quant`](tools/quant/README_ZH.md)：对模型的任意tensor族群进行选择性quant的工具，用户仅需要调整yaml进行需求配置即可完成量化gguf的生成。
 
 ---
 
@@ -73,7 +73,7 @@ git submodule update --init --recursive
 
 ##### 方法1：直接下载
 
-对于特定的一些平台与设定，我们已经预编译了一些`model-server`的二进制文件，可以直接在release page下载下来直接用。
+对于特定的一些平台与设定，我们已经预编译了一些`model-server`的二进制文件，可以直接在 [release page](https://github.com/Robot-cpp/robot.cpp/releases/latest) 下载下来直接用。
 
 下载之后，可以直接用下面的方式运行`model-server`：
 
@@ -90,7 +90,7 @@ git submodule update --init --recursive
 
 ##### 方法2：本地编译
 
-对于更加一般的情况，我们也提供了三个平台的开箱即用编译+启动的shell，可以通过修改shell里的环境变量，或者直接export的形式来快速在本机实现启动。详情参见 [robot_server/README_zh.md](robot_server/README_zh.md)
+对于更加一般的情况，我们也提供了三个平台的开箱即用编译+启动的shell，可以通过修改shell里的环境变量，或者直接export的形式来快速在本机实现启动。详情参见 [robot_server/README_ZH.md](robot_server/README_ZH.md)
 
 | Backend | macOS                                                   | Linux                                                    | Windows                                                     |
 | ------- | ------------------------------------------------------- | -------------------------------------------------------- | ----------------------------------------------------------- |
@@ -135,11 +135,11 @@ bash robot_client/shell/cpp_client_example.sh
 
 ### 🧪 model-server在仿真平台上的使用（以LIBERO为例）
 
-详见 [LIBERO 仿真评测说明](eval/libero/README_zh.md)。
+详见 [LIBERO 仿真评测说明](eval/libero/README_ZH.md)。
 
 ### 🦾 model-server在真机平台上的使用（以SO-101为例）
 
-详见 [SO101部署说明](eval/lerobot_so101/README_zh.md)。亦可参考视频教程（bilibili link）
+详见 [SO101部署说明](eval/lerobot_so101/README_ZH.md)。亦可参考视频教程（bilibili link）
 
 ---
 
@@ -166,7 +166,7 @@ bash robot_client/shell/cpp_client_example.sh
 
 ## 🧩 model-zoo
 
-这里整理一些已经转换好的 GGUF 模型，可以直接配合 `model-server` 做smoke test，以方便quick start！但针对自己的实际场景，我们推荐使用[hf2gguf](tools/hf2gguf/README_zh.md)l来生成自己的GGUF model！并且对于不同的部分，您还可以自定义不同的精度，来实现不同部分的精度组合（事实上，不同部分的最优精度通常是不同的），我们的例子中，state proj始终保持f32精度，其他的gguf随着precision精度变化而变化，您可以自行组合，探索更好更高效的性能tradeoff！
+这里整理一些已经转换好的 GGUF 模型，可以直接配合 `model-server` 做smoke test，以方便quick start！但针对自己的实际场景，我们推荐使用[hf2gguf](tools/hf2gguf/README_ZH.md)l来生成自己的GGUF model！并且对于不同的部分，您还可以自定义不同的精度，来实现不同部分的精度组合（事实上，不同部分的最优精度通常是不同的），我们的例子中，state proj始终保持f32精度，其他的gguf随着precision精度变化而变化，您可以自行组合，探索更好更高效的性能tradeoff！
 
 | Model   | Benchmark | Precision | Link                                                                    |
 | ------- | --------- | --------- | ----------------------------------------------------------------------- |
@@ -227,8 +227,8 @@ robot.cpp 欢迎社区贡献新的模型 runtime、平台适配、评测流程
 
 如果你希望扩展本项目，可以先阅读以下文档：
 
-* [如何新增一个新的模型](src/readme_zh.md)
-* 如何接入一个新的平台：[真机](eval/readme_zh.md)、[仿真](eval/HOW_TO_ADD_NEW_SIM_zh.md)。
+* [如何新增一个新的模型](src/README_ZH.md)
+* 如何接入一个新的平台：[真机](eval/README_ZH.md)、[仿真](eval/HOW_TO_ADD_NEW_SIM_ZH.md)。
 
 欢迎通过 issue 讨论设计，也欢迎提交 PR。对于较大的模型结构、协议变更或平台抽象调整，建议先开 issue 对齐接口边界。
 

eval/README.md

@@ -1,6 +1,6 @@
 # eval/ Platform Integration Guide
 
-[中文](eval/README_zh.md)
+[中文](README_ZH.md)
 
 The `eval/` directory holds **end-to-end evaluation and closed-loop control examples** for robot.cpp on specific robots or simulators. This code does not run model inference itself—that is handled by [`model-server`](../robot_server/README.md). `eval/` wires each platform’s observation capture, action execution, and (optionally) benchmark workflows.
 
@@ -27,8 +27,8 @@ eval/
 
 | Directory | Scenario | Notes |
 |---|---|---|
-| [`libero/`](libero/README.md) | Sim eval | LIBERO benchmark with C++ policy rollout and LeRobot baseline. [中文](libero/README_zh.md) |
-| [`lerobot_so101/`](lerobot_so101/README.md) | Real robot | SO-101 follower + single-camera observe → predict → act loop. [中文](lerobot_so101/README_zh.md) |
+| [`libero/`](libero/README.md) | Sim eval | LIBERO benchmark with C++ policy rollout and LeRobot baseline. [中文](libero/README_ZH.md) |
+| [`lerobot_so101/`](lerobot_so101/README.md) | Real robot | SO-101 follower + single-camera observe → predict → act loop. [中文](lerobot_so101/README_ZH.md) |
 
 The two examples are organized slightly differently:
 
@@ -224,8 +224,8 @@ LIBERO’s [`ModelServerPolicy`](libero/policy/model_server.py) is an example of
 
 ## Related docs
 
-- [SO-101 real-robot guide](lerobot_so101/README.md) · [中文](lerobot_so101/README_zh.md)
-- [LIBERO sim eval](libero/README.md) · [中文](libero/README_zh.md)
+- [SO-101 real-robot guide](lerobot_so101/README.md) · [中文](lerobot_so101/README_ZH.md)
+- [LIBERO sim eval](libero/README.md) · [中文](libero/README_ZH.md)
 - [robot_server launch and protocol](../robot_server/README.md)
 - [robot_client and policy](../robot_client/README.md)
-- [Adding a new model runtime](../src/readme_zh.md)
+- [Adding a new model runtime](../src/README.md)

eval/lerobot_so101/README.md

@@ -1,6 +1,6 @@
 # LeRobot SO101
 
-[中文](eval\lerobot_so101\README_zh.md)
+[中文](README_ZH.md)
 
 This directory provides a real-robot synchronous control example for the
 LeRobot SO101 platform.

eval/lerobot_so101/README_zh.md

@@ -1,6 +1,6 @@
 # LeRobot SO101
 
-[English](eval\lerobot_so101\README.md)
+[English](README.md)
 
 这个目录提供一个 LeRobot SO101 Platform 的真机同步控制示例。
 
@@ -115,7 +115,7 @@ bash eval/lerobot_so101/shell/run_robot_client.sh
 - `R`：清空 action queue，机械臂移动回启动时记录的 home pose
 - `Q`：退出同步控制循环
 
-如果相机出现错误，可以使用如下方法进行测试（RealSense 配置详见 [test/README_zh.md](test/README_zh.md)）：
+如果相机出现错误，可以使用如下方法进行测试（RealSense 配置详见 [test/README_ZH.md](test/README_ZH.md)）：
 
 ```bash
 cd eval/lerobot_so101
@@ -154,4 +154,3 @@ SO101Platform.get_observation()
   -> BasePolicy.select_action()
   -> SO101Platform.send_action()
 ```
-

eval/lerobot_so101/test/README.md

@@ -1,6 +1,6 @@
 # Camera Test & RealSense Setup
 
-[中文](README_zh.md)
+[中文](README_ZH.md)
 
 This directory provides **camera smoke tests** before running the SO-101 real-robot client. It shares the same `so101_env` configuration as `shell/run_robot_client.*`.
 
@@ -208,4 +208,4 @@ python eval/lerobot_so101/shell/build_robot_cameras.py
 - [ ] `run_camera_test` prints 224×224 frames
 - [ ] `MODEL_IMAGE_NAME` matches the model checkpoint
 
-See [../README_zh.md](../README_zh.md) for the full SO-101 real-robot workflow.
+See [../README_ZH.md](../README_ZH.md) for the full SO-101 real-robot workflow.

eval/lerobot_so101/test/README_zh.md

@@ -223,4 +223,4 @@ python eval/lerobot_so101/shell/build_robot_cameras.py
 - [ ] `run_camera_test` 输出 224×224 帧
 - [ ] `MODEL_IMAGE_NAME` 与模型 checkpoint 一致
 
-更多 SO-101 真机流程见 [../README_zh.md](../README_zh.md)。
+更多 SO-101 真机流程见 [../README_ZH.md](../README_ZH.md)。

eval/libero/README.md

@@ -1,6 +1,6 @@
 # LIBERO Eval
 
-[中文文档](README_zh.md)
+[中文文档](README_ZH.md)
 
 This directory provides LIBERO simulation eval and latency scripts for two
 policy paths:

eval/readme_zh.md

@@ -1,10 +1,10 @@
 # eval/ 平台接入指南
 
-[English](eval/README.md)
+[English](README.md)
 
-`eval/` 目录存放 **robot.cpp 在具体机器人或仿真环境上的评测与闭环控制示例**。这里的代码不负责模型推理本身，推理由 `[model-server](../robot_server/README_zh.md)` 完成。`eval/` 只负责把各平台的 observation 采集、action 下发，以及benchmark 流程串起来。
+`eval/` 目录存放 **robot.cpp 在具体机器人或仿真环境上的评测与闭环控制示例**。这里的代码不负责模型推理本身，推理由 `[model-server](../robot_server/README_ZH.md)` 完成。`eval/` 只负责把各平台的 observation 采集、action 下发，以及benchmark 流程串起来。
 
-仓库根目录的 [README_zh.md](../README_zh.md) 介绍了整体三层抽象：
+仓库根目录的 [README_ZH.md](../README_ZH.md) 介绍了整体三层抽象：
 
 
 | 层              | 职责                                                    | 代码位置                                       |
@@ -30,8 +30,8 @@ eval/
 
 | 目录                                             | 场景   | 说明                                                                                         |
 | ---------------------------------------------- | ---- | ------------------------------------------------------------------------------------------ |
-| `[libero/](libero/README_zh.md)`               | 仿真评测 | 面向 LIBERO benchmark，含 C++ policy rollout 与 LeRobot baseline 对比。[English](libero/README.md) |
-| `[lerobot_so101/](lerobot_so101/README_zh.md)` | 真机闭环 | SO-101 follower + 单相机的 observe → predict → act 同步控制。[English](lerobot_so101/README.md)     |
+| `[libero/](libero/README_ZH.md)`               | 仿真评测 | 面向 LIBERO benchmark，含 C++ policy rollout 与 LeRobot baseline 对比。[English](libero/README.md) |
+| `[lerobot_so101/](lerobot_so101/README_ZH.md)` | 真机闭环 | SO-101 follower + 单相机的 observe → predict → act 同步控制。[English](lerobot_so101/README.md)     |
 
 
 两类示例的组织方式略有不同：
@@ -64,7 +64,7 @@ Platform.send_action()         # 下发到机器人
 
 ## 如何新增一个 Platform
 
-以下步骤以新增真机 platform 为主。若接入的是仿真 benchmark，可参考 `[eval/libero/](libero/README_zh.md)` 自行组织 runner 与 policy adapter。
+以下步骤以新增真机 platform 为主。若接入的是仿真 benchmark，可参考 `[eval/libero/](libero/README_ZH.md)` 自行组织 runner 与 policy adapter。
 
 ### step1：创建目录
 
@@ -207,7 +207,7 @@ strings ckpts/<gguf_dir>/mmproj-smolvla-f32.gguf | rg "observation\.images\."
 
 ### step6：启动与验证
 
-1. 启动 model-server（见 [robot_server/README_zh.md](../robot_server/README_zh.md)）。
+1. 启动 model-server（见 [robot_server/README_ZH.md](../robot_server/README_ZH.md)）。
 2. 运行 platform client shell。
 3. 先用 server 延迟脚本确认 server 正常。
 4. 再跑真机 / 仿真闭环；观察 server 终端是否有 `[SmolVLA] Error:` 等报错。
@@ -232,9 +232,8 @@ LIBERO 的 `[ModelServerPolicy](libero/policy/model_server.py)` 即为自定义
 
 ## 相关文档
 
-- [SO-101 真机使用说明](lerobot_so101/README_zh.md)
-- [LIBERO 仿真评测说明](libero/README_zh.md)
-- [robot_server 启动与协议](../robot_server/README_zh.md)
+- [SO-101 真机使用说明](lerobot_so101/README_ZH.md)
+- [LIBERO 仿真评测说明](libero/README_ZH.md)
+- [robot_server 启动与协议](../robot_server/README_ZH.md)
 - [robot_client 与 policy](../robot_client/README.md)
-- [新增模型 runtime](../src/readme_zh.md)
-
+- [新增模型 runtime](../src/README_ZH.md)