From df789bd98831a31aed73dbf46f63525de1aa7b82 Mon Sep 17 00:00:00 2001
From: xucr <xucr@shanghaitech.edu.cn>
Date: Tue, 2 Jul 2024 16:10:38 +0800
Subject: [PATCH 1/4] splatw doc

---
 docs/nerfology/methods/splatw.md       | 41 ++++++++++++++++++++++++++
 nerfstudio/configs/external_methods.py | 15 ++++++++++
 2 files changed, 56 insertions(+)
 create mode 100644 docs/nerfology/methods/splatw.md

diff --git a/docs/nerfology/methods/splatw.md b/docs/nerfology/methods/splatw.md
new file mode 100644
index 0000000000..bb923d2a4c
--- /dev/null
+++ b/docs/nerfology/methods/splatw.md
@@ -0,0 +1,41 @@
+# Spaltfacto in the Wild
+
+This is the implementation of [Spaltfacto 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.
\ No newline at end of file
diff --git a/nerfstudio/configs/external_methods.py b/nerfstudio/configs/external_methods.py
index 8bad790eea..b25a9f16a6 100644
--- a/nerfstudio/configs/external_methods.py
+++ b/nerfstudio/configs/external_methods.py
@@ -268,6 +268,21 @@ class ExternalMethod:
     )
 )
 
+# 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:

From 80f1547717fc3b1ab6f62f380e91e8e13b2581db Mon Sep 17 00:00:00 2001
From: xucr <xucr@shanghaitech.edu.cn>
Date: Tue, 2 Jul 2024 16:18:32 +0800
Subject: [PATCH 2/4] fix

---
 docs/nerfology/methods/index.md | 1 +
 1 file changed, 1 insertion(+)

diff --git a/docs/nerfology/methods/index.md b/docs/nerfology/methods/index.md
index d08c7a4ab3..a8ecc7f099 100644
--- a/docs/nerfology/methods/index.md
+++ b/docs/nerfology/methods/index.md
@@ -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>

From 99cef1ad7ab4544f9f9db3c1c414a821bb8783bf Mon Sep 17 00:00:00 2001
From: xucr <xucr@shanghaitech.edu.cn>
Date: Wed, 3 Jul 2024 14:30:39 +0800
Subject: [PATCH 3/4] fix typo

---
 docs/nerfology/methods/splatw.md | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/docs/nerfology/methods/splatw.md b/docs/nerfology/methods/splatw.md
index bb923d2a4c..85b08af916 100644
--- a/docs/nerfology/methods/splatw.md
+++ b/docs/nerfology/methods/splatw.md
@@ -1,6 +1,6 @@
-# Spaltfacto in the Wild
+# Splatfacto in the Wild
 
-This is the implementation of [Spaltfacto 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).
+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">

From 37e8957118f794a9068748b9ba09666796fe8d97 Mon Sep 17 00:00:00 2001
From: xucr <xucr@shanghaitech.edu.cn>
Date: Tue, 16 Jul 2024 18:42:29 +0800
Subject: [PATCH 4/4] update doc

---
 docs/nerfology/methods/splatw.md | 18 +++++++++++++-----
 1 file changed, 13 insertions(+), 5 deletions(-)

diff --git a/docs/nerfology/methods/splatw.md b/docs/nerfology/methods/splatw.md
index 85b08af916..5127315458 100644
--- a/docs/nerfology/methods/splatw.md
+++ b/docs/nerfology/methods/splatw.md
@@ -1,9 +1,9 @@
 # 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).
+This is the implementation of [Splatfacto in the Wild: A Nerfstudio Implementation of Gaussian Splatting for Unconstrained Photo Collections](https://kevinxu02.github.io/splatfactow). 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">
+    <source id="mp4" src="https://github.com/KevinXu02/splatfactow/blob/main/static/videos/interp_fountain2.mp4" type="video/mp4">
 </video>
 
 ## Installation
@@ -28,14 +28,22 @@ 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`.
+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 `your-data-folder/brandenburg_gate/brandenburg.tsv`. You should have the following structure in your data folder:
+```
+|---brandenburg_gate
+|   |---dense
+|   |   |---images
+|   |   |---sparse
+|   |   |---stereo
+|   |---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:
+If you want to train datasets without nerf-w's train/test split or your own datasets, we provided a light-weight version of the method for general cases. To train with it, you can run the following command
 ```
-ns-train splatfacto-w --data [PATH] [dataparser]
+ns-train splatfacto-w-light --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.
\ No newline at end of file