Skip to content

Commit

Permalink
remove stray "generic_model_args" references
Browse files Browse the repository at this point in the history
Summary:
generic_model_args no longer exists. Update some references to it, mostly in doc.

This fixes the testing of all the yaml files in test_forward pass.

Reviewed By: shapovalov

Differential Revision: D38789202

fbshipit-source-id: f11417efe772d7f86368b3598aa66c52b1309dbf
  • Loading branch information
bottler authored and facebook-github-bot committed Aug 18, 2022
1 parent d42e0d3 commit fdaaa29
Show file tree
Hide file tree
Showing 4 changed files with 44 additions and 28 deletions.
52 changes: 32 additions & 20 deletions projects/implicitron_trainer/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,9 @@ To run training, pass a yaml config file, followed by a list of overridden argum
For example, to train NeRF on the first skateboard sequence from CO3D dataset, you can run:
```shell
dataset_args=data_source_args.dataset_map_provider_JsonIndexDatasetMapProvider_args
pytorch3d_implicitron_runner --config-path ./configs/ --config-name repro_singleseq_nerf $dataset_args.dataset_root=<DATASET_ROOT> $dataset_args.category='skateboard' $dataset_args.test_restrict_sequence_id=0 test_when_finished=True exp_dir=<CHECKPOINT_DIR>
pytorch3d_implicitron_runner --config-path ./configs/ --config-name repro_singleseq_nerf \
$dataset_args.dataset_root=<DATASET_ROOT> $dataset_args.category='skateboard' \
$dataset_args.test_restrict_sequence_id=0 test_when_finished=True exp_dir=<CHECKPOINT_DIR>
```

Here, `--config-path` points to the config path relative to `pytorch3d_implicitron_runner` location;
Expand All @@ -86,7 +88,9 @@ To run evaluation on the latest checkpoint after (or during) training, simply ad
E.g. for executing the evaluation on the NeRF skateboard sequence, you can run:
```shell
dataset_args=data_source_args.dataset_map_provider_JsonIndexDatasetMapProvider_args
pytorch3d_implicitron_runner --config-path ./configs/ --config-name repro_singleseq_nerf $dataset_args.dataset_root=<CO3D_DATASET_ROOT> $dataset_args.category='skateboard' $dataset_args.test_restrict_sequence_id=0 exp_dir=<CHECKPOINT_DIR> eval_only=True
pytorch3d_implicitron_runner --config-path ./configs/ --config-name repro_singleseq_nerf \
$dataset_args.dataset_root=<CO3D_DATASET_ROOT> $dataset_args.category='skateboard' \
$dataset_args.test_restrict_sequence_id=0 exp_dir=<CHECKPOINT_DIR> eval_only=True
```
Evaluation prints the metrics to `stdout` and dumps them to a json file in `exp_dir`.

Expand All @@ -101,7 +105,8 @@ conda install ffmpeg

Here is an example of calling the script:
```shell
projects/implicitron_trainer/visualize_reconstruction.py exp_dir=<CHECKPOINT_DIR> visdom_show_preds=True n_eval_cameras=40 render_size="[64,64]" video_size="[256,256]"
projects/implicitron_trainer/visualize_reconstruction.py exp_dir=<CHECKPOINT_DIR> \
visdom_show_preds=True n_eval_cameras=40 render_size="[64,64]" video_size="[256,256]"
```

The argument `n_eval_cameras` sets the number of renderring viewpoints sampled on a trajectory, which defaults to a circular fly-around;
Expand All @@ -124,18 +129,21 @@ In the config, inner parameters can be propagated using `_args` postfix, e.g. to

The root of the hierarchy is defined by `ExperimentConfig` dataclass.
It has top-level fields like `eval_only` which was used above for running evaluation by adding a CLI override.
Additionally, it has non-leaf nodes like `generic_model_args`, which dispatches the config parameters to `GenericModel`. Thus, changing the model parameters may be achieved in two ways: either by editing the config file, e.g.
Additionally, it has non-leaf nodes like `model_factory_ImplicitronModelFactory_args.model_GenericModel_args`, which dispatches the config parameters to `GenericModel`.
Thus, changing the model parameters may be achieved in two ways: either by editing the config file, e.g.
```yaml
generic_model_args:
render_image_width: 800
raysampler_args:
n_pts_per_ray_training: 128
model_factory_ImplicitronModelFactory_args:
model_GenericModel_args:
render_image_width: 800
raysampler_args:
n_pts_per_ray_training: 128
```

or, equivalently, by adding the following to `pytorch3d_implicitron_runner` arguments:

```shell
generic_model_args.render_image_width=800 generic_model_args.raysampler_args.n_pts_per_ray_training=128
model_args=model_factory_ImplicitronModelFactory_args.model_GenericModel_args
$model_args.render_image_width=800 $model_args.raysampler_args.n_pts_per_ray_training=128
```

See the documentation in `pytorch3d/implicitron/tools/config.py` for more details.
Expand All @@ -149,11 +157,12 @@ This means that other Configurables can refer to them using the base type, while
In that case, `_args` node name has to include the implementation type.
More specifically, to change renderer settings, the config will look like this:
```yaml
generic_model_args:
renderer_class_type: LSTMRenderer
renderer_LSTMRenderer_args:
num_raymarch_steps: 10
hidden_size: 16
model_factory_ImplicitronModelFactory_args:
model_GenericModel_args:
renderer_class_type: LSTMRenderer
renderer_LSTMRenderer_args:
num_raymarch_steps: 10
hidden_size: 16
```

See the documentation in `pytorch3d/implicitron/tools/config.py` for more details on the configuration system.
Expand Down Expand Up @@ -188,15 +197,17 @@ class XRayRenderer(BaseRenderer, torch.nn.Module):
```

Please note `@registry.register` decorator that registers the plug-in as an implementation of `Renderer`.
IMPORTANT: In order for it to run, the class (or its enclosing module) has to be imported in your launch script. Additionally, this has to be done before parsing the root configuration class `ExperimentConfig`.
IMPORTANT: In order for it to run, the class (or its enclosing module) has to be imported in your launch script.
Additionally, this has to be done before parsing the root configuration class `ExperimentConfig`.
Simply add `import .x_ray_renderer` in the beginning of `experiment.py`.

After that, you should be able to change the config with:
```yaml
generic_model_args:
renderer_class_type: XRayRenderer
renderer_XRayRenderer_args:
n_pts_per_ray: 128
model_factory_ImplicitronModelFactory_args:
model_GenericModel_args:
renderer_class_type: XRayRenderer
renderer_XRayRenderer_args:
n_pts_per_ray: 128
```

to replace the implementation and potentially override the parameters.
Expand Down Expand Up @@ -252,7 +263,8 @@ model_GenericModel_args: GenericModel
╘== ReductionFeatureAggregator
```

Please look at the annotations of the respective classes or functions for the lists of hyperparameters. `tests/experiment.yaml` shows every possible option if you have no user-defined classes.
Please look at the annotations of the respective classes or functions for the lists of hyperparameters.
`tests/experiment.yaml` shows every possible option if you have no user-defined classes.

# Reproducing CO3D experiments

Expand Down
6 changes: 4 additions & 2 deletions projects/implicitron_trainer/visualize_reconstruction.py
Original file line number Diff line number Diff line change
Expand Up @@ -333,8 +333,10 @@ def export_scenes(
)
dataset_args.test_on_train = False
# Set the rendering image size
config.generic_model_args.render_image_width = render_size[0]
config.generic_model_args.render_image_height = render_size[1]
model_factory_args = config.model_factory_ImplicitronModelFactory_args
model_args = model_factory_args.model_GenericModel_args
model_args.render_image_width = render_size[0]
model_args.render_image_height = render_size[1]
if restrict_sequence_name is not None:
dataset_args.restrict_sequence_name = restrict_sequence_name

Expand Down
5 changes: 3 additions & 2 deletions pytorch3d/implicitron/models/generic_model.py
Original file line number Diff line number Diff line change
Expand Up @@ -131,8 +131,9 @@ class GenericModel(ImplicitronModelBase): # pyre-ignore: 13
for more details on how to create and register a custom component.
In the config .yaml files for experiments, the parameters below are
contained in the `generic_model_args` node. As GenericModel
derives from Configurable, the input arguments are
contained in the
`model_factory_ImplicitronModelFactory_args.model_GenericModel_args`
node. As GenericModel derives from ReplaceableBase, the input arguments are
parsed by the run_auto_creation function to initialize the
necessary member modules. Please see implicitron_trainer/README.md
for more details on this process.
Expand Down
9 changes: 5 additions & 4 deletions tests/implicitron/test_forward_pass.py
Original file line number Diff line number Diff line change
Expand Up @@ -207,10 +207,11 @@ def _load_model_config_from_yaml(config_path, strict=True) -> DictConfig:

def _load_model_config_from_yaml_rec(cfg: DictConfig, config_path: str) -> DictConfig:
cfg_loaded = OmegaConf.load(config_path)
if "generic_model_args" in cfg_loaded:
cfg_model_loaded = cfg_loaded.generic_model_args
else:
cfg_model_loaded = None
cfg_model_loaded = None
if "model_factory_ImplicitronModelFactory_args" in cfg_loaded:
factory_args = cfg_loaded.model_factory_ImplicitronModelFactory_args
if "model_GenericModel_args" in factory_args:
cfg_model_loaded = factory_args.model_GenericModel_args
defaults = cfg_loaded.pop("defaults", None)
if defaults is not None:
for default_name in defaults:
Expand Down

0 comments on commit fdaaa29

Please sign in to comment.