depthEmMind commited on
Commit
4e47765
·
verified ·
1 Parent(s): 20595cc

Upload folder using huggingface_hub

Browse files
Files changed (2) hide show
  1. README.md +43 -11
  2. README_zh.md +43 -11
README.md CHANGED
@@ -99,7 +99,7 @@ Typical usage: **robots** and **objects** can be placed into **scenes**; a robot
99
  | **UniEMind-Assets** | Metadata, Schema, Registry, validation & CLI | [github.com/depthEmMind/UniEMind-Assets](https://github.com/depthEmMind/UniEMind-Assets) |
100
  | **UniEMindAssets** *(this HF dataset)* | Binary asset pack download / distribution | [huggingface.co/depthEmMind/UniEMindAssets](https://huggingface.co/depthEmMind/UniEMindAssets) |
101
  | **UniEMind-Sim** | Virtual arena: load assets, drive MuJoCo / Isaac | [github.com/depthEmMind/UniEMind-Sim](https://github.com/depthEmMind/UniEMind-Sim) |
102
- | **UniEMind-Hardware** | Real arena: physical robots / sensors | [github.com/depthEmMind/UniEMind-Hardware](https://github.com/depthEmMind/UniEMind-Hardware) |
103
  | **UniEMind-Datasets** | Exam items / GT | [github.com/depthEmMind/UniEMind-Datasets](https://github.com/depthEmMind/UniEMind-Datasets) |
104
  | **UniEMind-Bench** | Evaluation / ranking | [github.com/depthEmMind/UniEMind-Bench](https://github.com/depthEmMind/UniEMind-Bench) |
105
 
@@ -146,7 +146,14 @@ Typical usage: **robots** and **objects** can be placed into **scenes**; a robot
146
 
147
  ## Quick start
148
 
149
- ### Download
 
 
 
 
 
 
 
150
 
151
  ```bash
152
  # huggingface-cli
@@ -154,22 +161,47 @@ huggingface-cli download depthEmMind/UniEMindAssets --local-dir ./UniEMindAssets
154
 
155
  # or git (Git LFS recommended for large files)
156
  git lfs install
157
- git clone https://huggingface.co/depthEmMind/UniEMindAssets
158
  ```
159
 
160
- ### Use with UniEMind-Sim
161
 
162
- After installing UniEMind-Sim, point the asset root at this repository (or copy assets into the matching directories under UniEMind-Assets):
163
 
164
  ```bash
165
- unimind-sim install uniemind-assets --source /path/to/UniEMindAssets
166
- unimind-sim scenes list
167
- unimind-sim robots list
168
- unimind-sim assets list
169
- unimind-sim run --scene <scene_id> --backend mujoco # or isaac
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
170
  ```
171
 
172
- Exact CLI flags follow your installed UniEMind-Sim version.
 
173
 
174
  ---
175
 
 
99
  | **UniEMind-Assets** | Metadata, Schema, Registry, validation & CLI | [github.com/depthEmMind/UniEMind-Assets](https://github.com/depthEmMind/UniEMind-Assets) |
100
  | **UniEMindAssets** *(this HF dataset)* | Binary asset pack download / distribution | [huggingface.co/depthEmMind/UniEMindAssets](https://huggingface.co/depthEmMind/UniEMindAssets) |
101
  | **UniEMind-Sim** | Virtual arena: load assets, drive MuJoCo / Isaac | [github.com/depthEmMind/UniEMind-Sim](https://github.com/depthEmMind/UniEMind-Sim) |
102
+ | **UniEMind-Hardware** | Hardware catalog, specs, drivers, assembly | [github.com/depthEmMind/UniEMind-Hardware](https://github.com/depthEmMind/UniEMind-Hardware) |
103
  | **UniEMind-Datasets** | Exam items / GT | [github.com/depthEmMind/UniEMind-Datasets](https://github.com/depthEmMind/UniEMind-Datasets) |
104
  | **UniEMind-Bench** | Evaluation / ranking | [github.com/depthEmMind/UniEMind-Bench](https://github.com/depthEmMind/UniEMind-Bench) |
105
 
 
146
 
147
  ## Quick start
148
 
149
+ CLI tools live in the sibling Git repos (install into the shared `UniEMind` conda env):
150
+
151
+ | Command | Package | Role |
152
+ | --- | --- | --- |
153
+ | **`um-assets`** (alias `unimind-assets`) | [UniEMind-Assets](https://github.com/depthEmMind/UniEMind-Assets) | Download / sync this HF pack, registry, validate, list / remove |
154
+ | **`um-sim`** (alias `unimind-sim`) | [UniEMind-Sim](https://github.com/depthEmMind/UniEMind-Sim) | Install assets into the sim, list scenes / robots, run |
155
+
156
+ ### Download (huggingface-cli or git)
157
 
158
  ```bash
159
  # huggingface-cli
 
161
 
162
  # or git (Git LFS recommended for large files)
163
  git lfs install
164
+ git clone https://huggingface.co/datasets/depthEmMind/UniEMindAssets
165
  ```
166
 
167
+ ### Recommended: `um-assets hf` → UniEMind-Assets → `um-sim`
168
 
169
+ From a local [UniEMind-Assets](https://github.com/depthEmMind/UniEMind-Assets) checkout:
170
 
171
  ```bash
172
+ conda activate UniEMind
173
+ cd UniEMind-Assets
174
+ pip install --no-build-isolation -e ".[hf]"
175
+
176
+ # One-shot: download this HF dataset and sync into UniEMind-Assets/assets/
177
+ um-assets hf install --force
178
+
179
+ # Or download only, then sync (copy or symlink)
180
+ um-assets hf download --local-dir ~/data/UniEMindAssets
181
+ um-assets hf sync --source ~/data/UniEMindAssets --mode copy --force
182
+ # um-assets hf sync --source ~/data/UniEMindAssets --mode link --force
183
+
184
+ um-assets registry build
185
+ um-assets assets list
186
+ um-assets robots list
187
+ um-assets scenes list
188
+
189
+ # Remove a local package (interactive confirm; default N — type y to delete)
190
+ # um-assets assets remove <asset_id>
191
+ # um-assets robots remove <asset_id>
192
+ # um-assets scenes remove <asset_id>
193
+ # Scripts only: append -y to skip the prompt
194
+
195
+ # Hand-off to UniEMind-Sim
196
+ um-sim install uniemind-assets --source /path/to/UniEMind-Assets
197
+ um-sim assets list
198
+ um-sim robots list
199
+ um-sim scenes list
200
+ um-sim run --scene <scene_id> --backend mujoco # or isaac
201
  ```
202
 
203
+ Environment variables (optional): `UNIMIND_HF_ASSETS_REPO`, `UNIMIND_HF_ASSETS_DIR`, `UNIMIND_ASSETS_ROOT`.
204
+ Exact flags follow your installed UniEMind-Assets / UniEMind-Sim versions; see the UniEMind-Assets README for the full CLI.
205
 
206
  ---
207
 
README_zh.md CHANGED
@@ -99,7 +99,7 @@ UniEMindAssets/
99
  | **UniEMind-Assets** | Metadata、Schema、Registry、校验与 CLI | [github.com/depthEmMind/UniEMind-Assets](https://github.com/depthEmMind/UniEMind-Assets) |
100
  | **UniEMindAssets**(本 HF 数据集) | 二进制资产包下载分发 | [huggingface.co/depthEmMind/UniEMindAssets](https://huggingface.co/depthEmMind/UniEMindAssets) |
101
  | **UniEMind-Sim** | 虚拟考场:加载资产,驱动 MuJoCo / Isaac | [github.com/depthEmMind/UniEMind-Sim](https://github.com/depthEmMind/UniEMind-Sim) |
102
- | **UniEMind-Hardware** | 真实考场:真机传感器适配 | [github.com/depthEmMind/UniEMind-Hardware](https://github.com/depthEmMind/UniEMind-Hardware) |
103
  | **UniEMind-Datasets** | 题库 / GT | [github.com/depthEmMind/UniEMind-Datasets](https://github.com/depthEmMind/UniEMind-Datasets) |
104
  | **UniEMind-Bench** | 评测 / 排名 | [github.com/depthEmMind/UniEMind-Bench](https://github.com/depthEmMind/UniEMind-Bench) |
105
 
@@ -147,7 +147,14 @@ UniEMindAssets/
147
 
148
  ## 快速开始
149
 
150
- ### 下载
 
 
 
 
 
 
 
151
 
152
  ```bash
153
  # huggingface-cli
@@ -155,22 +162,47 @@ huggingface-cli download depthEmMind/UniEMindAssets --local-dir ./UniEMindAssets
155
 
156
  # 或使用 git(大文件建议启用 Git LFS)
157
  git lfs install
158
- git clone https://huggingface.co/depthEmMind/UniEMindAssets
159
  ```
160
 
161
- ### UniEMind-Sim 配合使用
162
 
163
- 安装 UniEMind-Sim 并将资产根目录指向本仓库(或将资产拷贝到 UniEMind-Assets 下的对应目录下)后
164
 
165
  ```bash
166
- unimind-sim install uniemind-assets --source /path/to/UniEMindAssets
167
- unimind-sim scenes list
168
- unimind-sim robots list
169
- unimind-sim assets list
170
- unimind-sim run --scene <scene_id> --backend mujoco # 或 isaac
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
171
  ```
172
 
173
- 具体参数以你安装的 UniEMind-Sim 版本文档为准
 
174
 
175
  ---
176
 
 
99
  | **UniEMind-Assets** | Metadata、Schema、Registry、校验与 CLI | [github.com/depthEmMind/UniEMind-Assets](https://github.com/depthEmMind/UniEMind-Assets) |
100
  | **UniEMindAssets**(本 HF 数据集) | 二进制资产包下载分发 | [huggingface.co/depthEmMind/UniEMindAssets](https://huggingface.co/depthEmMind/UniEMindAssets) |
101
  | **UniEMind-Sim** | 虚拟考场:加载资产,驱动 MuJoCo / Isaac | [github.com/depthEmMind/UniEMind-Sim](https://github.com/depthEmMind/UniEMind-Sim) |
102
+ | **UniEMind-Hardware** | 硬件目录、规格、驱动组装 | [github.com/depthEmMind/UniEMind-Hardware](https://github.com/depthEmMind/UniEMind-Hardware) |
103
  | **UniEMind-Datasets** | 题库 / GT | [github.com/depthEmMind/UniEMind-Datasets](https://github.com/depthEmMind/UniEMind-Datasets) |
104
  | **UniEMind-Bench** | 评测 / 排名 | [github.com/depthEmMind/UniEMind-Bench](https://github.com/depthEmMind/UniEMind-Bench) |
105
 
 
147
 
148
  ## 快速开始
149
 
150
+ 命令行工具在同生态 Git 仓库中(安装到共享 conda 环境 `UniEMind`):
151
+
152
+ | 命令 | 所属包 | 作用 |
153
+ | --- | --- | --- |
154
+ | **`um-assets`**(别名 `unimind-assets`) | [UniEMind-Assets](https://github.com/depthEmMind/UniEMind-Assets) | 下载 / 同步本 HF 包、registry、校验、列表 / 移除 |
155
+ | **`um-sim`**(别名 `unimind-sim`) | [UniEMind-Sim](https://github.com/depthEmMind/UniEMind-Sim) | 将资产装入仿真、列场景 / 机器人、运行 |
156
+
157
+ ### 下载(huggingface-cli 或 git)
158
 
159
  ```bash
160
  # huggingface-cli
 
162
 
163
  # 或使用 git(大文件建议启用 Git LFS)
164
  git lfs install
165
+ git clone https://huggingface.co/datasets/depthEmMind/UniEMindAssets
166
  ```
167
 
168
+ ### 推荐流程:`um-assets hf` → UniEMind-Assets → `um-sim`
169
 
170
+ 在本地 [UniEMind-Assets](https://github.com/depthEmMind/UniEMind-Assets) 仓库中
171
 
172
  ```bash
173
+ conda activate UniEMind
174
+ cd UniEMind-Assets
175
+ pip install --no-build-isolation -e ".[hf]"
176
+
177
+ # 一键:下载本 HF 数据集并同步到 UniEMind-Assets/assets/
178
+ um-assets hf install --force
179
+
180
+ # 或先下载,再同步(复制或符号链接)
181
+ um-assets hf download --local-dir ~/data/UniEMindAssets
182
+ um-assets hf sync --source ~/data/UniEMindAssets --mode copy --force
183
+ # um-assets hf sync --source ~/data/UniEMindAssets --mode link --force
184
+
185
+ um-assets registry build
186
+ um-assets assets list
187
+ um-assets robots list
188
+ um-assets scenes list
189
+
190
+ # 删除本地资源包(交互确认;默认 N —— 输入 y 才删除)
191
+ # um-assets assets remove <asset_id>
192
+ # um-assets robots remove <asset_id>
193
+ # um-assets scenes remove <asset_id>
194
+ # 仅脚本场景可加 -y 跳过确认
195
+
196
+ # 交给 UniEMind-Sim
197
+ um-sim install uniemind-assets --source /path/to/UniEMind-Assets
198
+ um-sim assets list
199
+ um-sim robots list
200
+ um-sim scenes list
201
+ um-sim run --scene <scene_id> --backend mujoco # 或 isaac
202
  ```
203
 
204
+ 可选环境变量:`UNIMIND_HF_ASSETS_REPO`、`UNIMIND_HF_ASSETS_DIR`、`UNIMIND_ASSETS_ROOT`
205
+ 具体参数以已安装的 UniEMind-Assets / UniEMind-Sim 版本为准;完整 CLI 见 UniEMind-Assets README。
206
 
207
  ---
208