mirror of
https://github.com/nerfstudio-project/nerfstudio.git
synced 2026-11-14 20:03:49 +08:00
updated readme and docs with promo language (#401)
* checking emojis * restructured docs * updated links * updated links * small nit
This commit is contained in:
1 parent
b651a532bd
commit
ca09acece2
45 files changed
+105
-61
No files matched your search
@@ -3,7 +3,6 @@
|
||||
|
||||
We make it easy to benchmark your new NeRF against the standard Blender dataset.
|
||||
|
||||
(train)=
|
||||
## Launching training on Blender dataset
|
||||
|
||||
To start, you will need to train your NeRF on each of the blender objects.
|
||||
@@ -29,7 +28,7 @@ A full example would be:
|
||||
|
||||
The script will automatically launch training on all of the items and save the checkpoints in an output directory with the current date and timestamp.
|
||||
|
||||
(eval)=
|
||||
|
||||
## Evaluating trained Blender models
|
||||
Once you have launched training, and training converges, you can test your method with `scripts/benchmarking/launch_eval_blender.sh`.
|
||||
|
||||
|
||||
@@ -0,0 +1 @@
|
||||
# Customizable Configs
|
||||
@@ -1 +0,0 @@
|
||||
# Hydra config structure
|
||||
@@ -2,7 +2,7 @@
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
|
||||
hydra.md
|
||||
config.md
|
||||
logging_profiling.md
|
||||
benchmarking.md
|
||||
|
||||
@@ -1,6 +1,5 @@
|
||||
# Loggers and Profilers
|
||||
|
||||
(logging_support)=
|
||||
## Logging support
|
||||
|
||||
We provide integration with multiple logging interfaces to log images and statistics during training.
|
||||
@@ -24,7 +23,6 @@ logging:
|
||||
|
||||
Currently, we provide support for the following loggers, which can be added to the `logging.writer` section of the config.
|
||||
|
||||
(tensorboard)=
|
||||
#### Tensorboard
|
||||
To log training stats and images with [tensorboard](https://www.tensorflow.org/tensorboard):
|
||||
```
|
||||
@@ -32,7 +30,6 @@ TensorboardWriter:
|
||||
log_dir: "./" # the output path for which the event files are written
|
||||
```
|
||||
|
||||
(wnb)=
|
||||
#### Weights and Biases
|
||||
To log training stats and images with [wandb](https://wandb.ai/site):
|
||||
```
|
||||
@@ -40,7 +37,6 @@ WandbWriter:
|
||||
log_dir: "./" # the output path for which the run files are written
|
||||
```
|
||||
|
||||
(local)=
|
||||
#### Local writer
|
||||
```
|
||||
LocalWriter:
|
||||
@@ -55,11 +51,9 @@ The `LocalWriter` simply outputs to the terminal. However, you can specify addit
|
||||
* `max_log_size`: how much content to print onto the screen (e.g. only print 10 lines on the screen at a time). If 0, will print everything without deleting any previous lines.
|
||||
|
||||
|
||||
(code_profiler)=
|
||||
## Code profiling support
|
||||
We provide built-in performance profiling capabilities to make it easier for you to debug and assess the performance of your code.
|
||||
|
||||
(inhouse)=
|
||||
#### In-house profiler
|
||||
You can use our built-in profiler by enabling the profiler in the config:
|
||||
|
||||
@@ -90,7 +84,6 @@ At termination of training or end of the training run, the profiler will print o
|
||||
Use this profiler if there are specific functions that you want to measure the times for.
|
||||
|
||||
|
||||
(pyspy)=
|
||||
#### Profiling with PySpy
|
||||
If you want to profile the entire codebase, we provide functionality to generate flame graphs or get real-time reports using [PySpy](https://github.com/benfred/py-spy).
|
||||
|
||||
|
||||
Reference in new issue
Block a user