# Copyright The Caikit Authors
#
# 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.
"""
A ModelInitializer is responsible for taking an in-memory ModuleConfig and
producing a usable Module instance.
Configuration for ModelInitializers lives under the config as follows:
model_management:
initializers:
<initializer name>:
type: <initializer type name>
config:
<config option>: <value>
"""
# Standard
from typing import Optional
import abc
# Local
from ..modules import ModuleBase, ModuleConfig
from ..toolkit.factory import FactoryConstructible
[docs]
class ModelInitializerBase(FactoryConstructible):
__doc__ = __doc__
[docs]
@abc.abstractmethod
def init(
self,
model_config: ModuleConfig,
**kwargs,
) -> Optional[ModuleBase]:
"""Given a ModelConfig, attempt to initialize it for running
Args:
model_config (ModuleConfig): The in-memory model config object for
the model to be loaded
**kwargs: All loaders must allow additional kwargs through so that
specific finders and loaders can support additional optional
arguments.
Returns:
model (Optional[ModuleBase]): The in-memory ModuleBase instance that
is ready to run if successful. If unable to load, an exception
may be raised, or None may be returned.
"""