From efa1b18a838b585e710e45327b07d2cbfac670aa Mon Sep 17 00:00:00 2001 From: inter Date: Sun, 21 Sep 2025 20:19:34 +0800 Subject: [PATCH] Add File --- docs/INSTALL.md | 38 ++++++++++++++++++++++++++++++++++++++ 1 file changed, 38 insertions(+) create mode 100644 docs/INSTALL.md diff --git a/docs/INSTALL.md b/docs/INSTALL.md new file mode 100644 index 0000000..2105590 --- /dev/null +++ b/docs/INSTALL.md @@ -0,0 +1,38 @@ +# Installation + +### Requirements +All the codes are tested in the following environment: +* Linux (tested on Ubuntu 14.04/16.04/18.04/20.04/21.04) +* Python 3.6+ +* PyTorch 1.1 or higher (tested on PyTorch 1.1, 1,3, 1,5~1.10) +* CUDA 9.0 or higher (PyTorch 1.3+ needs CUDA 9.2+) +* [`spconv v1.0 (commit 8da6f96)`](https://github.com/traveller59/spconv/tree/8da6f967fb9a054d8870c3515b1b44eca2103634) or [`spconv v1.2`](https://github.com/traveller59/spconv) or [`spconv v2.x`](https://github.com/traveller59/spconv) + + +### Install `pcdet v0.5` +NOTE: Please re-install `pcdet v0.5` by running `python setup.py develop` even if you have already installed previous version. + +a. Clone this repository. +```shell +git clone https://github.com/open-mmlab/OpenPCDet.git +``` + +b. Install the dependent libraries as follows: + +[comment]: <> (* Install the dependent python libraries: ) + +[comment]: <> (```) + +[comment]: <> (pip install -r requirements.txt ) + +[comment]: <> (```) + +* Install the SparseConv library, we use the implementation from [`[spconv]`](https://github.com/traveller59/spconv). + * If you use PyTorch 1.1, then make sure you install the `spconv v1.0` with ([commit 8da6f96](https://github.com/traveller59/spconv/tree/8da6f967fb9a054d8870c3515b1b44eca2103634)) instead of the latest one. + * If you use PyTorch 1.3+, then you need to install the `spconv v1.2`. As mentioned by the author of [`spconv`](https://github.com/traveller59/spconv), you need to use their docker if you use PyTorch 1.4+. + * You could also install latest `spconv v2.x` with pip, see the official documents of [spconv](https://github.com/traveller59/spconv). + +c. Install this `pcdet` library and its dependent libraries by running the following command: +```shell +python setup.py develop +```