Skip to content

Latest commit

 

History

History
143 lines (111 loc) · 7.13 KB

installation.md

File metadata and controls

143 lines (111 loc) · 7.13 KB

安装

本文档提供了安装 XRNeRF 的相关步骤。

安装依赖包

  • Linux
  • Python 3.7+
  • PyTorch 1.10+ (低版本可能无法支持)
  • CUDA 11.0+ (低版本可能无法支持)
  • GCC 7.5+
  • build-essential: Install by apt-get install -y build-essential git ninja-build ffmpeg libsm6 libxext6 libgl1
  • mmcv-full
  • Numpy
  • ffmpeg
  • opencv-python 3+: 可通过 pip install opencv-python>=3 安装
  • imageio: 可通过 pip install imageio 安装
  • scikit-image: 可通过 pip install scikit-image 安装
  • lpips: 可通过 pip install lpips 安装
  • trimesh: 可通过 pip install trimesh 安装
  • smplx: 可通过 pip install smplx 安装
  • spconv: 从支持的版本中选择跟你本地cuda版本一致的安装, 比如 pip install spconv-cu113
  • pytorch3d: 可通过 pip install "git+https://github.com/facebookresearch/pytorch3d.git@stable" 安装

关于硬件依赖: Instant-NGP需要GPU架构>=75, 也就是说至少需要RTX 20X0及以上的显卡，才能获得xrnerf的完整支持。

RTX 30X0 A100 RTX 20X0 TITAN V / V100 GTX 10X0 / TITAN Xp GTX 9X0 K80
86 80 75 70 61 52 37

如果不需要运行Instant-NGP, spconv 决定了最低的cuda版本依赖. 根据他们的表格可见，cuda10.2 是最低要求。

准备环境

a. 安装系统依赖库.

sudo apt install libgl-dev freeglut3-dev build-essential git ninja-build ffmpeg libsm6 libxext6 libgl1

b. 创建并激活 conda 虚拟环境.

conda create -n xrnerf python=3.7 -y
conda activate xrnerf

c. 安装 PyTorch 和 torchvision

  1. 查看pytorch-cuda版本匹配表，选择合适的版本 here or here
  2. 从这里下载合适版本的pytorch (>=1.10.0 且需要与你的cuda版本匹配), 比如 cu111/torch-1.10.0%2Bcu111-cp37-cp37m-linux_x86_64.whl, 下载这个whl文件
  3. 安装这个whl文件, 比如 pip install torch-1.10.0+cu111-cp37-cp37m-linux_x86_64.whl
  4. 在这里查看版本匹配信息， 并安装正确版本的torchvision, 比如 pip install torchvision==0.12.0

d. 安装其他python包

  • 您可以使用 pip install requirements.txt 来安装大部分需要的 pkgs。 如果此步骤成功，您应该跳转到 kilo-cuda 和 spconv 步骤手动安装它们。 或者您可以跳过此步骤并按照以下安装步骤进行操作

  • pip install 'opencv-python>=3' yapf imageio scikit-image lpips trimesh smplx

  • 根据官方说明，安装 mmcv-full

  • 安装 spconv, 比如 pip install spconv-cu111. 值得注意的是只有部分cuda版本是支持的, 具体请查看 官方说明

  • 通过 pip install "git+https://github.com/facebookresearch/pytorch3d.git@stable" 安装 pytorch3d

  • 查看官方说明 安装 kilo-cuda (非必须，运行kilo-nerf方法需要)

  • 通过pip install git+https://github.com/NVlabs/tiny-cuda-nn/#subdirectory=bindings/torch 安装 tcnn, 如果网络问题无法下载cutlass等，参考如下命令

    git clone https://gitclone.com/github.com/nvlabs/tiny-cuda-nn
cd tiny-cuda-nn/dependencies
git clone https://gitclone.com/github.com/fmtlib/fmt.git
git clone https://gitclone.com/github.com/NVIDIA/cutlass.git
cd ../bindings/torch && python setup.py install

    (非必须，运行instant-ngp方法需要)

e. 安装cuda扩展

  • 为了支持instant-ngp算法，需要编译安装cuda扩展 raymarch, 查看具体教程
  • 为了支持gnr算法，需要编译安装cuda扩展 mesh_grid, 查看具体教程

d. 下载smpl_t_pose支持GNR

  • 为了支持gnr算法，需要从GNR下载smpl_t_pose文件夹,并修改configs/gnr/gnr_genebody.py中的basedata_cfg.t_pose_path为对应的存放位置

利用 Docker 镜像安装 XRNeRF

我们根据国内的网络环境优化了dockerfile，请使用DockerfileCN

在安装前需要修改docker的daemon配置，从而让docker的build过程支持gpu (为了编译cuda扩展)：

sudo apt-get install nvidia-container-runtime -f -y
sudo cp -f docker/daemon.json /etc/docker
sudo systemctl restart docker

这里有更详细的解释.

a. 创建docker镜像

XRNeRF 提供一个 DockerfileCN 可以直接创建 docker 镜像

docker build -f ./docker/DockerfileCN --rm -t xrnerf .

注意 用户需要确保已经安装了 nvidia-container-toolkit。

b. 运行docker容器

运行以下命令，创建容器:

docker run --gpus all -it xrnerf /bin/bash

在本机上(非docker镜像机内)开启一个终端，将项目文件(包括数据集)复制进docker镜像机

# d287273af72e 是镜像的id, usin通过 'docker ps -a' 确定id
docker cp ProjectPath/xrnerf d287273af72e:/workspace

安装验证

为了验证 XRNeRF 和所需的依赖包是否已经安装成功，可以运行单元测试模块

coverage run --source xrnerf/models -m pytest -s test/models && coverage report -m

注意，运行单元测试模块前需要额外安装 coverage 和 pytest

pip install coverage pytest -i https://pypi.tuna.tsinghua.edu.cn/simple