mirror of
https://github.com/nerfstudio-project/nerfstudio.git
synced 2026-11-21 07:05:44 +08:00
Update docs (#649)
This commit is contained in:
1 parent
50b9ee83a1
commit
4d5a1363b1
7 files changed
+140
-157
No files matched your search
@@ -14,7 +14,7 @@
|
||||
|
||||
## What is a Model?
|
||||
|
||||
A Model is probably what you think of when you think of a NeRF paper. Often the phrases "Model" and "Method" are used interchangeably and for this reason, our [implemented models](https://docs.nerf.studio/en/latest/nerfology/models/index.html) are actually methods. However, most of the implementations details of a method happen in the model code, as you'll see in this section.
|
||||
A Model is probably what you think of when you think of a NeRF paper. Often the phrases "Model" and "Method" are used interchangeably and for this reason, our [implemented models](/nerfology/models/index) are actually methods. However, most of the implementations details of a method happen in the model code, as you'll see in this section.
|
||||
|
||||
A model, at a high level, takes in regions of space described by RayBundle objects, samples points along these rays, and returns rendered values for each ray. So, let's take a look at what it takes to create your own model!
|
||||
|
||||
|
||||
@@ -50,7 +50,7 @@
|
||||
"source": [
|
||||
"## Open the Nerfviewer client\n",
|
||||
"\n",
|
||||
"Open the Nerfviewer client by visiting http://nerfviewer.plenoptix.ai/ or running the code locally. *We refer to this document for running the code locally.* You should see a GUI like the following:\n",
|
||||
"Open the Nerfviewer client by visiting http://viewer.nerf.studio/ or running the code locally. *We refer to this document for running the code locally.* You should see a GUI like the following:\n",
|
||||
"\n",
|
||||
"```{image} imgs/nerfviewer.png\n",
|
||||
":align: center\n",
|
||||
|
||||
+109
@@ -0,0 +1,109 @@
|
||||
<br/>
|
||||
|
||||
```{image} _static/imgs/logo.png
|
||||
:width: 400
|
||||
:align: center
|
||||
:alt: nerfstudio
|
||||
:class: only-light
|
||||
```
|
||||
|
||||
```{image} _static/imgs/logo-dark.png
|
||||
:width: 400
|
||||
:align: center
|
||||
:alt: nerfstudio
|
||||
:class: only-dark
|
||||
```
|
||||
|
||||
<br/>
|
||||
|
||||
Nerfstudio provides a simple API that allows for a simplified end-to-end process of creating, training, and testing NeRFs.
|
||||
The library supports a **more interpretable implementation of NeRFs by modularizing each component.**
|
||||
With more modular NeRFs, we hope to create a more user-friendly experience in exploring the technology.
|
||||
Nerfstudio is a contributer friendly repo with the goal of buiding a community where users can more easily build upon each other's contributions.
|
||||
|
||||
It's as simple as plug and play with nerfstudio!
|
||||
|
||||
Ontop of our API, we are commited to providing learning resources to help you understand the basics of (if you're just getting start), and keep up-to-date with (if you're a seasoned veteran) all things NeRF.
|
||||
As researchers, we know just how hard it is to get onboarded with this next-gen technology. So we're here to help with tutorials, documentation, and more!
|
||||
|
||||
Finally, have feature requests? Want to add your brand-spankin'-new NeRF model? Have a new dataset? **We welcome any and all [contributions](reference/contributing)!**
|
||||
Please do not hesitate to reach out to the nerfstudio team with any questions via [Discord](https://discord.gg/NHGtYRAW).
|
||||
|
||||
We hope nerfstudio enables you to build faster 🔨 learn together 📚 and contribute to our NeRF community 💖.
|
||||
|
||||
## Contents
|
||||
|
||||
```{toctree}
|
||||
:hidden:
|
||||
:caption: Getting Started
|
||||
|
||||
quickstart/installation
|
||||
quickstart/first_nerf
|
||||
quickstart/custom_dataset
|
||||
quickstart/viewer_quickstart
|
||||
Contributing<reference/contributing.md>
|
||||
```
|
||||
|
||||
```{toctree}
|
||||
:hidden:
|
||||
:caption: NeRFology
|
||||
|
||||
nerfology/models/index
|
||||
nerfology/model_components/index
|
||||
nerfology/dataloader_components/index
|
||||
```
|
||||
|
||||
```{toctree}
|
||||
:hidden:
|
||||
:caption: Developer Guides
|
||||
|
||||
developer_guides/pipelines/index
|
||||
developer_guides/viewer/index
|
||||
developer_guides/config
|
||||
developer_guides/logging_profiling
|
||||
developer_guides/benchmarking
|
||||
```
|
||||
|
||||
```{toctree}
|
||||
:hidden:
|
||||
:caption: Reference
|
||||
|
||||
reference/cli/index
|
||||
reference/api/index
|
||||
```
|
||||
|
||||
This documentation is organized into 3 parts:
|
||||
|
||||
- **🏃♀️ Getting Started**: a great place to start if you are new to nerfstudio. Contains a quick tour, installation, and an overview of the core structures that will allow you to get up and running with nerfstudio.
|
||||
- **🧪 Nerfology**: want to learn more about the tech itself? We're here to help with our educational guides. We've provided some interactive notebooks that walk you through what each component is all about.
|
||||
- **🤓 Developer Guides**: describes all of the components and additional support we provide to help you construct, train, and debug your NeRFs. Learn how to set up a model pipeline, use the viewer, create a custom config, and more.
|
||||
- **📚 Reference**: describes each class and function. Develop a better understanding of the core of our technology and terminology. This section includes descriptions of each module and component in the codebase.
|
||||
|
||||
## Supported Models
|
||||
|
||||
- **Nerfacto**: our defacto NeRF model combines modules focused on quality with modules focused on faster rendering. Nerfstudio easily lets us experiment with the best of both worlds!
|
||||
- [NeRF](https://www.matthewtancik.com/nerf): Representing Scenes as Neural Radiance Fields for View Synthesis
|
||||
- [Instant NGP](https://nvlabs.github.io/instant-ngp/): Instant Neural Graphics Primitives with a Multiresolution Hash Encoding
|
||||
- [Mipnerf-360](https://jonbarron.info/mipnerf360/): Unbounded Anti-Aliased Neural Radiance Fields
|
||||
- [Mipnerf](https://jonbarron.info/mipnerf/): A Multiscale Representation for Anti-Aliasing Neural Radiance Fields
|
||||
- [NerfW](https://nerf-w.github.io/): Neural Radiance Fields for Unconstrained Photo Collections
|
||||
- [Semantic NeRF](https://shuaifengzhi.com/Semantic-NeRF/): In-Place Scene Labelling and Understanding with Implicit Scene Representation
|
||||
- [TensoRF](https://apchenstu.github.io/TensoRF/): Tensorial Radiance Fields
|
||||
|
||||
We'll be constantly growing this list! So make sure to check back in to see our updates.
|
||||
|
||||
**Eager to contribute?** We'd love to see you use nerfstudio in implementing new (or even existing) models! Feel free to contact us directly or view our [Contributor's Guide](reference/contributing) to see how you can get your model on this list!
|
||||
|
||||
## Quicklinks
|
||||
|
||||
| | |
|
||||
| ---------------------------------------------------------- | ---------------------- |
|
||||
| [Github](https://github.com/nerfstudio-project/nerfstudio) | Official Github Repo |
|
||||
| [Discord](https://discord.com/invite/NHGtYRAW) | Join Discord Community |
|
||||
| [Viewer](https://viewer.nerf.studio/) | Web-based Nerf Viewer |
|
||||
|
||||
## Indices and Tables
|
||||
|
||||
- {ref}`genindex`
|
||||
- {ref}`modindex`
|
||||
- {ref}`search`
|
||||
-124
@@ -1,124 +0,0 @@
|
||||
|
||||
|
|
||||
|
||||
.. image:: _static/imgs/logo.png
|
||||
:width: 400
|
||||
:align: center
|
||||
:alt: nerfstudio
|
||||
:class: only-light
|
||||
|
||||
.. image:: _static/imgs/logo-dark.png
|
||||
:width: 400
|
||||
:align: center
|
||||
:alt: nerfstudio
|
||||
:class: only-dark
|
||||
|
||||
|
||||
|
|
||||
|
||||
|
||||
Nerfstudio provides a simple API that allows for a simplified end-to-end process of creating, training, and testing NeRFs.
|
||||
The library supports a **more interpretable implementation of NeRFs by modularizing each component.**
|
||||
With more modular NeRFs, we hope to create a more user-friendly experience in exploring the technology.
|
||||
Nerfstudio is a contributer friendly repo with the goal of buiding a community where users can more easily build upon each other's contributions.
|
||||
|
||||
It's as simple as plug and play with nerfstudio!
|
||||
|
||||
Ontop of our API, we are commited to providing learning resources to help you understand the basics of (if you're just getting start), and keep up-to-date with (if you're a seasoned veteran) all things NeRF.
|
||||
As researchers, we know just how hard it is to get onboarded with this next-gen technology. So we're here to help with tutorials, documentation, and more!
|
||||
|
||||
Finally, have feature requests? Want to add your brand-spankin'-new NeRF model? Have a new dataset? **We welcome any and all [contributions](https://docs.nerf.studio/en/latest/reference/contributing.html)!**
|
||||
Please do not hesitate to reach out to the nerfstudio team with any questions via [Discord](https://discord.gg/NHGtYRAW).
|
||||
|
||||
We hope nerfstudio enables you to build faster 🔨 learn together 📚 and contribute to our NeRF community 💖.
|
||||
|
||||
|
|
||||
|
||||
|
||||
Contents
|
||||
"""""""""""""""""""""""""""""
|
||||
|
||||
.. toctree::
|
||||
:hidden:
|
||||
:caption: Getting Started
|
||||
|
||||
quickstart/installation
|
||||
quickstart/first_nerf
|
||||
quickstart/custom_dataset
|
||||
quickstart/viewer_quickstart
|
||||
Contributing<reference/contributing.md>
|
||||
|
||||
.. toctree::
|
||||
:hidden:
|
||||
:caption: NeRFology
|
||||
|
||||
nerfology/models/index
|
||||
nerfology/model_components/index
|
||||
nerfology/dataloader_components/index
|
||||
|
||||
.. toctree::
|
||||
:hidden:
|
||||
:caption: Developer Guides
|
||||
|
||||
developer_guides/pipelines/index
|
||||
developer_guides/viewer/index
|
||||
developer_guides/config
|
||||
developer_guides/logging_profiling
|
||||
developer_guides/benchmarking
|
||||
|
||||
.. toctree::
|
||||
:hidden:
|
||||
:caption: Reference
|
||||
|
||||
reference/cli/index
|
||||
reference/api/index
|
||||
|
||||
|
||||
|
||||
This documentation is organized into 3 parts:
|
||||
|
||||
* **🏃♀️ Getting Started**: a great place to start if you are new to nerfstudio. Contains a quick tour, installation, and an overview of the core structures that will allow you to get up and running with nerfstudio.
|
||||
* **🧪 Nerfology**: want to learn more about the tech itself? We're here to help with our educational guides. We've provided some interactive notebooks that walk you through what each component is all about.
|
||||
* **🤓 Developer Guides**: describes all of the components and additional support we provide to help you construct, train, and debug your NeRFs. Learn how to set up a model pipeline, use the viewer, create a custom config, and more.
|
||||
* **📚 Reference**: describes each class and function. Develop a better understanding of the core of our technology and terminology. This section includes descriptions of each module and component in the codebase.
|
||||
|
||||
|
||||
|
|
||||
|
||||
|
||||
Supported Models
|
||||
"""""""""""""""""""""""""""""
|
||||
|
||||
* **Nerfacto**: our defacto NeRF model combines modules focused on quality with modules focused on faster rendering. Nerfstudio easily lets us experiment with the best of both worlds!
|
||||
* `NeRF <https://www.matthewtancik.com/nerf>`_: Representing Scenes as Neural Radiance Fields for View Synthesis
|
||||
* `Instant NGP <https://nvlabs.github.io/instant-ngp/>`_: Instant Neural Graphics Primitives with a Multiresolution Hash Encoding
|
||||
* `Mipnerf-360 <https://jonbarron.info/mipnerf360/>`_: Unbounded Anti-Aliased Neural Radiance Fields
|
||||
* `Mipnerf <https://jonbarron.info/mipnerf/>`_: A Multiscale Representation for Anti-Aliasing Neural Radiance Fields
|
||||
* `NerfW <https://nerf-w.github.io/>`_: Neural Radiance Fields for Unconstrained Photo Collections
|
||||
* `Semantic NeRF <https://shuaifengzhi.com/Semantic-NeRF/>`_: In-Place Scene Labelling and Understanding with Implicit Scene Representation
|
||||
* `TensoRF <https://apchenstu.github.io/TensoRF/>`_: Tensorial Radiance Fields
|
||||
|
||||
We'll be constantly growing this list! So make sure to check back in to see our updates.
|
||||
|
||||
**Eager to contribute?** We'd love to see you use nerfstudio in implementing new (or even existing) models! Feel free to contact us directly or view our `Contributor's Guide <https://docs.nerf.studio/en/latest/reference/contributing.html>`_ to see how you can get your model on this list!
|
||||
|
||||
Quicklinks
|
||||
"""""""""""""""""""""""""""""
|
||||
|
||||
.. table::
|
||||
:align: left
|
||||
:widths: auto
|
||||
|
||||
============================================================ ======================
|
||||
`Github <https://github.com/nerfstudio-project/nerfstudio>`_ Official Github Repo
|
||||
`Discord <https://discord.com/invite/NHGtYRAW>`_ Join Discord Community
|
||||
`Viewer <https://viewer.nerf.studio/>`_ Web-based Nerf Viewer
|
||||
============================================================ ======================
|
||||
|
||||
|
||||
Indices and Tables
|
||||
"""""""""""""""""""""""""""""
|
||||
|
||||
* :ref:`genindex`
|
||||
* :ref:`modindex`
|
||||
* :ref:`search`
|
||||
@@ -32,7 +32,7 @@ pip install nerfstudio
|
||||
If you want the latest and greatest:
|
||||
|
||||
```bash
|
||||
git clone git@github.com:plenoptix/nerfstudio.git
|
||||
git clone git@github.com:nerfstudio-project/nerfstudio.git
|
||||
cd nerfstudio
|
||||
pip install -e .
|
||||
|
||||
@@ -86,7 +86,6 @@ This can be fixed by upgrading pip to the latest version:
|
||||
python -m pip install --upgrade pip
|
||||
```
|
||||
|
||||
|
||||
(cuda-sources-error)=
|
||||
|
||||
#### Runtime errors: "len(sources) > 0", "ctype = \_C.ContractionType(type.value) ; TypeError: 'NoneType' object is not callable".
|
||||
@@ -100,4 +99,4 @@ This is a problem with not being able to detect the correct CUDA version, and ca
|
||||
export CUDA_HOME=/usr/local/cuda
|
||||
export LD_LIBRARY_PATH=$LD_LIBRARY_PATH:/usr/local/cuda/lib64:/usr/local/cuda/extras/CUPTI/lib64
|
||||
export PATH=$PATH:$CUDA_HOME/bin
|
||||
```
|
||||
```
|
||||
Reference in new issue
Block a user