xuniren 项目安装与使用指南

1. 项目目录结构及介绍

xuniren/
├── data/
│   ├── kf.json
│   ├── pretrained/
│   │   └── ngp_kf.pth
├── freqencoder/
├── gridencoder/
├── img/
├── nerf/
├── raymarching/
├── scripts/
├── shencoder/
├── LICENSE
├── README.md
├── WebSocket.md
├── activation.py
├── app.py
├── encoding.py
├── environment.yml
├── fay_connect.py
├── requirements.txt
├── stream_cache.py
├── test.html
├── tools.py
└── video_stream.py

目录结构说明

• data/: 存放项目所需的数据文件，包括配置文件 kf.json 和预训练模型 ngp_kf.pth。
• freqencoder/, gridencoder/, nerf/, raymarching/, shencoder/: 这些目录包含了项目中使用的各种编码器和神经辐射场（NeRF）相关的代码。
• scripts/: 存放项目的脚本文件，用于安装扩展模块等。
• LICENSE: 项目的开源许可证文件。
• README.md: 项目的介绍文档。
• WebSocket.md: WebSocket 接口的说明文档。
• activation.py, encoding.py, tools.py: 项目中使用的各种工具和编码相关的 Python 文件。
• app.py: 项目的启动文件。
• environment.yml: 项目的 Conda 环境配置文件。
• fay_connect.py: 用于与 Fay 对接的脚本。
• requirements.txt: 项目的依赖包列表。
• stream_cache.py, video_stream.py: 与视频流处理相关的 Python 文件。
• test.html: 测试文件。

2. 项目启动文件介绍

app.py

app.py 是 xuniren 项目的启动文件。通过运行该文件，可以启动虚拟人生成器。

python app.py start

该命令将启动虚拟人生成器，并对接 Fay 系统。在 Ubuntu 20.04 及 Windows 10 下完成测试。

fay_connect.py

fay_connect.py 是用于与 Fay 对接的脚本。在环境配置完成后，可以直接运行该脚本，无需启动 app.py。

python fay_connect.py

3. 项目的配置文件介绍

environment.yml

environment.yml 是项目的 Conda 环境配置文件。该文件定义了项目所需的 Python 版本和依赖包。

name: xuniren
channels:
  - pytorch
  - nvidia
  - defaults
dependencies:
  - python=3.9
  - pytorch=1.13.0
  - torchvision
  - pytorch-cuda=11.6
  - pip:
    - -r requirements.txt

requirements.txt

requirements.txt 列出了项目所需的所有 Python 依赖包。

numpy
torch
torchvision
torchaudio
pytorch3d
...

data/kf.json

kf.json 是项目的配置文件之一，包含了虚拟人生成器的配置参数。

data/pretrained/ngp_kf.pth

ngp_kf.pth 是预训练的神经辐射场（NeRF）模型文件，用于虚拟人生成。

总结

本文档介绍了 xuniren 项目的目录结构、启动文件和配置文件。通过阅读本文档，用户可以了解如何启动项目以及项目的配置方式。