Source code for dgenerate.promptweighters.promptweighterloader

# Copyright (c) 2023, Teriks
#
# dgenerate is distributed under the following BSD 3-Clause License
#
# Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
#
# 1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
#
# 2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in
#    the documentation and/or other materials provided with the distribution.
#
# 3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived
#    from this software without specific prior written permission.
#
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
# HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
# ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

import dgenerate.promptweighters.promptweighter as _promptweighter
import dgenerate.promptweighters.exceptions as _exceptions
import dgenerate.plugin as _plugin
from dgenerate.plugin import PluginArg as _Pa
import dgenerate.pipelinewrapper.enums as _enums
import dgenerate.types as _types
import typing


[docs] class PromptWeighterLoader(_plugin.PluginLoader): """ Loads :py:class:`dgenerate.promptweighters.PromptWeighter` plugins. """
[docs] def __init__(self): """""" # The empty string above disables sphinx inherited doc super().__init__(base_class=_promptweighter.PromptWeighter, description='prompt weighter', reserved_args=[_Pa('model-type', type=_enums.ModelType), _Pa('pipeline-type', type=_enums.PipelineType), _Pa('dtype', type=_enums.DataType)], argument_error_type=_exceptions.PromptWeighterArgumentError, not_found_error_type=_exceptions.PromptWeighterNotFoundError) self.add_search_module_string('dgenerate.promptweighters')
[docs] def load(self, uri: _types.Uri, **kwargs) -> _promptweighter.PromptWeighter: return typing.cast(_promptweighter.PromptWeighter, super().load(uri, **kwargs))