mirror of
https://github.com/nerfstudio-project/nerfstudio.git
synced 2026-11-17 13:23:46 +08:00
quickstart updates + (other nits+links added to repo) (#633)
* small changes * rewrite quickstart + readme * fixed all licensing headers * nits
This commit is contained in:
1 parent
e1a678e25b
commit
968959bdc9
98 files changed
+164
-137
No files matched your search
+38
-18
@@ -13,18 +13,23 @@
|
||||
:alt: nerfstudio
|
||||
:class: only-dark
|
||||
|
||||
Neural Volumetric Rendering
|
||||
"""""""""""""""""""""""""""""
|
||||
|
||||
All-in-one repository for state-of-the-art NeRFs.
|
||||
|
|
||||
|
||||
nerfstudio provides a simple API that allows for a seamless and 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, not only does your code become far more user-friendly, but using this framework also makes it easier for the community to build upon your implementation.
|
||||
|
||||
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!
|
||||
|
||||
If you have further questions or want a feature that is not yet supported, please do not hesitate to reach out to the Plenoptix team.
|
||||
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!** Please do not hesitate to reach out to the nerfstudio team with any questions.
|
||||
|
||||
We hope nerfstudio enables you to build faster 🔨 learn together 📚 and contribute to our NeRF community 💖.
|
||||
|
||||
|
|
||||
|
||||
@@ -71,9 +76,10 @@ Contents
|
||||
|
||||
This documentation is organized into 3 parts:
|
||||
|
||||
* **Tutorials**: 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 |:metal:|
|
||||
* **Tooling**: describes all of the additional support we provide to help you debug and improve your NeRFs (e.g logging, performance profiling)
|
||||
* **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.
|
||||
* **🏃♀️ 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.
|
||||
|
||||
|
||||
|
|
||||
@@ -82,17 +88,31 @@ This documentation is organized into 3 parts:
|
||||
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
|
||||
|
||||
+------------------------+------------------------------+----------------------------+
|
||||
| | PSNR | Rays / sec. |
|
||||
+========================+==============================+============================+
|
||||
| NeRF | |:hourglass_flowing_sand:| | |:hourglass_flowing_sand:| |
|
||||
+------------------------+------------------------------+----------------------------+
|
||||
| Instant-NGP | |:hourglass_flowing_sand:| | |:hourglass_flowing_sand:| |
|
||||
+------------------------+------------------------------+----------------------------+
|
||||
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
|
||||
`Web-based Viewer <https://viewer.nerf.studio/>`_ Web-based Nerf Viewer
|
||||
============================================================ ======================
|
||||
|
||||
|
||||
Indices and Tables
|
||||
|
||||
@@ -68,6 +68,8 @@ Please note, this quickstart allows you to preform everything in a headless mann
|
||||
## FAQ
|
||||
|
||||
- [TinyCUDA installation errors out with cuda mismatch](tiny-cuda-error)
|
||||
- [Installation errors, File "setup.py" not found](pip-install-error)
|
||||
- [Runtime errors, "len(sources) > 0".](cuda-sources-error)
|
||||
|
||||
(tiny-cuda-error)=
|
||||
|
||||
@@ -81,8 +83,6 @@ While installing tiny-cuda, you run into: `The detected CUDA version mismatches
|
||||
pip install torch==1.12.1+cu113 torchvision==0.13.1+cu113 -f https://download.pytorch.org/whl/torch_stable.html
|
||||
```
|
||||
|
||||
- [Installation errors, File "setup.py" not found](pip-install-error)
|
||||
|
||||
(pip-install-error)=
|
||||
|
||||
#### Installation errors, File "setup.py" not found
|
||||
@@ -96,7 +96,6 @@ This can be fixed by upgrading pip to the latest version:
|
||||
python -m pip install --upgrade pip
|
||||
```
|
||||
|
||||
- [Runtime errors, "len(sources) > 0".](cuda-sources-error)
|
||||
|
||||
(cuda-sources-error)=
|
||||
|
||||
|
||||
@@ -1,5 +1,9 @@
|
||||
# Contributing to nerfstudio workflow
|
||||
|
||||
**We're excited to have you join the NerfStudio family!** :love_letter:
|
||||
|
||||
Below, we document the contribution pipeline and good-to-knows for when you're ready to submit a PR. If you have any questions at all, please don't hesitate to reach out to us. We'd love to hear from you!
|
||||
|
||||
The project is set up for development in VSCode, we recommend using it if you plan to contribute.
|
||||
|
||||
## TLDR
|
||||
|
||||
Reference in new issue
Block a user