From d947f6e4858837a284e6c3457316a88c539467b2 Mon Sep 17 00:00:00 2001 From: drewgilliam Date: Thu, 7 Sep 2023 14:17:03 -0400 Subject: [PATCH] Update engine docs (#2405) * build docs for nerfstudio.engine.trainer and nerfstudio.engine.callbacks * docs minor edit for new_methods.md --- docs/developer_guides/new_methods.md | 2 +- docs/reference/api/optimizers.rst | 14 ++++++++++++++ 2 files changed, 15 insertions(+), 1 deletion(-) diff --git a/docs/developer_guides/new_methods.md b/docs/developer_guides/new_methods.md index 6deced451..a8f8bd423 100644 --- a/docs/developer_guides/new_methods.md +++ b/docs/developer_guides/new_methods.md @@ -88,7 +88,7 @@ from nerfstudio.engine.trainer import TrainerConfig from nerfstudio.plugins.types import MethodSpecification def MyMethodFunc(): - return = MethodSpecification( + return MethodSpecification( config=TrainerConfig(...) description="Custom description" ) diff --git a/docs/reference/api/optimizers.rst b/docs/reference/api/optimizers.rst index ed697daf3..c5799aac1 100644 --- a/docs/reference/api/optimizers.rst +++ b/docs/reference/api/optimizers.rst @@ -16,3 +16,17 @@ Schedulers .. automodule:: nerfstudio.engine.schedulers :members: :show-inheritance: + +Trainer +---------------- + +.. automodule:: nerfstudio.engine.trainer + :members: + :show-inheritance: + +Callbacks +---------------- + +.. automodule:: nerfstudio.engine.callbacks + :members: + :show-inheritance: