mirror of
https://github.com/nerfstudio-project/nerfstudio.git
synced 2026-11-20 06:35:36 +08:00
Allow methods configs to be discovered from external packages. (#1357)
* Allow method_config to be registered from external packages * Add license * Add MethodSpecification class + fix linter errors ---------
This commit is contained in:
1 parent
bf64769128
commit
59f71eda0e
7 files changed
+183
No files matched your search
@@ -0,0 +1,13 @@
|
||||
# Copyright 2022 The Nerfstudio Team. All rights reserved.
|
||||
#
|
||||
# Licensed under the Apache License, Version 2.0 (the "License");
|
||||
# you may not use this file except in compliance with the License.
|
||||
# You may obtain a copy of the License at
|
||||
#
|
||||
# http://www.apache.org/licenses/LICENSE-2.0
|
||||
#
|
||||
# Unless required by applicable law or agreed to in writing, software
|
||||
# distributed under the License is distributed on an "AS IS" BASIS,
|
||||
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
# See the License for the specific language governing permissions and
|
||||
# limitations under the License.
|
||||
@@ -0,0 +1,50 @@
|
||||
# Copyright 2022 The Nerfstudio Team. All rights reserved.
|
||||
#
|
||||
# Licensed under the Apache License, Version 2.0 (the "License");
|
||||
# you may not use this file except in compliance with the License.
|
||||
# You may obtain a copy of the License at
|
||||
#
|
||||
# http://www.apache.org/licenses/LICENSE-2.0
|
||||
#
|
||||
# Unless required by applicable law or agreed to in writing, software
|
||||
# distributed under the License is distributed on an "AS IS" BASIS,
|
||||
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
# See the License for the specific language governing permissions and
|
||||
# limitations under the License.
|
||||
|
||||
"""
|
||||
Module that keeps all registered plugins and allows for plugin discovery.
|
||||
"""
|
||||
|
||||
import sys
|
||||
import typing as t
|
||||
|
||||
from rich.progress import Console
|
||||
|
||||
from nerfstudio.plugins.types import MethodSpecification
|
||||
|
||||
if sys.version_info < (3, 10):
|
||||
from importlib_metadata import entry_points
|
||||
else:
|
||||
from importlib.metadata import entry_points
|
||||
CONSOLE = Console(width=120)
|
||||
|
||||
|
||||
def discover_methods():
|
||||
"""
|
||||
Discovers all methods registered using the `nerfstudio.method_configs` entrypoint.
|
||||
"""
|
||||
methods = {}
|
||||
descriptions = {}
|
||||
discovered_entry_points = entry_points(group="nerfstudio.method_configs")
|
||||
for name in discovered_entry_points.names:
|
||||
specification = discovered_entry_points[name].load()
|
||||
if not isinstance(specification, MethodSpecification):
|
||||
CONSOLE.print(
|
||||
"[bold yellow]Warning: Could not entry point {n} as it is not an instance of MethodSpecification"
|
||||
)
|
||||
continue
|
||||
specification = t.cast(MethodSpecification, specification)
|
||||
methods[specification.config.method_name] = specification.config
|
||||
descriptions[specification.config.method_name] = specification.description
|
||||
return methods, descriptions
|
||||
@@ -0,0 +1,33 @@
|
||||
# Copyright 2022 The Nerfstudio Team. All rights reserved.
|
||||
#
|
||||
# Licensed under the Apache License, Version 2.0 (the "License");
|
||||
# you may not use this file except in compliance with the License.
|
||||
# You may obtain a copy of the License at
|
||||
#
|
||||
# http://www.apache.org/licenses/LICENSE-2.0
|
||||
#
|
||||
# Unless required by applicable law or agreed to in writing, software
|
||||
# distributed under the License is distributed on an "AS IS" BASIS,
|
||||
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
# See the License for the specific language governing permissions and
|
||||
# limitations under the License.
|
||||
|
||||
"""
|
||||
This package contains specifications used to register plugins.
|
||||
"""
|
||||
from dataclasses import dataclass
|
||||
|
||||
from nerfstudio.engine.trainer import TrainerConfig
|
||||
|
||||
|
||||
@dataclass
|
||||
class MethodSpecification:
|
||||
"""
|
||||
Method specification class used to register custom methods with Nerfstudio.
|
||||
The registered methods will be available in commands such as `ns-train`
|
||||
"""
|
||||
|
||||
config: TrainerConfig
|
||||
"""Trainer configuration"""
|
||||
description: str
|
||||
"""Method description shown in `ns-train` help"""
|
||||
Reference in new issue
Block a user