Skip to content

Commit bad6028

Browse files
Update README.
1 parent d6f692e commit bad6028

1 file changed

Lines changed: 11 additions & 33 deletions

File tree

README.md

Lines changed: 11 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@
4141
<a href="#installation">Installation</a>
4242
</li>
4343
<li>
44-
<a href="#demo">Online Demo</a>
44+
<a href="#demo">Offline Demo</a>
4545
</li>
4646
<li>
4747
<a href="#usage">Usage</a>
@@ -66,7 +66,6 @@
6666

6767
## Installation
6868

69-
##### (Recommended)
7069
SplaTAM has been benchmarked with Python 3.10, Torch 1.12.1 & CUDA=11.6. However, Torch 1.12 is not a hard requirement and the code has also been tested with other versions of Torch and CUDA such as Torch 2.3.0 & CUDA 12.1.
7170

7271
The simplest way to install all dependences is to use [anaconda](https://www.anaconda.com/) and [pip](https://pypi.org/project/pip/) in the following steps:
@@ -86,6 +85,7 @@ conda activate splatam
8685
``` -->
8786

8887
#### Docker Setup
88+
##### (Ekumen Recommended)
8989

9090
We also provide a docker image. We recommend using a venv to run the code inside a docker image:
9191

@@ -101,60 +101,38 @@ pip install -r venv_requirements.txt
101101

102102
## Demo
103103

104-
### Online
105-
106-
You can SplaTAM your own environment with an iPhone or LiDAR-equipped Apple device by downloading and using the <a href="https://apps.apple.com/au/app/nerfcapture/id6446518379">NeRFCapture</a> app.
107-
108-
Make sure that your iPhone and PC are connected to the same WiFi network, and then run the following command:
109-
110-
```bash
111-
bash bash_scripts/online_demo.bash configs/iphone/online_demo.py
112-
```
113-
114-
On the app, keep clicking send for successive frames. Once the capturing of frames is done, the app will disconnect from the PC and check out SplaTAM's interactive rendering of the reconstruction on your PC! Here are some cool example results:
115-
116-
<p align="center">
117-
<a href="">
118-
<img src="./assets/collage.gif" alt="Logo" width="75%">
119-
</a>
120-
</p>
121-
122104
### Offline
123105

124-
You can also first capture the dataset and then run SplaTAM offline on the dataset with the following command:
106+
You can first capture the dataset with Spectacular AI tool and then run SplaTAM offline on the recorded dataset with the following command:
125107

126108
```bash
127-
bash bash_scripts/nerfcapture.bash configs/iphone/nerfcapture.py
109+
bash bash_scripts/nerfcapture.bash configs/iphone/nerfcapture.py --base_dir <dataset_parent_dir> --scene <dataset_dir> --frames <dataset_frames_count>
128110
```
129111

130112
### Dataset Collection
131113

132-
If you would like to only capture your own iPhone dataset using the NeRFCapture app, please use the following command:
133-
134-
```bash
135-
bash bash_scripts/nerfcapture2dataset.bash configs/iphone/dataset.py
136-
```
114+
If you would like to only capture your own iPhone dataset, please use the Spectacular AI app.
137115

138116
## Usage
139117

140-
We will use the iPhone dataset as an example to show how to use SplaTAM. The following steps are similar for other datasets.
141-
142-
To run SplaTAM, please use the following command:
118+
If you already converted the dataset to the SplaTAM expected input, to run SplaTAM, please use the following command:
143119

144120
```bash
145-
python scripts/splatam.py configs/iphone/splatam.py
121+
python scripts/splatam.py configs/iphone/splatam.py --base_dir <dataset_parent_dir> --scene <dataset_dir> --frames <dataset_frames_count>
146122
```
147123

148124
To visualize the final interactive SplaTAM reconstruction, please use the following command:
149125

150126
```bash
151-
python viz_scripts/final_recon.py configs/iphone/splatam.py
127+
python viz_scripts/final_recon.py configs/iphone/splatam.py --base_dir <dataset_parent_dir> --scene <dataset_dir> --frames <dataset_frames_count>
152128
```
153129

130+
### Not supported by Ekumen
131+
154132
To visualize the SplaTAM reconstruction in an online fashion, please use the following command:
155133

156134
```bash
157-
python viz_scripts/online_recon.py configs/iphone/splatam.py
135+
python viz_scripts/online_recon.py configs/iphone/splatam.py --base_dir <dataset_parent_dir> --scene <dataset_dir> --frames <dataset_frames_count>
158136
```
159137

160138
To export the splats to a .ply file, please use the following command:

0 commit comments

Comments
 (0)