ndf_robot 项目使用教程

ndf_robot 项目使用教程

ndf_robot Implementation of the method proposed in the paper "Neural Descriptor Fields: SE(3)-Equivariant Object Representations for Manipulation" 项目地址: https://gitcode.com/gh_mirrors/nd/ndf_robot

1. 项目的目录结构及介绍

ndf_robot/
├── doc/
│   └── dataset.md
├── scripts/
│   ├── download_demo_data.sh
│   ├── download_demo_weights.sh
│   ├── download_training_data.sh
│   └── ...
├── src/
│   └── ndf_robot/
│       ├── eval/
│       │   ├── ndf_alignment.py
│       │   └── ndf_demo.py
│       ├── opt/
│       │   └── optimizer.py
│       ├── training/
│       │   └── train_vnn_occupancy_net.py
│       └── ...
├── .gitmodules
├── LICENSE.md
├── README.md
├── ndf_env.sh
├── requirements.txt
└── setup.py

目录结构介绍

• doc/: 包含项目的文档文件，如 dataset.md。
• scripts/: 包含用于下载数据和预训练权重的脚本。
• src/ndf_robot/: 项目的主要代码目录，包含评估、优化、训练等模块。
  • eval/: 包含用于评估的脚本，如 ndf_demo.py 和 ndf_alignment.py。
  • opt/: 包含优化相关的脚本，如 optimizer.py。
  • training/: 包含训练相关的脚本，如 train_vnn_occupancy_net.py。
• .gitmodules: Git 子模块配置文件。
• LICENSE.md: 项目许可证文件。
• README.md: 项目介绍和使用说明。
• ndf_env.sh: 环境变量配置脚本。
• requirements.txt: 项目依赖库列表。
• setup.py: 项目安装脚本。

2. 项目的启动文件介绍

启动文件

• ndf_demo.py: 这是项目的启动文件之一，位于 src/ndf_robot/eval/ 目录下。它用于运行一个快速演示，展示如何使用预训练的神经描述符场（NDF）模型来恢复不同形状和姿态的对象之间的对应关系。

使用方法

1. 下载预训练权重和数据资产：

   ./scripts/download_demo_weights.sh
   ./scripts/download_demo_data.sh
   

2. 运行启动文件：

   cd src/ndf_robot/eval
   python ndf_demo.py
   

3. 项目的配置文件介绍

配置文件

• ndf_env.sh: 这是一个环境变量配置脚本，需要在每次运行项目代码时进行源引用。它设置了项目所需的环境变量。

使用方法

在每次启动项目之前，运行以下命令以设置环境变量：

source ndf_env.sh

其他配置文件

• requirements.txt: 列出了项目所需的所有 Python 依赖库。可以使用以下命令安装这些依赖：

  pip install -r requirements.txt
  

• setup.py: 用于安装项目的脚本。可以使用以下命令进行安装：

  python setup.py install
  

通过以上步骤，您可以顺利地启动和配置 ndf_robot 项目，并开始使用其功能。

ndf_robot Implementation of the method proposed in the paper "Neural Descriptor Fields: SE(3)-Equivariant Object Representations for Manipulation" 项目地址: https://gitcode.com/gh_mirrors/nd/ndf_robot