Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: reducing misspell several docs comments #227

Open
wants to merge 6 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/developer_guides/pipelines/dataparsers.md
Original file line number Diff line number Diff line change
Expand Up @@ -103,7 +103,7 @@ dataparser_outputs = dataparser.get_dataparser_outputs(split="train")
input_dataset = InputDataset(dataparser_outputs)
```

You can also pull out information from the DataParserOutputs for other DataMangager componenets, such as the RayGenerator. The RayGenerator generates RayBundle objects from camera and pixel indices.
You can also pull out information from the DataParserOutputs for other DataManager components, such as the RayGenerator. The RayGenerator generates RayBundle objects from camera and pixel indices.

```python
ray_generator = RayGenerator(dataparser_outputs.cameras)
Expand Down
2 changes: 1 addition & 1 deletion docs/developer_guides/pipelines/fields.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ class Field(nn.Module):

The forward function is the main function you'll use, which takes in RaySamples returns quantities for each sample. You'll notice that the get_density function is called for every field, followed by the get_outputs function.

The get_outputs function is what you need to implement to return custom data. For example, check out of SemanticNerfField where we rely on different FieldHeads to produce correct dimensional outputs for typical quantiites. Our implemented FieldHeads have the following FieldHeadNames names.
The get_outputs function is what you need to implement to return custom data. For example, check out of SemanticNerfField where we rely on different FieldHeads to produce correct dimensional outputs for typical quantities. Our implemented FieldHeads have the following FieldHeadNames names.

```python
class FieldHeadNames(Enum):
Expand Down
4 changes: 2 additions & 2 deletions docs/developer_guides/pipelines/models.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ A model, at a high level, takes in regions of space described by RayBundle objec

## Functions to Implement

[The code](https://github.com/nerfstudio-project/nerfstudio/blob/master/nerfstudio/models/base_model.py) is quite verbose, so here we distill the most important functions with succint descriptions.
[The code](https://github.com/nerfstudio-project/nerfstudio/blob/master/nerfstudio/models/base_model.py) is quite verbose, so here we distill the most important functions with succinct descriptions.

```python
class Model:
Expand Down Expand Up @@ -52,7 +52,7 @@ class Model:
"""Returns the training callbacks, such as updating a density grid for Instant NGP."""

def get_outputs(self, ray_bundle: RayBundle):
"""Process a RayBundle object and return RayOutputs describing quanties for each ray."""
"""Process a RayBundle object and return RayOutputs describing quantities for each ray."""

def get_metrics_dict(self, outputs, batch):
"""Returns metrics dictionary which will be plotted with wandb or tensorboard."""
Expand Down
2 changes: 1 addition & 1 deletion docs/nerfology/model_components/index.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Model components

It can be difficult getting started with NeRFs. The reserach field is still quite new and most of the key nuggets are burried in academic papers. For this reason, we have consoladated many of the key concepts into a series of guides.
It can be difficult getting started with NeRFs. The reserach field is still quite new and most of the key nuggets are burried in academic papers. For this reason, we have consolidated many of the key concepts into a series of guides.

```{toctree}
:maxdepth: 1
Expand Down
6 changes: 3 additions & 3 deletions docs/sdfstudio-data.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ The json file (meta_data.json) stores meta data of the scene and has the followi
'has_mono_prior': true, # use monocular cues or not
'pairs': 'pairs.txt', # pairs file used for multi-view photometric consistency loss
'worldtogt': [
[1, 0, 0, 0], # world to gt transformation (useful for evauation)
[1, 0, 0, 0], # world to gt transformation (useful for evaluation)
[0, 1, 0, 0],
[0, 0, 1, 0],
[0, 0, 0, 1],
Expand All @@ -52,7 +52,7 @@ The json file (meta_data.json) stores meta data of the scene and has the followi
},
'frames': [ # this contains information for each image
{
# note that all paths are relateive path
# note that all paths are relative path
# path of rgb image
'rgb_path': '000000_rgb.png',
# camera to world transform
Expand Down Expand Up @@ -134,7 +134,7 @@ ns-download-data sdfstudio --dataset-name neural-rgbd-data
Then run the following command to convert the downloaded neural-rgbd dataset to SDFStudio format:

```bash
# kitchen scene for example, replca the scene path to convert other scenes
# kitchen scene for example, replica the scene path to convert other scenes
python scripts/datasets/process_neuralrgbd_to_sdfstudio.py --input_path data/neural-rgbd-data/kitchen/ --output_path data/neural_rgbd/kitchen_sensor_depth --type sensor_depth
```

Expand Down