gt4sd.algorithms.conditional_generation.template.core module¶
Template Algorithm
Summary¶
Classes:
Template Algorithm. |
|
Configuration for specific generator. |
Reference¶
- class Template(configuration, target=None)[source]¶
Bases:
GeneratorAlgorithm[S,T]Template Algorithm.
- __init__(configuration, target=None)[source]¶
Template Generation
- Parameters
configuration (
AlgorithmConfiguration[~S, ~T]) – domain and application specification, defining types and validations.target (
Optional[~T,None]) – Optional depending on the type of generative model. In this template we will convert the target to a string.
Example
An example for using this template:
target = ‘World’ configuration = TemplateGenerator() algorithm = Template(configuration=configuration, target=target) items = list(algorithm.sample(1)) print(items)
- get_generator(configuration, target)[source]¶
Get the function to from generator.
- Parameters
configuration (
AlgorithmConfiguration[~S, ~T]) – helps to set up the application.target (
Optional[~T,None]) – context or condition for the generation. Just an optional string here.
- Return type
Callable[[~T],Iterable[Any]]- Returns
callable generating a list of 1 item containing salutation and temperature converted to fahrenheit.
- validate_configuration(configuration)[source]¶
Overload to validate the a configuration for the algorithm.
- Parameters
configuration (
AlgorithmConfiguration) – the algorithm configuration.- Raises
InvalidAlgorithmConfiguration – in case the configuration for the algorithm is invalid.
- Return type
- Returns
the validated configuration.
- __abstractmethods__ = frozenset({})¶
- __annotations__ = {'generate': 'Untargeted', 'generator': 'Union[Untargeted, Targeted[T]]', 'max_runtime': 'int', 'max_samples': 'int', 'target': 'Optional[T]'}¶
- __doc__ = 'Template Algorithm.'¶
- __module__ = 'gt4sd.algorithms.conditional_generation.template.core'¶
- __orig_bases__ = (gt4sd.algorithms.core.GeneratorAlgorithm[~S, ~T],)¶
- __parameters__ = (~S, ~T)¶
- _abc_impl = <_abc._abc_data object>¶
- class TemplateGenerator(*args, **kwargs)[source]¶
Bases:
TemplateGenerator,Generic[T]Configuration for specific generator.
- algorithm_type: ClassVar[str] = 'conditional_generation'¶
General type of generative algorithm.
- domain: ClassVar[str] = 'materials'¶
General application domain. Hints at input/output types.
- algorithm_version: str = 'v0'¶
To differentiate between different versions of an application.
There is no imposed naming convention.
- temperature: int = 36¶
- get_target_description()[source]¶
Get description of the target for generation. :rtype:
Dict[str,str] :returns: target description.
- __annotations__ = {'algorithm_application': 'ClassVar[str]', 'algorithm_name': 'ClassVar[str]', 'algorithm_type': typing.ClassVar[str], 'algorithm_version': <class 'str'>, 'domain': typing.ClassVar[str], 'temperature': <class 'int'>}¶
- __dataclass_fields__ = {'algorithm_application': Field(name='algorithm_application',type=typing.ClassVar[str],default='TemplateGenerator',default_factory=<dataclasses._MISSING_TYPE object>,init=True,repr=True,hash=None,compare=True,metadata=mappingproxy({}),kw_only=<dataclasses._MISSING_TYPE object>,_field_type=_FIELD_CLASSVAR), 'algorithm_name': Field(name='algorithm_name',type=typing.ClassVar[str],default='Template',default_factory=<dataclasses._MISSING_TYPE object>,init=True,repr=True,hash=None,compare=True,metadata=mappingproxy({}),kw_only=<dataclasses._MISSING_TYPE object>,_field_type=_FIELD_CLASSVAR), 'algorithm_type': Field(name='algorithm_type',type=typing.ClassVar[str],default='conditional_generation',default_factory=<dataclasses._MISSING_TYPE object>,init=True,repr=True,hash=None,compare=True,metadata=mappingproxy({}),kw_only=<dataclasses._MISSING_TYPE object>,_field_type=_FIELD_CLASSVAR), 'algorithm_version': Field(name='algorithm_version',type=<class 'str'>,default='v0',default_factory=<dataclasses._MISSING_TYPE object>,init=True,repr=True,hash=None,compare=True,metadata=mappingproxy({}),kw_only=False,_field_type=_FIELD), 'domain': Field(name='domain',type=typing.ClassVar[str],default='materials',default_factory=<dataclasses._MISSING_TYPE object>,init=True,repr=True,hash=None,compare=True,metadata=mappingproxy({}),kw_only=<dataclasses._MISSING_TYPE object>,_field_type=_FIELD_CLASSVAR), 'temperature': Field(name='temperature',type=<class 'int'>,default=36,default_factory=<dataclasses._MISSING_TYPE object>,init=True,repr=True,hash=None,compare=True,metadata=mappingproxy({'description': 'Temperature parameter ( in celsius )'}),kw_only=False,_field_type=_FIELD)}¶
- __dataclass_params__ = _DataclassParams(init=True,repr=True,eq=True,order=False,unsafe_hash=False,frozen=False)¶
- __doc__ = 'Configuration for specific generator.'¶
- __eq__(other)¶
Return self==value.
- __hash__ = None¶
- __init__(*args, **kwargs)¶
- __match_args__ = ('algorithm_version', 'temperature')¶
- __module__ = 'gt4sd.algorithms.conditional_generation.template.core'¶
- __orig_bases__ = (<class 'types.TemplateGenerator'>, typing.Generic[~T])¶
- __parameters__ = (~T,)¶
- __pydantic_complete__ = True¶
- __pydantic_config__ = {}¶
- __pydantic_core_schema__ = {'cls': <class 'gt4sd.algorithms.conditional_generation.template.core.TemplateGenerator'>, 'config': {'title': 'TemplateGenerator'}, 'fields': ['algorithm_version', 'temperature'], 'frozen': False, 'metadata': {'pydantic_js_annotation_functions': [], 'pydantic_js_functions': [functools.partial(<function modify_model_json_schema>, cls=<class 'gt4sd.algorithms.conditional_generation.template.core.TemplateGenerator'>, title=None)]}, 'post_init': False, 'ref': 'types.TemplateGenerator:94662817415232', 'schema': {'collect_init_only': False, 'computed_fields': [], 'dataclass_name': 'TemplateGenerator', 'fields': [{'type': 'dataclass-field', 'name': 'algorithm_version', 'schema': {'type': 'default', 'schema': {'type': 'str'}, 'default': 'v0'}, 'kw_only': False, 'init': True, 'metadata': {'pydantic_js_functions': [], 'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>]}}, {'type': 'dataclass-field', 'name': 'temperature', 'schema': {'type': 'default', 'schema': {'type': 'int'}, 'default': 36}, 'kw_only': False, 'init': True, 'metadata': {'pydantic_js_functions': [], 'pydantic_js_annotation_functions': [<function get_json_schema_update_func.<locals>.json_schema_update_func>]}}], 'type': 'dataclass-args'}, 'slots': True, 'type': 'dataclass'}¶
- __pydantic_decorators__ = DecoratorInfos(validators={}, field_validators={}, root_validators={}, field_serializers={}, model_serializers={}, model_validators={}, computed_fields={})¶
- __pydantic_fields__ = {'algorithm_version': FieldInfo(annotation=str, required=False, default='v0', init=True, init_var=False, kw_only=False), 'temperature': FieldInfo(annotation=int, required=False, default=36, description='Temperature parameter ( in celsius )', init=True, init_var=False, kw_only=False)}¶
- __pydantic_serializer__ = SchemaSerializer(serializer=Dataclass( DataclassSerializer { class: Py( 0x00005618679b0040, ), serializer: Fields( GeneralFieldsSerializer { fields: { "temperature": SerField { key_py: Py( 0x00007f1dca923db0, ), alias: None, alias_py: None, serializer: Some( WithDefault( WithDefaultSerializer { default: Default( Py( 0x00007f1ea9468550, ), ), serializer: Int( IntSerializer, ), }, ), ), required: true, }, "algorithm_version": SerField { key_py: Py( 0x00007f1dca93e060, ), alias: None, alias_py: None, serializer: Some( WithDefault( WithDefaultSerializer { default: Default( Py( 0x00007f1ea52cf3f0, ), ), serializer: Str( StrSerializer, ), }, ), ), required: true, }, }, computed_fields: Some( ComputedFields( [], ), ), mode: SimpleDict, extra_serializer: None, filter: SchemaFilter { include: None, exclude: None, }, required_fields: 2, }, ), fields: [ Py( 0x00007f1ea52ed250, ), Py( 0x00007f1e33d8d4b0, ), ], name: "TemplateGenerator", }, ), definitions=[])¶
- __pydantic_validator__ = SchemaValidator(title="TemplateGenerator", validator=Dataclass( DataclassValidator { strict: false, validator: DataclassArgs( DataclassArgsValidator { fields: [ Field { kw_only: false, name: "algorithm_version", py_name: Py( 0x00007f1ea52ed250, ), init: true, init_only: false, lookup_key: Simple { key: "algorithm_version", py_key: Py( 0x00007f1dca93e0b0, ), path: LookupPath( [ S( "algorithm_version", Py( 0x00007f1dca93e100, ), ), ], ), }, validator: WithDefault( WithDefaultValidator { default: Default( Py( 0x00007f1ea52cf3f0, ), ), on_error: Raise, validator: Str( StrValidator { strict: false, coerce_numbers_to_str: false, }, ), validate_default: false, copy_default: false, name: "default[str]", undefined: Py( 0x00007f1ea71db950, ), }, ), frozen: false, }, Field { kw_only: false, name: "temperature", py_name: Py( 0x00007f1e33d8d4b0, ), init: true, init_only: false, lookup_key: Simple { key: "temperature", py_key: Py( 0x00007f1dca923fb0, ), path: LookupPath( [ S( "temperature", Py( 0x00007f1dca923d30, ), ), ], ), }, validator: WithDefault( WithDefaultValidator { default: Default( Py( 0x00007f1ea9468550, ), ), on_error: Raise, validator: Int( IntValidator { strict: false, }, ), validate_default: false, copy_default: false, name: "default[int]", undefined: Py( 0x00007f1ea71db950, ), }, ), frozen: false, }, ], positional_count: 2, init_only_count: None, dataclass_name: "TemplateGenerator", validator_name: "dataclass-args[TemplateGenerator]", extra_behavior: Ignore, extras_validator: None, loc_by_alias: true, }, ), class: Py( 0x00005618679b0040, ), fields: [ Py( 0x00007f1ea52ed250, ), Py( 0x00007f1e33d8d4b0, ), ], post_init: None, revalidate: Never, name: "TemplateGenerator", frozen: false, slots: true, }, ), definitions=[], cache_strings=True)¶
- __repr__()¶
Return repr(self).
- __signature__ = <Signature (algorithm_version: str = 'v0', temperature: int = 36) -> None>¶
- __wrapped__¶
alias of
TemplateGenerator