Document updates for splatfacto-w (#3281)

* splatw doc

* fix

* fix typo

---------

Co-authored-by: Justin Kerr <justin.g.kerr@gmail.com>
This commit is contained in:
Congrong XuandJustin Kerr authored and GitHub committed 2024-07-09 10:00:10 -04:00
1 parent 592615ff51
commit b28cc78b7c
3 files changed
+57

No files matched your search

+1
View File
@@ -28,6 +28,7 @@ The following methods are supported in nerfstudio:
:maxdepth: 1
Instant-NGP<instant_ngp.md>
Splatfacto<splat.md>
Splatfacto-W<splatw.md>
Instruct-NeRF2NeRF<in2n.md>
Instruct-GS2GS<igs2gs.md>
SIGNeRF<signerf.md>
+41
View File
@@ -0,0 +1,41 @@
# Splatfacto in the Wild
This is the implementation of [Splatfacto in the Wild: A Nerfstudio Implementation of Gaussian Splatting for Unconstrained Photo Collections](https://kevinxu02.github.io/gsw.github.io/). The official code can be found [here](https://github.com/KevinXu02/splatfacto-w).
<video id="teaser" muted autoplay playsinline loop controls width="100%">
<source id="mp4" src="https://github.com/KevinXu02/gsw.github.io/blob/main/static/videos/interp_fountain2.mp4" type="video/mp4">
</video>
## Installation
This repository follows the nerfstudio method [template](https://github.com/nerfstudio-project/nerfstudio-method-template/tree/main)
### 1. Install Nerfstudio dependencies
Please follow the Nerfstudio [installation guide](https://docs.nerf.studio/quickstart/installation.html) to create an environment and install dependencies.
### 2. Install the repository
Run the following commands:
`pip install git+https://github.com/KevinXu02/splatfacto-w`
Then, run `ns-install-cli`.
### 3. Check installation
Run `ns-train splatfacto-w --help`. You should see the help message for the splatfacto-w method.
## Downloading data
You can download the phototourism dataset from running.
```
ns-download-data phototourism --capture-name <capture_name>
```
## Running Splafacto-w
To train with it, download the train/test tsv file from the bottom of [nerf-w](https://nerf-w.github.io/) and put it under the data folder (or copy them from `.\splatfacto-w\dataset_split`). For instance, for Brandenburg Gate the path would be `splatfacto-w\data\brandenburg_gate\brandenburg.tsv`.
Then, run the command:
```
ns-train splatfacto-w --data [PATH]
```
If you want to train datasets without nerf-w's train/test split or your own datasets, you can run the following command:
```
ns-train splatfacto-w --data [PATH] [dataparser]
```
For phototourism, the `dataparser` should be `colmap` and you need to change the colmap path through the CLI because phototourism dataparser does not load 3D points.
+15
View File
@@ -268,6 +268,21 @@ To enable NeRFGS, you must install it first by running:
)
)
# Splatfacto-W
external_methods.append(
ExternalMethod(
"""[bold yellow]Splatfacto-W[/bold yellow]
For more information visit: https://docs.nerf.studio/nerfology/methods/splatw.html
To enable Splatfacto-W, you must install it first by running:
[grey]pip install git+https://github.com/KevinXu02/splatfacto-w"[/grey]""",
configurations=[
("splatfacto-w", "Splatfacto in the wild"),
],
pip_package="git+https://github.com/KevinXu02/splatfacto-w",
)
)
@dataclass
class ExternalMethodDummyTrainerConfig: