You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+10-10Lines changed: 10 additions & 10 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -61,9 +61,13 @@ The add-on properties panel is available under `3D View > N panel > BlenderNeRF`
61
61
*`Test` (activated by default) : whether to register testing data (camera information only)
62
62
*`AABB` (by default set to **4**) : aabb scale parameter as described in Instant NGP (more details below)
63
63
*`Render Frames` (activated by default) : whether to render the frames
64
+
*`Save Log File` (deactivated by default) : whether to save a log file containing reproducibility information on the **BlenderNeRF** run
65
+
*`File Format` (**NGP** by default) : whether to export the camera files in the Instant NGP or defaut NeRF file format convention
64
66
*`Save Path` (empty by default) : path to the output directory in which the dataset will be created
65
67
66
-
`AABB` is restricted to be an integer power of 2, it defines the side length of the bounding box volume in which NeRF will trace rays. The property was introduced in **NVIDIA's [Instant NGP](https://github.com/NVlabs/instant-ngp)** version of NeRF, currently the only supported version. Future releases of this add-on will introduce support for the original NeRF camera conventions.
68
+
`AABB` is restricted to be an integer power of 2, it defines the side length of the bounding box volume in which NeRF will trace rays. The property was introduced with **NVIDIA's [Instant NGP](https://github.com/NVlabs/instant-ngp)** version of NeRF.
69
+
70
+
The `File Format` property can either be **NGP** or **NeRF**. The **NGP** file format convention is the same as the **NeRF** one, with a few additional parameters which can be accessed by Instant NGP.
67
71
68
72
Notice that each method has its distinctive `Name` property (by default set to `dataset`) corresponding to the dataset name and created **ZIP** filename for the respective method. Please note that unsupported characters, such as spaces, `#` or `/`, will automatically be replaced by an underscore.
69
73
@@ -94,16 +98,18 @@ Below are described the properties specific to each method (the `Name` property
94
98
*`Sphere` (deactivated by default) : whether to show the training sphere from which random views will be sampled
95
99
*`Camera` (deactivated by default) : whether to show the camera used for registering the training data
96
100
*`Upper Views` (deactivated by default) : whether to sample views from the upper training hemisphere only (rotation variant)
101
+
*`Outwards` (deactivated by default) : whether to point the camera outwards of the training sphere
97
102
*`PLAY COS` : play the **Camera on Sphere** method
98
103
99
104
Note that activating the `Sphere` and `Camera` properties creates a `BlenderNeRF Sphere` empty object and a `BlenderNeRF Camera` camera object respectively. Please do not create any objects with these names manually, since this might break the add-on functionalities.
100
105
101
-
Training frames will be captured using the `BlenderNeRF Camera` object from frame 1 to `Frames`, irrespectively of the scene frame range. Finally, keep in mind that the training camera is locked in place and cannot manually be moved.
106
+
107
+
`Frames` amount of training frames will be captured using the `BlenderNeRF Camera` object, starting from the scene start frame. Finally, keep in mind that the training camera is locked in place and cannot manually be moved.
102
108
103
109
104
110
## Tips for optimal results
105
111
106
-
As mentioned previously, the add-on currently only supports **NVIDIA's [Instant NGP](https://github.com/NVlabs/instant-ngp)** version of NeRF. Feel free to visit their repository for further help. Below are some quick tips for optimal **nerfing**.
112
+
NVIDIA provides a few helpful tips on how to train a NeRF model using **[Instant NGP](https://github.com/NVlabs/instant-ngp/blob/master/docs/nerf_dataset_tips.md)**. Feel free to visit their repository for further help. Below are some quick tips for optimal **nerfing**.
107
113
108
114
* NeRF trains best with 50 to 150 images
109
115
* Testing views should not deviate too much from training views
@@ -117,15 +123,14 @@ As mentioned previously, the add-on currently only supports **NVIDIA's [Instant
117
123
118
124
## How to run NeRF
119
125
120
-
If you have access to an NVIDIA GPU, you might want to install [Instant NGP](https://github.com/NVlabs/instant-ngp) on your own device for an optimal user experience with a GUI by following the instructions provided in their GitHub repository. Otherwise, you can run NeRF in a COLAB notebook on Google GPUs for free (all you need is a Google account).
126
+
If you have access to an NVIDIA GPU, you might want to install [Instant NGP](https://github.com/NVlabs/instant-ngp#installation) on your own device for an optimal user experience, by following the instructions provided on their repository. Otherwise, you can run NeRF in a COLAB notebook on Google GPUs for free with a Google account.
121
127
122
128
Open this [COLAB notebook](https://colab.research.google.com/drive/1CtF_0FgwzCZMYQzGXbye2iVS1ZLlq9Tw?usp=sharing) (also downloadable [here](https://gist.github.com/maximeraafat/122a63c81affd6d574c67d187b82b0b0)) and follow the instructions.
123
129
124
130
125
131
## Remarks
126
132
127
133
This add-on is being developed as a fun side project over the course of multiple months and versions of Blender, mainly on macOS. If you encouter any issues with the plug-in functionalities, feel free to open a GitHub issue with a clear description of the problem, which **BlenderNeRF** version the issues have been experienced with, and any further information if relevant.
128
-
129
134
130
135
If you find this repository useful in your research, please consider citing **BlenderNeRF** using the dedicated button above. \
131
136
If you made use of **BlenderNeRF** in your artistic projects, feel free to share some of your work using the `#blendernerf` hashtag on social media! :)
@@ -136,9 +141,4 @@ If you made use of **BlenderNeRF** in your artistic projects, feel free to share
136
141
Ideas for upcoming features are listed in the points below, sorted by priority in descending order.
137
142
138
143
-[ ] Evaluations and demonstrations for each method on various scenes
139
-
-[ ] Support for the original NeRF `transforms.json` convention
140
-
-[ ] Support for previous blender versions
141
-
-[ ] Enable option to create log file for reproducibility containing add-on version, used method and all respective parameters...
142
144
-[ ] Enable user defined NeRF output resolution in COLAB notebook : if width or length = 0, use default scene resolution
143
-
-[ ] Enable option to copy already rendered frames from a set of images instead of rendering them again
144
-
-[ ] Add-on updater button (see [this video](https://www.youtube.com/watch?v=usjPdfMHE9c&t))?
0 commit comments