Shifu 项目教程

Shifu 项目教程

shifu 项目地址: https://gitcode.com/gh_mirrors/shif/shifu

1. 项目目录结构及介绍

Shifu 项目的目录结构如下：

shifu/
├── asset/
│   └── urdf/
├── docs/
│   └── images/
├── examples/
├── licenses/
├── scripts/
├── shifu/
├── .gitignore
├── LICENSE
├── README.md
├── requirements.txt
└── setup.py

目录介绍

• asset/: 存放项目的资源文件，如 URDF 文件。
• docs/: 存放项目的文档文件，包括图片等。
• examples/: 存放项目的示例代码。
• licenses/: 存放项目的许可证文件。
• scripts/: 存放项目的脚本文件。
• shifu/: 项目的主要代码目录。
• .gitignore: Git 忽略文件配置。
• LICENSE: 项目的许可证文件。
• README.md: 项目的介绍文件。
• requirements.txt: 项目的依赖文件。
• setup.py: 项目的安装脚本。

2. 项目启动文件介绍

Shifu 项目的启动文件主要位于 examples/ 目录下。以下是一些示例启动文件的介绍：

• a1_conditional.py: 用于训练四足机器人 A1 在复杂地形上行走的示例。
• abb_pushbox_vision.py: 用于训练机械臂 ABB 通过视觉观察推动方块到目标位置的示例。

启动示例

以 a1_conditional.py 为例，启动训练的命令如下：

python -m examples.a1_conditional.a1_conditional -r train

启动播放的命令如下：

python -m examples.a1_conditional.a1_control_panel

3. 项目的配置文件介绍

Shifu 项目的配置文件主要包括 requirements.txt 和 setup.py。

requirements.txt

requirements.txt 文件列出了项目运行所需的 Python 依赖包。可以通过以下命令安装这些依赖：

pip install -r requirements.txt -f https://download.pytorch.org/whl/cu113/torch_stable.html

setup.py

setup.py 文件用于项目的安装和打包。可以通过以下命令安装项目：

pip install -e .

这个命令会在当前环境中安装 Shifu 项目，并使其可编辑。

shifu 项目地址: https://gitcode.com/gh_mirrors/shif/shifu