gt4sd.algorithms.generation.hugging_face.core module¶

HuggingFace generation algorithm.

Summary¶

Classes:

`HuggingFaceCTRLGenerator`	Configuration to generate text using CTRL.
`HuggingFaceConfiguration`	Basic configuration for an hugging face algorithm.
`HuggingFaceGPT2Generator`	Configuration to generate text using GPT2.
`HuggingFaceGenerationAlgorithm`
`HuggingFaceOpenAIGPTGenerator`	Configuration to generate text using OpenAIGPT.
`HuggingFaceSeq2SeqGenerator`	Configuration to generate text using Seq2Seq LMs.
`HuggingFaceTransfoXLGenerator`	Configuration to generate text using TransfoXL.
`HuggingFaceXLMGenerator`	Configuration to generate text using XLM.
`HuggingFaceXLNetGenerator`	Configuration to generate text using XLNet.

Reference¶

class HuggingFaceGenerationAlgorithm(configuration, target=None)[source]¶

Bases: GeneratorAlgorithm[S, None]

__init__(configuration, target=None)[source]¶

HuggingFace generation algorithm.

Parameters

configuration (AlgorithmConfiguration) – domain and application specification, defining types and validations.
target (None) – unused since it is not a conditional generator.

Example

An example for using a generative algorithm from HuggingFace:

configuration = HuggingFaceXLMGenerator()
algorithm = HuggingFaceGenerationAlgorithm(configuration=configuration)
items = list(algorithm.sample(1))
print(items)

get_generator(configuration, target)[source]¶

Get the function to sample batches.

Parameters

configuration (AlgorithmConfiguration[~S, None]) – helps to set up the application.
target (None) – context or condition for the generation. Unused in the algorithm.

Return type

Callable[[], Iterable[Any]]

Returns

callable generating a batch of items.

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: AlgorithmConfiguration
Returns: the validated configuration.

__abstractmethods__ = frozenset({})¶

__annotations__ = {'generate': 'Untargeted', 'generator': 'Union[Untargeted, Targeted[T]]', 'max_runtime': 'int', 'max_samples': 'int', 'target': 'Optional[T]'}¶

__doc__ = None¶

__module__ = 'gt4sd.algorithms.generation.hugging_face.core'¶

__orig_bases__ = (gt4sd.algorithms.core.GeneratorAlgorithm[~S, NoneType],)¶

__parameters__ = (~S,)¶

_abc_impl = <_abc._abc_data object>¶

class HuggingFaceConfiguration(*args, **kwargs)[source]¶

Bases: HuggingFaceConfiguration, Generic[T]

Basic configuration for an hugging face algorithm.

algorithm_type: ClassVar[str] = 'generation'¶: General type of generative algorithm.

domain: ClassVar[str] = 'nlp'¶: General application domain. Hints at input/output types.

model_type: str = ''¶

prompt: str = "I'm a stochastic parrot."¶

length: int = 20¶

stop_token: str = ''¶

num_beams: int = 1¶

do_sample: bool = True¶

temperature: float = 1.0¶

repetition_penalty: float = 1.0¶

k: int = 50¶

p: float = 1.0¶

prefix: str = ''¶

number_of_sequences: int = 8¶

get_target_description()[source]¶

Get description of the target for generation.

Return type: Optional[Dict[str, str], None]
Returns: target description, returns None in case no target is used.

get_conditional_generator(resources_path, **kwargs)[source]¶

Return type: Generator

__annotations__ = {'algorithm_application': 'ClassVar[str]', 'algorithm_name': 'ClassVar[str]', 'algorithm_type': typing.ClassVar[str], 'algorithm_version': 'str', 'do_sample': <class 'bool'>, 'domain': typing.ClassVar[str], 'k': <class 'int'>, 'length': <class 'int'>, 'model_type': <class 'str'>, 'num_beams': <class 'int'>, 'number_of_sequences': <class 'int'>, 'p': <class 'float'>, 'prefix': <class 'str'>, 'prompt': <class 'str'>, 'repetition_penalty': <class 'float'>, 'stop_token': <class 'str'>, 'temperature': <class 'float'>}¶

__dataclass_fields__ = {'algorithm_application': Field(name='algorithm_application',type=typing.ClassVar[str],default='HuggingFaceConfiguration',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='HuggingFaceGenerationAlgorithm',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='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='str',default='',default_factory=<dataclasses._MISSING_TYPE object>,init=True,repr=True,hash=None,compare=True,metadata=mappingproxy({}),kw_only=False,_field_type=_FIELD), 'do_sample': Field(name='do_sample',type=<class 'bool'>,default=True,default_factory=<dataclasses._MISSING_TYPE object>,init=True,repr=True,hash=None,compare=True,metadata=mappingproxy({'description': 'Whether or not to use sampling; use greedy decoding otherwise.'}),kw_only=False,_field_type=_FIELD), 'domain': Field(name='domain',type=typing.ClassVar[str],default='nlp',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), 'k': Field(name='k',type=<class 'int'>,default=50,default_factory=<dataclasses._MISSING_TYPE object>,init=True,repr=True,hash=None,compare=True,metadata=mappingproxy({'description': 'Number of top-k probability tokens to keep.'}),kw_only=False,_field_type=_FIELD), 'length': Field(name='length',type=<class 'int'>,default=20,default_factory=<dataclasses._MISSING_TYPE object>,init=True,repr=True,hash=None,compare=True,metadata=mappingproxy({'description': 'Length of the generated text.'}),kw_only=False,_field_type=_FIELD), 'model_type': Field(name='model_type',type=<class 'str'>,default='',default_factory=<dataclasses._MISSING_TYPE object>,init=True,repr=True,hash=None,compare=True,metadata=mappingproxy({'description': 'Type of the model. Supported: gpt2, ctrl, openai-gpt, xlnet, transfo-xl, xlm, auto-seq2seq-lm'}),kw_only=False,_field_type=_FIELD), 'num_beams': Field(name='num_beams',type=<class 'int'>,default=1,default_factory=<dataclasses._MISSING_TYPE object>,init=True,repr=True,hash=None,compare=True,metadata=mappingproxy({'description': 'Number of beams for beam search.'}),kw_only=False,_field_type=_FIELD), 'number_of_sequences': Field(name='number_of_sequences',type=<class 'int'>,default=8,default_factory=<dataclasses._MISSING_TYPE object>,init=True,repr=True,hash=None,compare=True,metadata=mappingproxy({'description': 'Number of text sequences to generate.'}),kw_only=False,_field_type=_FIELD), 'p': Field(name='p',type=<class 'float'>,default=1.0,default_factory=<dataclasses._MISSING_TYPE object>,init=True,repr=True,hash=None,compare=True,metadata=mappingproxy({'description': 'Only tokens with cumulative probabilities summing up to this value are kept.'}),kw_only=False,_field_type=_FIELD), 'prefix': Field(name='prefix',type=<class 'str'>,default='',default_factory=<dataclasses._MISSING_TYPE object>,init=True,repr=True,hash=None,compare=True,metadata=mappingproxy({'description': 'Text defining context provided prior to the prompt.'}),kw_only=False,_field_type=_FIELD), 'prompt': Field(name='prompt',type=<class 'str'>,default="I'm a stochastic parrot.",default_factory=<dataclasses._MISSING_TYPE object>,init=True,repr=True,hash=None,compare=True,metadata=mappingproxy({'description': 'Prompt for text generation.'}),kw_only=False,_field_type=_FIELD), 'repetition_penalty': Field(name='repetition_penalty',type=<class 'float'>,default=1.0,default_factory=<dataclasses._MISSING_TYPE object>,init=True,repr=True,hash=None,compare=True,metadata=mappingproxy({'description': 'Primarily useful for CTRL model, where 1.2 should be used.'}),kw_only=False,_field_type=_FIELD), 'stop_token': Field(name='stop_token',type=<class 'str'>,default='',default_factory=<dataclasses._MISSING_TYPE object>,init=True,repr=True,hash=None,compare=True,metadata=mappingproxy({'description': 'Stop token for text generation.'}),kw_only=False,_field_type=_FIELD), 'temperature': Field(name='temperature',type=<class 'float'>,default=1.0,default_factory=<dataclasses._MISSING_TYPE object>,init=True,repr=True,hash=None,compare=True,metadata=mappingproxy({'description': 'Temperature for sampling, the lower the greedier the sampling.'}),kw_only=False,_field_type=_FIELD)}¶

__dataclass_params__ = _DataclassParams(init=True,repr=True,eq=True,order=False,unsafe_hash=False,frozen=False)¶

__doc__ = 'Basic configuration for an hugging face algorithm.'¶

__eq__(other)¶: Return self==value.

__hash__ = None¶

__init__(*args, **kwargs)¶

__is_pydantic_dataclass__ = True¶

__match_args__ = ('algorithm_version', 'model_type', 'prompt', 'length', 'stop_token', 'num_beams', 'do_sample', 'temperature', 'repetition_penalty', 'k', 'p', 'prefix', 'number_of_sequences')¶

__module__ = 'gt4sd.algorithms.generation.hugging_face.core'¶

__orig_bases__ = (<class 'types.HuggingFaceConfiguration'>, typing.Generic[~T])¶

__parameters__ = (~T,)¶

__pydantic_complete__ = True¶

__pydantic_config__ = {}¶

__pydantic_core_schema__ = {'cls': <class 'gt4sd.algorithms.generation.hugging_face.core.HuggingFaceConfiguration'>, 'config': {'title': 'HuggingFaceConfiguration'}, 'fields': ['algorithm_version', 'model_type', 'prompt', 'length', 'stop_token', 'num_beams', 'do_sample', 'temperature', 'repetition_penalty', 'k', 'p', 'prefix', 'number_of_sequences'], 'frozen': False, 'post_init': False, 'ref': 'types.HuggingFaceConfiguration:94818327559456', 'schema': {'collect_init_only': False, 'computed_fields': [], 'dataclass_name': 'HuggingFaceConfiguration', 'fields': [{'type': 'dataclass-field', 'name': 'algorithm_version', 'schema': {'type': 'default', 'schema': {'type': 'str'}, 'default': ''}, 'kw_only': False, 'init': True, 'metadata': {}}, {'type': 'dataclass-field', 'name': 'model_type', 'schema': {'type': 'default', 'schema': {'type': 'str'}, 'default': ''}, 'kw_only': False, 'init': True, 'metadata': {'pydantic_js_updates': {'description': 'Type of the model. Supported: gpt2, ctrl, openai-gpt, xlnet, transfo-xl, xlm, auto-seq2seq-lm'}}}, {'type': 'dataclass-field', 'name': 'prompt', 'schema': {'type': 'default', 'schema': {'type': 'str'}, 'default': "I'm a stochastic parrot."}, 'kw_only': False, 'init': True, 'metadata': {'pydantic_js_updates': {'description': 'Prompt for text generation.'}}}, {'type': 'dataclass-field', 'name': 'length', 'schema': {'type': 'default', 'schema': {'type': 'int'}, 'default': 20}, 'kw_only': False, 'init': True, 'metadata': {'pydantic_js_updates': {'description': 'Length of the generated text.'}}}, {'type': 'dataclass-field', 'name': 'stop_token', 'schema': {'type': 'default', 'schema': {'type': 'str'}, 'default': ''}, 'kw_only': False, 'init': True, 'metadata': {'pydantic_js_updates': {'description': 'Stop token for text generation.'}}}, {'type': 'dataclass-field', 'name': 'num_beams', 'schema': {'type': 'default', 'schema': {'type': 'int'}, 'default': 1}, 'kw_only': False, 'init': True, 'metadata': {'pydantic_js_updates': {'description': 'Number of beams for beam search.'}}}, {'type': 'dataclass-field', 'name': 'do_sample', 'schema': {'type': 'default', 'schema': {'type': 'bool'}, 'default': True}, 'kw_only': False, 'init': True, 'metadata': {'pydantic_js_updates': {'description': 'Whether or not to use sampling; use greedy decoding otherwise.'}}}, {'type': 'dataclass-field', 'name': 'temperature', 'schema': {'type': 'default', 'schema': {'type': 'float'}, 'default': 1.0}, 'kw_only': False, 'init': True, 'metadata': {'pydantic_js_updates': {'description': 'Temperature for sampling, the lower the greedier the sampling.'}}}, {'type': 'dataclass-field', 'name': 'repetition_penalty', 'schema': {'type': 'default', 'schema': {'type': 'float'}, 'default': 1.0}, 'kw_only': False, 'init': True, 'metadata': {'pydantic_js_updates': {'description': 'Primarily useful for CTRL model, where 1.2 should be used.'}}}, {'type': 'dataclass-field', 'name': 'k', 'schema': {'type': 'default', 'schema': {'type': 'int'}, 'default': 50}, 'kw_only': False, 'init': True, 'metadata': {'pydantic_js_updates': {'description': 'Number of top-k probability tokens to keep.'}}}, {'type': 'dataclass-field', 'name': 'p', 'schema': {'type': 'default', 'schema': {'type': 'float'}, 'default': 1.0}, 'kw_only': False, 'init': True, 'metadata': {'pydantic_js_updates': {'description': 'Only tokens with cumulative probabilities summing up to this value are kept.'}}}, {'type': 'dataclass-field', 'name': 'prefix', 'schema': {'type': 'default', 'schema': {'type': 'str'}, 'default': ''}, 'kw_only': False, 'init': True, 'metadata': {'pydantic_js_updates': {'description': 'Text defining context provided prior to the prompt.'}}}, {'type': 'dataclass-field', 'name': 'number_of_sequences', 'schema': {'type': 'default', 'schema': {'type': 'int'}, 'default': 8}, 'kw_only': False, 'init': True, 'metadata': {'pydantic_js_updates': {'description': 'Number of text sequences to generate.'}}}], '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='', init=True, kw_only=False), 'do_sample': FieldInfo(annotation=bool, required=False, default=True, description='Whether or not to use sampling; use greedy decoding otherwise.', init=True, kw_only=False), 'k': FieldInfo(annotation=int, required=False, default=50, description='Number of top-k probability tokens to keep.', init=True, kw_only=False), 'length': FieldInfo(annotation=int, required=False, default=20, description='Length of the generated text.', init=True, kw_only=False), 'model_type': FieldInfo(annotation=str, required=False, default='', description='Type of the model. Supported: gpt2, ctrl, openai-gpt, xlnet, transfo-xl, xlm, auto-seq2seq-lm', init=True, kw_only=False), 'num_beams': FieldInfo(annotation=int, required=False, default=1, description='Number of beams for beam search.', init=True, kw_only=False), 'number_of_sequences': FieldInfo(annotation=int, required=False, default=8, description='Number of text sequences to generate.', init=True, kw_only=False), 'p': FieldInfo(annotation=float, required=False, default=1.0, description='Only tokens with cumulative probabilities summing up to this value are kept.', init=True, kw_only=False), 'prefix': FieldInfo(annotation=str, required=False, default='', description='Text defining context provided prior to the prompt.', init=True, kw_only=False), 'prompt': FieldInfo(annotation=str, required=False, default="I'm a stochastic parrot.", description='Prompt for text generation.', init=True, kw_only=False), 'repetition_penalty': FieldInfo(annotation=float, required=False, default=1.0, description='Primarily useful for CTRL model, where 1.2 should be used.', init=True, kw_only=False), 'stop_token': FieldInfo(annotation=str, required=False, default='', description='Stop token for text generation.', init=True, kw_only=False), 'temperature': FieldInfo(annotation=float, required=False, default=1.0, description='Temperature for sampling, the lower the greedier the sampling.', init=True, kw_only=False)}¶

classmethod __pydantic_fields_complete__()¶

Return whether the fields were successfully collected (i.e. type hints were successfully resolved).

This is a private helper, not meant to be used outside Pydantic.

Return type: bool

__pydantic_serializer__ = SchemaSerializer(serializer=PolymorphismTrampoline( PolymorphismTrampoline { class: Py( 0x0000563c9cbb7d20, ), serializer: PolymorphismTrampoline( PolymorphismTrampoline { class: Py( 0x0000563c9cbb7d20, ), serializer: Dataclass( DataclassSerializer { class: Py( 0x0000563c9cbb7d20, ), serializer: Fields( GeneralFieldsSerializer { fields: { "algorithm_version": SerField { key: "algorithm_version", alias: None, serializer: Some( WithDefault( WithDefaultSerializer { default: Default( Py( 0x00007f222f308030, ), ), serializer: Str( StrSerializer, ), }, ), ), required: true, serialize_by_alias: None, serialization_exclude_if: None, }, "num_beams": SerField { key: "num_beams", alias: None, serializer: Some( WithDefault( WithDefaultSerializer { default: Default( Py( 0x00007f222f3000f0, ), ), serializer: Int( IntSerializer, ), }, ), ), required: true, serialize_by_alias: None, serialization_exclude_if: None, }, "k": SerField { key: "k", alias: None, serializer: Some( WithDefault( WithDefaultSerializer { default: Default( Py( 0x00007f222f300710, ), ), serializer: Int( IntSerializer, ), }, ), ), required: true, serialize_by_alias: None, serialization_exclude_if: None, }, "model_type": SerField { key: "model_type", alias: None, serializer: Some( WithDefault( WithDefaultSerializer { default: Default( Py( 0x00007f222f308030, ), ), serializer: Str( StrSerializer, ), }, ), ), required: true, serialize_by_alias: None, serialization_exclude_if: None, }, "p": SerField { key: "p", alias: None, serializer: Some( WithDefault( WithDefaultSerializer { default: Default( Py( 0x00007f214cdf2910, ), ), serializer: Float( FloatSerializer { inf_nan_mode: Null, }, ), }, ), ), required: true, serialize_by_alias: None, serialization_exclude_if: None, }, "length": SerField { key: "length", alias: None, serializer: Some( WithDefault( WithDefaultSerializer { default: Default( Py( 0x00007f222f300350, ), ), serializer: Int( IntSerializer, ), }, ), ), required: true, serialize_by_alias: None, serialization_exclude_if: None, }, "temperature": SerField { key: "temperature", alias: None, serializer: Some( WithDefault( WithDefaultSerializer { default: Default( Py( 0x00007f214cdf2910, ), ), serializer: Float( FloatSerializer { inf_nan_mode: Null, }, ), }, ), ), required: true, serialize_by_alias: None, serialization_exclude_if: None, }, "number_of_sequences": SerField { key: "number_of_sequences", alias: None, serializer: Some( WithDefault( WithDefaultSerializer { default: Default( Py( 0x00007f222f3001d0, ), ), serializer: Int( IntSerializer, ), }, ), ), required: true, serialize_by_alias: None, serialization_exclude_if: None, }, "stop_token": SerField { key: "stop_token", alias: None, serializer: Some( WithDefault( WithDefaultSerializer { default: Default( Py( 0x00007f222f308030, ), ), serializer: Str( StrSerializer, ), }, ), ), required: true, serialize_by_alias: None, serialization_exclude_if: None, }, "repetition_penalty": SerField { key: "repetition_penalty", alias: None, serializer: Some( WithDefault( WithDefaultSerializer { default: Default( Py( 0x00007f214cdf2910, ), ), serializer: Float( FloatSerializer { inf_nan_mode: Null, }, ), }, ), ), required: true, serialize_by_alias: None, serialization_exclude_if: None, }, "prompt": SerField { key: "prompt", alias: None, serializer: Some( WithDefault( WithDefaultSerializer { default: Default( Py( 0x00007f214712b2d0, ), ), serializer: Str( StrSerializer, ), }, ), ), required: true, serialize_by_alias: None, serialization_exclude_if: None, }, "prefix": SerField { key: "prefix", alias: None, serializer: Some( WithDefault( WithDefaultSerializer { default: Default( Py( 0x00007f222f308030, ), ), serializer: Str( StrSerializer, ), }, ), ), required: true, serialize_by_alias: None, serialization_exclude_if: None, }, "do_sample": SerField { key: "do_sample", alias: None, serializer: Some( WithDefault( WithDefaultSerializer { default: Default( Py( 0x0000563c55c1c6e0, ), ), serializer: Bool( BoolSerializer, ), }, ), ), required: true, serialize_by_alias: None, serialization_exclude_if: None, }, }, computed_fields: Some( ComputedFields( [], ), ), mode: SimpleDict, extra_serializer: None, filter: SchemaFilter { include: None, exclude: None, }, required_fields: 13, }, ), fields: [ Py( 0x00007f222affaf10, ), Py( 0x00007f222ba93fb0, ), Py( 0x00007f222ef49930, ), Py( 0x00007f222ec451b0, ), Py( 0x00007f221b70d830, ), Py( 0x00007f2166ad85f0, ), Py( 0x00007f2166ab6730, ), Py( 0x00007f21b65bb8b0, ), Py( 0x00007f2166ab2c90, ), Py( 0x00007f222ef253f0, ), Py( 0x00007f222f3c85b0, ), Py( 0x00007f222f3b75b0, ), Py( 0x00007f214712b4b0, ), ], name: "HuggingFaceConfiguration", }, ), enabled_from_config: false, }, ), enabled_from_config: false, }, ), definitions=[])¶

__pydantic_validator__ = SchemaValidator(title="HuggingFaceConfiguration", validator=Dataclass( DataclassValidator { strict: false, validator: DataclassArgs( DataclassArgsValidator { fields: [ Field { kw_only: false, name: "algorithm_version", init: true, init_only: false, lookup_path_collection: LookupPathCollection { by_name: LookupPath { first_item: PathItemString( "algorithm_version", ), rest: [], }, by_alias: [], }, validator: WithDefault( WithDefaultValidator { default: Default( Py( 0x00007f222f308030, ), ), on_error: Raise, validator: Str( StrValidator { strict: false, coerce_numbers_to_str: false, }, ), validate_default: false, copy_default: false, name: "default[str]", undefined: Py( 0x00007f222cf13af0, ), }, ), frozen: false, }, Field { kw_only: false, name: "model_type", init: true, init_only: false, lookup_path_collection: LookupPathCollection { by_name: LookupPath { first_item: PathItemString( "model_type", ), rest: [], }, by_alias: [], }, validator: WithDefault( WithDefaultValidator { default: Default( Py( 0x00007f222f308030, ), ), on_error: Raise, validator: Str( StrValidator { strict: false, coerce_numbers_to_str: false, }, ), validate_default: false, copy_default: false, name: "default[str]", undefined: Py( 0x00007f222cf13af0, ), }, ), frozen: false, }, Field { kw_only: false, name: "prompt", init: true, init_only: false, lookup_path_collection: LookupPathCollection { by_name: LookupPath { first_item: PathItemString( "prompt", ), rest: [], }, by_alias: [], }, validator: WithDefault( WithDefaultValidator { default: Default( Py( 0x00007f214712b2d0, ), ), on_error: Raise, validator: Str( StrValidator { strict: false, coerce_numbers_to_str: false, }, ), validate_default: false, copy_default: false, name: "default[str]", undefined: Py( 0x00007f222cf13af0, ), }, ), frozen: false, }, Field { kw_only: false, name: "length", init: true, init_only: false, lookup_path_collection: LookupPathCollection { by_name: LookupPath { first_item: PathItemString( "length", ), rest: [], }, by_alias: [], }, validator: WithDefault( WithDefaultValidator { default: Default( Py( 0x00007f222f300350, ), ), on_error: Raise, validator: Int( IntValidator { strict: false, }, ), validate_default: false, copy_default: false, name: "default[int]", undefined: Py( 0x00007f222cf13af0, ), }, ), frozen: false, }, Field { kw_only: false, name: "stop_token", init: true, init_only: false, lookup_path_collection: LookupPathCollection { by_name: LookupPath { first_item: PathItemString( "stop_token", ), rest: [], }, by_alias: [], }, validator: WithDefault( WithDefaultValidator { default: Default( Py( 0x00007f222f308030, ), ), on_error: Raise, validator: Str( StrValidator { strict: false, coerce_numbers_to_str: false, }, ), validate_default: false, copy_default: false, name: "default[str]", undefined: Py( 0x00007f222cf13af0, ), }, ), frozen: false, }, Field { kw_only: false, name: "num_beams", init: true, init_only: false, lookup_path_collection: LookupPathCollection { by_name: LookupPath { first_item: PathItemString( "num_beams", ), rest: [], }, by_alias: [], }, validator: WithDefault( WithDefaultValidator { default: Default( Py( 0x00007f222f3000f0, ), ), on_error: Raise, validator: Int( IntValidator { strict: false, }, ), validate_default: false, copy_default: false, name: "default[int]", undefined: Py( 0x00007f222cf13af0, ), }, ), frozen: false, }, Field { kw_only: false, name: "do_sample", init: true, init_only: false, lookup_path_collection: LookupPathCollection { by_name: LookupPath { first_item: PathItemString( "do_sample", ), rest: [], }, by_alias: [], }, validator: WithDefault( WithDefaultValidator { default: Default( Py( 0x0000563c55c1c6e0, ), ), on_error: Raise, validator: Bool( BoolValidator { strict: false, }, ), validate_default: false, copy_default: false, name: "default[bool]", undefined: Py( 0x00007f222cf13af0, ), }, ), frozen: false, }, Field { kw_only: false, name: "temperature", init: true, init_only: false, lookup_path_collection: LookupPathCollection { by_name: LookupPath { first_item: PathItemString( "temperature", ), rest: [], }, by_alias: [], }, validator: WithDefault( WithDefaultValidator { default: Default( Py( 0x00007f214cdf2910, ), ), on_error: Raise, validator: Float( FloatValidator { strict: false, allow_inf_nan: true, }, ), validate_default: false, copy_default: false, name: "default[float]", undefined: Py( 0x00007f222cf13af0, ), }, ), frozen: false, }, Field { kw_only: false, name: "repetition_penalty", init: true, init_only: false, lookup_path_collection: LookupPathCollection { by_name: LookupPath { first_item: PathItemString( "repetition_penalty", ), rest: [], }, by_alias: [], }, validator: WithDefault( WithDefaultValidator { default: Default( Py( 0x00007f214cdf2910, ), ), on_error: Raise, validator: Float( FloatValidator { strict: false, allow_inf_nan: true, }, ), validate_default: false, copy_default: false, name: "default[float]", undefined: Py( 0x00007f222cf13af0, ), }, ), frozen: false, }, Field { kw_only: false, name: "k", init: true, init_only: false, lookup_path_collection: LookupPathCollection { by_name: LookupPath { first_item: PathItemString( "k", ), rest: [], }, by_alias: [], }, validator: WithDefault( WithDefaultValidator { default: Default( Py( 0x00007f222f300710, ), ), on_error: Raise, validator: Int( IntValidator { strict: false, }, ), validate_default: false, copy_default: false, name: "default[int]", undefined: Py( 0x00007f222cf13af0, ), }, ), frozen: false, }, Field { kw_only: false, name: "p", init: true, init_only: false, lookup_path_collection: LookupPathCollection { by_name: LookupPath { first_item: PathItemString( "p", ), rest: [], }, by_alias: [], }, validator: WithDefault( WithDefaultValidator { default: Default( Py( 0x00007f214cdf2910, ), ), on_error: Raise, validator: Float( FloatValidator { strict: false, allow_inf_nan: true, }, ), validate_default: false, copy_default: false, name: "default[float]", undefined: Py( 0x00007f222cf13af0, ), }, ), frozen: false, }, Field { kw_only: false, name: "prefix", init: true, init_only: false, lookup_path_collection: LookupPathCollection { by_name: LookupPath { first_item: PathItemString( "prefix", ), rest: [], }, by_alias: [], }, validator: WithDefault( WithDefaultValidator { default: Default( Py( 0x00007f222f308030, ), ), on_error: Raise, validator: Str( StrValidator { strict: false, coerce_numbers_to_str: false, }, ), validate_default: false, copy_default: false, name: "default[str]", undefined: Py( 0x00007f222cf13af0, ), }, ), frozen: false, }, Field { kw_only: false, name: "number_of_sequences", init: true, init_only: false, lookup_path_collection: LookupPathCollection { by_name: LookupPath { first_item: PathItemString( "number_of_sequences", ), rest: [], }, by_alias: [], }, validator: WithDefault( WithDefaultValidator { default: Default( Py( 0x00007f222f3001d0, ), ), on_error: Raise, validator: Int( IntValidator { strict: false, }, ), validate_default: false, copy_default: false, name: "default[int]", undefined: Py( 0x00007f222cf13af0, ), }, ), frozen: false, }, ], positional_count: 13, init_only_count: None, dataclass_name: "HuggingFaceConfiguration", validator_name: "dataclass-args[HuggingFaceConfiguration]", extra_behavior: Ignore, extras_validator: None, loc_by_alias: true, validate_by_alias: None, validate_by_name: None, }, ), class: Py( 0x0000563c9cbb7d20, ), generic_origin: None, fields: [ Py( 0x00007f222affaf10, ), Py( 0x00007f222ba93fb0, ), Py( 0x00007f222ef49930, ), Py( 0x00007f222ec451b0, ), Py( 0x00007f221b70d830, ), Py( 0x00007f2166ad85f0, ), Py( 0x00007f2166ab6730, ), Py( 0x00007f21b65bb8b0, ), Py( 0x00007f2166ab2c90, ), Py( 0x00007f222ef253f0, ), Py( 0x00007f222f3c85b0, ), Py( 0x00007f222f3b75b0, ), Py( 0x00007f214712b4b0, ), ], post_init: None, revalidate: Never, name: "HuggingFaceConfiguration", frozen: false, slots: true, }, ), definitions=[], cache_strings=True)¶

__repr__()¶: Return repr(self).

__signature__ = <Signature (algorithm_version: 'str' = '', model_type: str = '', prompt: str = "I'm a stochastic parrot.", length: int = 20, stop_token: str = '', num_beams: int = 1, do_sample: bool = True, temperature: float = 1.0, repetition_penalty: float = 1.0, k: int = 50, p: float = 1.0, prefix: str = '', number_of_sequences: int = 8) -> None>¶

__wrapped__¶: alias of HuggingFaceConfiguration

class HuggingFaceXLMGenerator(*args, **kwargs)[source]¶

Bases: HuggingFaceXLMGenerator

Configuration to generate text using XLM.

algorithm_version: str = 'xlm-mlm-en-2048'¶

To differentiate between different versions of an application.

There is no imposed naming convention.

model_type: str = 'xlm'¶

classmethod list_versions()[source]¶

Get possible algorithm versions.

Standard S3 and cache search adding the version used in the configuration.

Return type: Set[str]
Returns: viable values as algorithm_version for the environment.

__annotations__ = {'algorithm_application': 'ClassVar[str]', 'algorithm_name': 'ClassVar[str]', 'algorithm_type': 'ClassVar[str]', 'algorithm_version': <class 'str'>, 'do_sample': 'bool', 'domain': 'ClassVar[str]', 'k': 'int', 'length': 'int', 'model_type': <class 'str'>, 'num_beams': 'int', 'number_of_sequences': 'int', 'p': 'float', 'prefix': 'str', 'prompt': 'str', 'repetition_penalty': 'float', 'stop_token': 'str', 'temperature': 'float'}¶

__dataclass_fields__ = {'algorithm_application': Field(name='algorithm_application',type=typing.ClassVar[str],default='HuggingFaceXLMGenerator',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='HuggingFaceGenerationAlgorithm',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='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='xlm-mlm-en-2048',default_factory=<dataclasses._MISSING_TYPE object>,init=True,repr=True,hash=None,compare=True,metadata=mappingproxy({}),kw_only=False,_field_type=_FIELD), 'do_sample': Field(name='do_sample',type=<class 'bool'>,default=True,default_factory=<dataclasses._MISSING_TYPE object>,init=True,repr=True,hash=None,compare=True,metadata=mappingproxy({'description': 'Whether or not to use sampling; use greedy decoding otherwise.'}),kw_only=False,_field_type=_FIELD), 'domain': Field(name='domain',type=typing.ClassVar[str],default='nlp',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), 'k': Field(name='k',type=<class 'int'>,default=50,default_factory=<dataclasses._MISSING_TYPE object>,init=True,repr=True,hash=None,compare=True,metadata=mappingproxy({'description': 'Number of top-k probability tokens to keep.'}),kw_only=False,_field_type=_FIELD), 'length': Field(name='length',type=<class 'int'>,default=20,default_factory=<dataclasses._MISSING_TYPE object>,init=True,repr=True,hash=None,compare=True,metadata=mappingproxy({'description': 'Length of the generated text.'}),kw_only=False,_field_type=_FIELD), 'model_type': Field(name='model_type',type=<class 'str'>,default='xlm',default_factory=<dataclasses._MISSING_TYPE object>,init=True,repr=True,hash=None,compare=True,metadata=mappingproxy({}),kw_only=False,_field_type=_FIELD), 'num_beams': Field(name='num_beams',type=<class 'int'>,default=1,default_factory=<dataclasses._MISSING_TYPE object>,init=True,repr=True,hash=None,compare=True,metadata=mappingproxy({'description': 'Number of beams for beam search.'}),kw_only=False,_field_type=_FIELD), 'number_of_sequences': Field(name='number_of_sequences',type=<class 'int'>,default=8,default_factory=<dataclasses._MISSING_TYPE object>,init=True,repr=True,hash=None,compare=True,metadata=mappingproxy({'description': 'Number of text sequences to generate.'}),kw_only=False,_field_type=_FIELD), 'p': Field(name='p',type=<class 'float'>,default=1.0,default_factory=<dataclasses._MISSING_TYPE object>,init=True,repr=True,hash=None,compare=True,metadata=mappingproxy({'description': 'Only tokens with cumulative probabilities summing up to this value are kept.'}),kw_only=False,_field_type=_FIELD), 'prefix': Field(name='prefix',type=<class 'str'>,default='',default_factory=<dataclasses._MISSING_TYPE object>,init=True,repr=True,hash=None,compare=True,metadata=mappingproxy({'description': 'Text defining context provided prior to the prompt.'}),kw_only=False,_field_type=_FIELD), 'prompt': Field(name='prompt',type=<class 'str'>,default="I'm a stochastic parrot.",default_factory=<dataclasses._MISSING_TYPE object>,init=True,repr=True,hash=None,compare=True,metadata=mappingproxy({'description': 'Prompt for text generation.'}),kw_only=False,_field_type=_FIELD), 'repetition_penalty': Field(name='repetition_penalty',type=<class 'float'>,default=1.0,default_factory=<dataclasses._MISSING_TYPE object>,init=True,repr=True,hash=None,compare=True,metadata=mappingproxy({'description': 'Primarily useful for CTRL model, where 1.2 should be used.'}),kw_only=False,_field_type=_FIELD), 'stop_token': Field(name='stop_token',type=<class 'str'>,default='',default_factory=<dataclasses._MISSING_TYPE object>,init=True,repr=True,hash=None,compare=True,metadata=mappingproxy({'description': 'Stop token for text generation.'}),kw_only=False,_field_type=_FIELD), 'temperature': Field(name='temperature',type=<class 'float'>,default=1.0,default_factory=<dataclasses._MISSING_TYPE object>,init=True,repr=True,hash=None,compare=True,metadata=mappingproxy({'description': 'Temperature for sampling, the lower the greedier the sampling.'}),kw_only=False,_field_type=_FIELD)}¶

__dataclass_params__ = _DataclassParams(init=True,repr=True,eq=True,order=False,unsafe_hash=False,frozen=False)¶

__doc__ = 'Configuration to generate text using XLM.'¶

__eq__(other)¶: Return self==value.

__hash__ = None¶

__init__(*args, **kwargs)¶

__is_pydantic_dataclass__ = True¶

__match_args__ = ('algorithm_version', 'model_type', 'prompt', 'length', 'stop_token', 'num_beams', 'do_sample', 'temperature', 'repetition_penalty', 'k', 'p', 'prefix', 'number_of_sequences')¶

__module__ = 'gt4sd.algorithms.generation.hugging_face.core'¶

__parameters__ = (~T,)¶

__pydantic_complete__ = True¶

__pydantic_config__ = {}¶

__pydantic_core_schema__ = {'cls': <class 'gt4sd.algorithms.generation.hugging_face.core.HuggingFaceXLMGenerator'>, 'config': {'title': 'HuggingFaceXLMGenerator'}, 'fields': ['algorithm_version', 'model_type', 'prompt', 'length', 'stop_token', 'num_beams', 'do_sample', 'temperature', 'repetition_penalty', 'k', 'p', 'prefix', 'number_of_sequences'], 'frozen': False, 'post_init': False, 'ref': 'types.HuggingFaceXLMGenerator:94818327623104', 'schema': {'collect_init_only': False, 'computed_fields': [], 'dataclass_name': 'HuggingFaceXLMGenerator', 'fields': [{'type': 'dataclass-field', 'name': 'algorithm_version', 'schema': {'type': 'default', 'schema': {'type': 'str'}, 'default': 'xlm-mlm-en-2048'}, 'kw_only': False, 'init': True, 'metadata': {}}, {'type': 'dataclass-field', 'name': 'model_type', 'schema': {'type': 'default', 'schema': {'type': 'str'}, 'default': 'xlm'}, 'kw_only': False, 'init': True, 'metadata': {}}, {'type': 'dataclass-field', 'name': 'prompt', 'schema': {'type': 'default', 'schema': {'type': 'str'}, 'default': "I'm a stochastic parrot."}, 'kw_only': False, 'init': True, 'metadata': {'pydantic_js_updates': {'description': 'Prompt for text generation.'}}}, {'type': 'dataclass-field', 'name': 'length', 'schema': {'type': 'default', 'schema': {'type': 'int'}, 'default': 20}, 'kw_only': False, 'init': True, 'metadata': {'pydantic_js_updates': {'description': 'Length of the generated text.'}}}, {'type': 'dataclass-field', 'name': 'stop_token', 'schema': {'type': 'default', 'schema': {'type': 'str'}, 'default': ''}, 'kw_only': False, 'init': True, 'metadata': {'pydantic_js_updates': {'description': 'Stop token for text generation.'}}}, {'type': 'dataclass-field', 'name': 'num_beams', 'schema': {'type': 'default', 'schema': {'type': 'int'}, 'default': 1}, 'kw_only': False, 'init': True, 'metadata': {'pydantic_js_updates': {'description': 'Number of beams for beam search.'}}}, {'type': 'dataclass-field', 'name': 'do_sample', 'schema': {'type': 'default', 'schema': {'type': 'bool'}, 'default': True}, 'kw_only': False, 'init': True, 'metadata': {'pydantic_js_updates': {'description': 'Whether or not to use sampling; use greedy decoding otherwise.'}}}, {'type': 'dataclass-field', 'name': 'temperature', 'schema': {'type': 'default', 'schema': {'type': 'float'}, 'default': 1.0}, 'kw_only': False, 'init': True, 'metadata': {'pydantic_js_updates': {'description': 'Temperature for sampling, the lower the greedier the sampling.'}}}, {'type': 'dataclass-field', 'name': 'repetition_penalty', 'schema': {'type': 'default', 'schema': {'type': 'float'}, 'default': 1.0}, 'kw_only': False, 'init': True, 'metadata': {'pydantic_js_updates': {'description': 'Primarily useful for CTRL model, where 1.2 should be used.'}}}, {'type': 'dataclass-field', 'name': 'k', 'schema': {'type': 'default', 'schema': {'type': 'int'}, 'default': 50}, 'kw_only': False, 'init': True, 'metadata': {'pydantic_js_updates': {'description': 'Number of top-k probability tokens to keep.'}}}, {'type': 'dataclass-field', 'name': 'p', 'schema': {'type': 'default', 'schema': {'type': 'float'}, 'default': 1.0}, 'kw_only': False, 'init': True, 'metadata': {'pydantic_js_updates': {'description': 'Only tokens with cumulative probabilities summing up to this value are kept.'}}}, {'type': 'dataclass-field', 'name': 'prefix', 'schema': {'type': 'default', 'schema': {'type': 'str'}, 'default': ''}, 'kw_only': False, 'init': True, 'metadata': {'pydantic_js_updates': {'description': 'Text defining context provided prior to the prompt.'}}}, {'type': 'dataclass-field', 'name': 'number_of_sequences', 'schema': {'type': 'default', 'schema': {'type': 'int'}, 'default': 8}, 'kw_only': False, 'init': True, 'metadata': {'pydantic_js_updates': {'description': 'Number of text sequences to generate.'}}}], '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='xlm-mlm-en-2048', init=True, kw_only=False), 'do_sample': FieldInfo(annotation=bool, required=False, default=True, description='Whether or not to use sampling; use greedy decoding otherwise.', init=True, kw_only=False), 'k': FieldInfo(annotation=int, required=False, default=50, description='Number of top-k probability tokens to keep.', init=True, kw_only=False), 'length': FieldInfo(annotation=int, required=False, default=20, description='Length of the generated text.', init=True, kw_only=False), 'model_type': FieldInfo(annotation=str, required=False, default='xlm', init=True, kw_only=False), 'num_beams': FieldInfo(annotation=int, required=False, default=1, description='Number of beams for beam search.', init=True, kw_only=False), 'number_of_sequences': FieldInfo(annotation=int, required=False, default=8, description='Number of text sequences to generate.', init=True, kw_only=False), 'p': FieldInfo(annotation=float, required=False, default=1.0, description='Only tokens with cumulative probabilities summing up to this value are kept.', init=True, kw_only=False), 'prefix': FieldInfo(annotation=str, required=False, default='', description='Text defining context provided prior to the prompt.', init=True, kw_only=False), 'prompt': FieldInfo(annotation=str, required=False, default="I'm a stochastic parrot.", description='Prompt for text generation.', init=True, kw_only=False), 'repetition_penalty': FieldInfo(annotation=float, required=False, default=1.0, description='Primarily useful for CTRL model, where 1.2 should be used.', init=True, kw_only=False), 'stop_token': FieldInfo(annotation=str, required=False, default='', description='Stop token for text generation.', init=True, kw_only=False), 'temperature': FieldInfo(annotation=float, required=False, default=1.0, description='Temperature for sampling, the lower the greedier the sampling.', init=True, kw_only=False)}¶

classmethod __pydantic_fields_complete__()¶

Return whether the fields were successfully collected (i.e. type hints were successfully resolved).

This is a private helper, not meant to be used outside Pydantic.

Return type: bool

__pydantic_serializer__ = SchemaSerializer(serializer=PolymorphismTrampoline( PolymorphismTrampoline { class: Py( 0x0000563c9cbc75c0, ), serializer: PolymorphismTrampoline( PolymorphismTrampoline { class: Py( 0x0000563c9cbc75c0, ), serializer: Dataclass( DataclassSerializer { class: Py( 0x0000563c9cbc75c0, ), serializer: Fields( GeneralFieldsSerializer { fields: { "stop_token": SerField { key: "stop_token", alias: None, serializer: Some( WithDefault( WithDefaultSerializer { default: Default( Py( 0x00007f222f308030, ), ), serializer: Str( StrSerializer, ), }, ), ), required: true, serialize_by_alias: None, serialization_exclude_if: None, }, "algorithm_version": SerField { key: "algorithm_version", alias: None, serializer: Some( WithDefault( WithDefaultSerializer { default: Default( Py( 0x00007f214c6b5570, ), ), serializer: Str( StrSerializer, ), }, ), ), required: true, serialize_by_alias: None, serialization_exclude_if: None, }, "num_beams": SerField { key: "num_beams", alias: None, serializer: Some( WithDefault( WithDefaultSerializer { default: Default( Py( 0x00007f222f3000f0, ), ), serializer: Int( IntSerializer, ), }, ), ), required: true, serialize_by_alias: None, serialization_exclude_if: None, }, "prompt": SerField { key: "prompt", alias: None, serializer: Some( WithDefault( WithDefaultSerializer { default: Default( Py( 0x00007f214712b2d0, ), ), serializer: Str( StrSerializer, ), }, ), ), required: true, serialize_by_alias: None, serialization_exclude_if: None, }, "temperature": SerField { key: "temperature", alias: None, serializer: Some( WithDefault( WithDefaultSerializer { default: Default( Py( 0x00007f214cdf2910, ), ), serializer: Float( FloatSerializer { inf_nan_mode: Null, }, ), }, ), ), required: true, serialize_by_alias: None, serialization_exclude_if: None, }, "length": SerField { key: "length", alias: None, serializer: Some( WithDefault( WithDefaultSerializer { default: Default( Py( 0x00007f222f300350, ), ), serializer: Int( IntSerializer, ), }, ), ), required: true, serialize_by_alias: None, serialization_exclude_if: None, }, "do_sample": SerField { key: "do_sample", alias: None, serializer: Some( WithDefault( WithDefaultSerializer { default: Default( Py( 0x0000563c55c1c6e0, ), ), serializer: Bool( BoolSerializer, ), }, ), ), required: true, serialize_by_alias: None, serialization_exclude_if: None, }, "repetition_penalty": SerField { key: "repetition_penalty", alias: None, serializer: Some( WithDefault( WithDefaultSerializer { default: Default( Py( 0x00007f214cdf2910, ), ), serializer: Float( FloatSerializer { inf_nan_mode: Null, }, ), }, ), ), required: true, serialize_by_alias: None, serialization_exclude_if: None, }, "number_of_sequences": SerField { key: "number_of_sequences", alias: None, serializer: Some( WithDefault( WithDefaultSerializer { default: Default( Py( 0x00007f222f3001d0, ), ), serializer: Int( IntSerializer, ), }, ), ), required: true, serialize_by_alias: None, serialization_exclude_if: None, }, "prefix": SerField { key: "prefix", alias: None, serializer: Some( WithDefault( WithDefaultSerializer { default: Default( Py( 0x00007f222f308030, ), ), serializer: Str( StrSerializer, ), }, ), ), required: true, serialize_by_alias: None, serialization_exclude_if: None, }, "model_type": SerField { key: "model_type", alias: None, serializer: Some( WithDefault( WithDefaultSerializer { default: Default( Py( 0x00007f216688cab0, ), ), serializer: Str( StrSerializer, ), }, ), ), required: true, serialize_by_alias: None, serialization_exclude_if: None, }, "k": SerField { key: "k", alias: None, serializer: Some( WithDefault( WithDefaultSerializer { default: Default( Py( 0x00007f222f300710, ), ), serializer: Int( IntSerializer, ), }, ), ), required: true, serialize_by_alias: None, serialization_exclude_if: None, }, "p": SerField { key: "p", alias: None, serializer: Some( WithDefault( WithDefaultSerializer { default: Default( Py( 0x00007f214cdf2910, ), ), serializer: Float( FloatSerializer { inf_nan_mode: Null, }, ), }, ), ), required: true, serialize_by_alias: None, serialization_exclude_if: None, }, }, computed_fields: Some( ComputedFields( [], ), ), mode: SimpleDict, extra_serializer: None, filter: SchemaFilter { include: None, exclude: None, }, required_fields: 13, }, ), fields: [ Py( 0x00007f222affaf10, ), Py( 0x00007f222ba93fb0, ), Py( 0x00007f222ef49930, ), Py( 0x00007f222ec451b0, ), Py( 0x00007f221b70d830, ), Py( 0x00007f2166ad85f0, ), Py( 0x00007f2166ab6730, ), Py( 0x00007f21b65bb8b0, ), Py( 0x00007f2166ab2c90, ), Py( 0x00007f222ef253f0, ), Py( 0x00007f222f3c85b0, ), Py( 0x00007f222f3b75b0, ), Py( 0x00007f214712b4b0, ), ], name: "HuggingFaceXLMGenerator", }, ), enabled_from_config: false, }, ), enabled_from_config: false, }, ), definitions=[])¶

__pydantic_validator__ = SchemaValidator(title="HuggingFaceXLMGenerator", validator=Dataclass( DataclassValidator { strict: false, validator: DataclassArgs( DataclassArgsValidator { fields: [ Field { kw_only: false, name: "algorithm_version", init: true, init_only: false, lookup_path_collection: LookupPathCollection { by_name: LookupPath { first_item: PathItemString( "algorithm_version", ), rest: [], }, by_alias: [], }, validator: WithDefault( WithDefaultValidator { default: Default( Py( 0x00007f214c6b5570, ), ), on_error: Raise, validator: Str( StrValidator { strict: false, coerce_numbers_to_str: false, }, ), validate_default: false, copy_default: false, name: "default[str]", undefined: Py( 0x00007f222cf13af0, ), }, ), frozen: false, }, Field { kw_only: false, name: "model_type", init: true, init_only: false, lookup_path_collection: LookupPathCollection { by_name: LookupPath { first_item: PathItemString( "model_type", ), rest: [], }, by_alias: [], }, validator: WithDefault( WithDefaultValidator { default: Default( Py( 0x00007f216688cab0, ), ), on_error: Raise, validator: Str( StrValidator { strict: false, coerce_numbers_to_str: false, }, ), validate_default: false, copy_default: false, name: "default[str]", undefined: Py( 0x00007f222cf13af0, ), }, ), frozen: false, }, Field { kw_only: false, name: "prompt", init: true, init_only: false, lookup_path_collection: LookupPathCollection { by_name: LookupPath { first_item: PathItemString( "prompt", ), rest: [], }, by_alias: [], }, validator: WithDefault( WithDefaultValidator { default: Default( Py( 0x00007f214712b2d0, ), ), on_error: Raise, validator: Str( StrValidator { strict: false, coerce_numbers_to_str: false, }, ), validate_default: false, copy_default: false, name: "default[str]", undefined: Py( 0x00007f222cf13af0, ), }, ), frozen: false, }, Field { kw_only: false, name: "length", init: true, init_only: false, lookup_path_collection: LookupPathCollection { by_name: LookupPath { first_item: PathItemString( "length", ), rest: [], }, by_alias: [], }, validator: WithDefault( WithDefaultValidator { default: Default( Py( 0x00007f222f300350, ), ), on_error: Raise, validator: Int( IntValidator { strict: false, }, ), validate_default: false, copy_default: false, name: "default[int]", undefined: Py( 0x00007f222cf13af0, ), }, ), frozen: false, }, Field { kw_only: false, name: "stop_token", init: true, init_only: false, lookup_path_collection: LookupPathCollection { by_name: LookupPath { first_item: PathItemString( "stop_token", ), rest: [], }, by_alias: [], }, validator: WithDefault( WithDefaultValidator { default: Default( Py( 0x00007f222f308030, ), ), on_error: Raise, validator: Str( StrValidator { strict: false, coerce_numbers_to_str: false, }, ), validate_default: false, copy_default: false, name: "default[str]", undefined: Py( 0x00007f222cf13af0, ), }, ), frozen: false, }, Field { kw_only: false, name: "num_beams", init: true, init_only: false, lookup_path_collection: LookupPathCollection { by_name: LookupPath { first_item: PathItemString( "num_beams", ), rest: [], }, by_alias: [], }, validator: WithDefault( WithDefaultValidator { default: Default( Py( 0x00007f222f3000f0, ), ), on_error: Raise, validator: Int( IntValidator { strict: false, }, ), validate_default: false, copy_default: false, name: "default[int]", undefined: Py( 0x00007f222cf13af0, ), }, ), frozen: false, }, Field { kw_only: false, name: "do_sample", init: true, init_only: false, lookup_path_collection: LookupPathCollection { by_name: LookupPath { first_item: PathItemString( "do_sample", ), rest: [], }, by_alias: [], }, validator: WithDefault( WithDefaultValidator { default: Default( Py( 0x0000563c55c1c6e0, ), ), on_error: Raise, validator: Bool( BoolValidator { strict: false, }, ), validate_default: false, copy_default: false, name: "default[bool]", undefined: Py( 0x00007f222cf13af0, ), }, ), frozen: false, }, Field { kw_only: false, name: "temperature", init: true, init_only: false, lookup_path_collection: LookupPathCollection { by_name: LookupPath { first_item: PathItemString( "temperature", ), rest: [], }, by_alias: [], }, validator: WithDefault( WithDefaultValidator { default: Default( Py( 0x00007f214cdf2910, ), ), on_error: Raise, validator: Float( FloatValidator { strict: false, allow_inf_nan: true, }, ), validate_default: false, copy_default: false, name: "default[float]", undefined: Py( 0x00007f222cf13af0, ), }, ), frozen: false, }, Field { kw_only: false, name: "repetition_penalty", init: true, init_only: false, lookup_path_collection: LookupPathCollection { by_name: LookupPath { first_item: PathItemString( "repetition_penalty", ), rest: [], }, by_alias: [], }, validator: WithDefault( WithDefaultValidator { default: Default( Py( 0x00007f214cdf2910, ), ), on_error: Raise, validator: Float( FloatValidator { strict: false, allow_inf_nan: true, }, ), validate_default: false, copy_default: false, name: "default[float]", undefined: Py( 0x00007f222cf13af0, ), }, ), frozen: false, }, Field { kw_only: false, name: "k", init: true, init_only: false, lookup_path_collection: LookupPathCollection { by_name: LookupPath { first_item: PathItemString( "k", ), rest: [], }, by_alias: [], }, validator: WithDefault( WithDefaultValidator { default: Default( Py( 0x00007f222f300710, ), ), on_error: Raise, validator: Int( IntValidator { strict: false, }, ), validate_default: false, copy_default: false, name: "default[int]", undefined: Py( 0x00007f222cf13af0, ), }, ), frozen: false, }, Field { kw_only: false, name: "p", init: true, init_only: false, lookup_path_collection: LookupPathCollection { by_name: LookupPath { first_item: PathItemString( "p", ), rest: [], }, by_alias: [], }, validator: WithDefault( WithDefaultValidator { default: Default( Py( 0x00007f214cdf2910, ), ), on_error: Raise, validator: Float( FloatValidator { strict: false, allow_inf_nan: true, }, ), validate_default: false, copy_default: false, name: "default[float]", undefined: Py( 0x00007f222cf13af0, ), }, ), frozen: false, }, Field { kw_only: false, name: "prefix", init: true, init_only: false, lookup_path_collection: LookupPathCollection { by_name: LookupPath { first_item: PathItemString( "prefix", ), rest: [], }, by_alias: [], }, validator: WithDefault( WithDefaultValidator { default: Default( Py( 0x00007f222f308030, ), ), on_error: Raise, validator: Str( StrValidator { strict: false, coerce_numbers_to_str: false, }, ), validate_default: false, copy_default: false, name: "default[str]", undefined: Py( 0x00007f222cf13af0, ), }, ), frozen: false, }, Field { kw_only: false, name: "number_of_sequences", init: true, init_only: false, lookup_path_collection: LookupPathCollection { by_name: LookupPath { first_item: PathItemString( "number_of_sequences", ), rest: [], }, by_alias: [], }, validator: WithDefault( WithDefaultValidator { default: Default( Py( 0x00007f222f3001d0, ), ), on_error: Raise, validator: Int( IntValidator { strict: false, }, ), validate_default: false, copy_default: false, name: "default[int]", undefined: Py( 0x00007f222cf13af0, ), }, ), frozen: false, }, ], positional_count: 13, init_only_count: None, dataclass_name: "HuggingFaceXLMGenerator", validator_name: "dataclass-args[HuggingFaceXLMGenerator]", extra_behavior: Ignore, extras_validator: None, loc_by_alias: true, validate_by_alias: None, validate_by_name: None, }, ), class: Py( 0x0000563c9cbc75c0, ), generic_origin: None, fields: [ Py( 0x00007f222affaf10, ), Py( 0x00007f222ba93fb0, ), Py( 0x00007f222ef49930, ), Py( 0x00007f222ec451b0, ), Py( 0x00007f221b70d830, ), Py( 0x00007f2166ad85f0, ), Py( 0x00007f2166ab6730, ), Py( 0x00007f21b65bb8b0, ), Py( 0x00007f2166ab2c90, ), Py( 0x00007f222ef253f0, ), Py( 0x00007f222f3c85b0, ), Py( 0x00007f222f3b75b0, ), Py( 0x00007f214712b4b0, ), ], post_init: None, revalidate: Never, name: "HuggingFaceXLMGenerator", frozen: false, slots: true, }, ), definitions=[], cache_strings=True)¶

__repr__()¶: Return repr(self).

__signature__ = <Signature (*args: Any, algorithm_version: str = 'xlm-mlm-en-2048', model_type: str = 'xlm', prompt: str = "I'm a stochastic parrot.", length: int = 20, stop_token: str = '', num_beams: int = 1, do_sample: bool = True, temperature: float = 1.0, repetition_penalty: float = 1.0, k: int = 50, p: float = 1.0, prefix: str = '', number_of_sequences: int = 8) -> None>¶

__wrapped__¶: alias of HuggingFaceXLMGenerator

algorithm_application: ClassVar[str] = 'HuggingFaceXLMGenerator'¶

Unique name for the application that is the use of this configuration together with a specific algorithm.

Will be set when registering to ApplicationsRegistry, but can be given by direct registration (See register_algorithm_application)

algorithm_name: ClassVar[str] = 'HuggingFaceGenerationAlgorithm'¶

Name of the algorithm to use with this configuration.

Will be set when registering to ApplicationsRegistry

class HuggingFaceCTRLGenerator(*args, **kwargs)[source]¶

Bases: HuggingFaceCTRLGenerator

Configuration to generate text using CTRL.

algorithm_version: str = 'ctrl'¶

To differentiate between different versions of an application.

There is no imposed naming convention.

model_type: str = 'ctrl'¶

classmethod list_versions()[source]¶

Get possible algorithm versions.

Standard S3 and cache search adding the version used in the configuration.

Return type: Set[str]
Returns: viable values as algorithm_version for the environment.

__annotations__ = {'algorithm_application': 'ClassVar[str]', 'algorithm_name': 'ClassVar[str]', 'algorithm_type': 'ClassVar[str]', 'algorithm_version': <class 'str'>, 'do_sample': 'bool', 'domain': 'ClassVar[str]', 'k': 'int', 'length': 'int', 'model_type': <class 'str'>, 'num_beams': 'int', 'number_of_sequences': 'int', 'p': 'float', 'prefix': 'str', 'prompt': 'str', 'repetition_penalty': 'float', 'stop_token': 'str', 'temperature': 'float'}¶

__dataclass_fields__ = {'algorithm_application': Field(name='algorithm_application',type=typing.ClassVar[str],default='HuggingFaceCTRLGenerator',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='HuggingFaceGenerationAlgorithm',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='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='ctrl',default_factory=<dataclasses._MISSING_TYPE object>,init=True,repr=True,hash=None,compare=True,metadata=mappingproxy({}),kw_only=False,_field_type=_FIELD), 'do_sample': Field(name='do_sample',type=<class 'bool'>,default=True,default_factory=<dataclasses._MISSING_TYPE object>,init=True,repr=True,hash=None,compare=True,metadata=mappingproxy({'description': 'Whether or not to use sampling; use greedy decoding otherwise.'}),kw_only=False,_field_type=_FIELD), 'domain': Field(name='domain',type=typing.ClassVar[str],default='nlp',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), 'k': Field(name='k',type=<class 'int'>,default=50,default_factory=<dataclasses._MISSING_TYPE object>,init=True,repr=True,hash=None,compare=True,metadata=mappingproxy({'description': 'Number of top-k probability tokens to keep.'}),kw_only=False,_field_type=_FIELD), 'length': Field(name='length',type=<class 'int'>,default=20,default_factory=<dataclasses._MISSING_TYPE object>,init=True,repr=True,hash=None,compare=True,metadata=mappingproxy({'description': 'Length of the generated text.'}),kw_only=False,_field_type=_FIELD), 'model_type': Field(name='model_type',type=<class 'str'>,default='ctrl',default_factory=<dataclasses._MISSING_TYPE object>,init=True,repr=True,hash=None,compare=True,metadata=mappingproxy({}),kw_only=False,_field_type=_FIELD), 'num_beams': Field(name='num_beams',type=<class 'int'>,default=1,default_factory=<dataclasses._MISSING_TYPE object>,init=True,repr=True,hash=None,compare=True,metadata=mappingproxy({'description': 'Number of beams for beam search.'}),kw_only=False,_field_type=_FIELD), 'number_of_sequences': Field(name='number_of_sequences',type=<class 'int'>,default=8,default_factory=<dataclasses._MISSING_TYPE object>,init=True,repr=True,hash=None,compare=True,metadata=mappingproxy({'description': 'Number of text sequences to generate.'}),kw_only=False,_field_type=_FIELD), 'p': Field(name='p',type=<class 'float'>,default=1.0,default_factory=<dataclasses._MISSING_TYPE object>,init=True,repr=True,hash=None,compare=True,metadata=mappingproxy({'description': 'Only tokens with cumulative probabilities summing up to this value are kept.'}),kw_only=False,_field_type=_FIELD), 'prefix': Field(name='prefix',type=<class 'str'>,default='',default_factory=<dataclasses._MISSING_TYPE object>,init=True,repr=True,hash=None,compare=True,metadata=mappingproxy({'description': 'Text defining context provided prior to the prompt.'}),kw_only=False,_field_type=_FIELD), 'prompt': Field(name='prompt',type=<class 'str'>,default="I'm a stochastic parrot.",default_factory=<dataclasses._MISSING_TYPE object>,init=True,repr=True,hash=None,compare=True,metadata=mappingproxy({'description': 'Prompt for text generation.'}),kw_only=False,_field_type=_FIELD), 'repetition_penalty': Field(name='repetition_penalty',type=<class 'float'>,default=1.0,default_factory=<dataclasses._MISSING_TYPE object>,init=True,repr=True,hash=None,compare=True,metadata=mappingproxy({'description': 'Primarily useful for CTRL model, where 1.2 should be used.'}),kw_only=False,_field_type=_FIELD), 'stop_token': Field(name='stop_token',type=<class 'str'>,default='',default_factory=<dataclasses._MISSING_TYPE object>,init=True,repr=True,hash=None,compare=True,metadata=mappingproxy({'description': 'Stop token for text generation.'}),kw_only=False,_field_type=_FIELD), 'temperature': Field(name='temperature',type=<class 'float'>,default=1.0,default_factory=<dataclasses._MISSING_TYPE object>,init=True,repr=True,hash=None,compare=True,metadata=mappingproxy({'description': 'Temperature for sampling, the lower the greedier the sampling.'}),kw_only=False,_field_type=_FIELD)}¶

__dataclass_params__ = _DataclassParams(init=True,repr=True,eq=True,order=False,unsafe_hash=False,frozen=False)¶

__doc__ = 'Configuration to generate text using CTRL.'¶

__eq__(other)¶: Return self==value.

__hash__ = None¶

__init__(*args, **kwargs)¶

__is_pydantic_dataclass__ = True¶

__match_args__ = ('algorithm_version', 'model_type', 'prompt', 'length', 'stop_token', 'num_beams', 'do_sample', 'temperature', 'repetition_penalty', 'k', 'p', 'prefix', 'number_of_sequences')¶

__module__ = 'gt4sd.algorithms.generation.hugging_face.core'¶

__parameters__ = (~T,)¶

__pydantic_complete__ = True¶

__pydantic_config__ = {}¶

__pydantic_core_schema__ = {'cls': <class 'gt4sd.algorithms.generation.hugging_face.core.HuggingFaceCTRLGenerator'>, 'config': {'title': 'HuggingFaceCTRLGenerator'}, 'fields': ['algorithm_version', 'model_type', 'prompt', 'length', 'stop_token', 'num_beams', 'do_sample', 'temperature', 'repetition_penalty', 'k', 'p', 'prefix', 'number_of_sequences'], 'frozen': False, 'post_init': False, 'ref': 'types.HuggingFaceCTRLGenerator:94818327577824', 'schema': {'collect_init_only': False, 'computed_fields': [], 'dataclass_name': 'HuggingFaceCTRLGenerator', 'fields': [{'type': 'dataclass-field', 'name': 'algorithm_version', 'schema': {'type': 'default', 'schema': {'type': 'str'}, 'default': 'ctrl'}, 'kw_only': False, 'init': True, 'metadata': {}}, {'type': 'dataclass-field', 'name': 'model_type', 'schema': {'type': 'default', 'schema': {'type': 'str'}, 'default': 'ctrl'}, 'kw_only': False, 'init': True, 'metadata': {}}, {'type': 'dataclass-field', 'name': 'prompt', 'schema': {'type': 'default', 'schema': {'type': 'str'}, 'default': "I'm a stochastic parrot."}, 'kw_only': False, 'init': True, 'metadata': {'pydantic_js_updates': {'description': 'Prompt for text generation.'}}}, {'type': 'dataclass-field', 'name': 'length', 'schema': {'type': 'default', 'schema': {'type': 'int'}, 'default': 20}, 'kw_only': False, 'init': True, 'metadata': {'pydantic_js_updates': {'description': 'Length of the generated text.'}}}, {'type': 'dataclass-field', 'name': 'stop_token', 'schema': {'type': 'default', 'schema': {'type': 'str'}, 'default': ''}, 'kw_only': False, 'init': True, 'metadata': {'pydantic_js_updates': {'description': 'Stop token for text generation.'}}}, {'type': 'dataclass-field', 'name': 'num_beams', 'schema': {'type': 'default', 'schema': {'type': 'int'}, 'default': 1}, 'kw_only': False, 'init': True, 'metadata': {'pydantic_js_updates': {'description': 'Number of beams for beam search.'}}}, {'type': 'dataclass-field', 'name': 'do_sample', 'schema': {'type': 'default', 'schema': {'type': 'bool'}, 'default': True}, 'kw_only': False, 'init': True, 'metadata': {'pydantic_js_updates': {'description': 'Whether or not to use sampling; use greedy decoding otherwise.'}}}, {'type': 'dataclass-field', 'name': 'temperature', 'schema': {'type': 'default', 'schema': {'type': 'float'}, 'default': 1.0}, 'kw_only': False, 'init': True, 'metadata': {'pydantic_js_updates': {'description': 'Temperature for sampling, the lower the greedier the sampling.'}}}, {'type': 'dataclass-field', 'name': 'repetition_penalty', 'schema': {'type': 'default', 'schema': {'type': 'float'}, 'default': 1.0}, 'kw_only': False, 'init': True, 'metadata': {'pydantic_js_updates': {'description': 'Primarily useful for CTRL model, where 1.2 should be used.'}}}, {'type': 'dataclass-field', 'name': 'k', 'schema': {'type': 'default', 'schema': {'type': 'int'}, 'default': 50}, 'kw_only': False, 'init': True, 'metadata': {'pydantic_js_updates': {'description': 'Number of top-k probability tokens to keep.'}}}, {'type': 'dataclass-field', 'name': 'p', 'schema': {'type': 'default', 'schema': {'type': 'float'}, 'default': 1.0}, 'kw_only': False, 'init': True, 'metadata': {'pydantic_js_updates': {'description': 'Only tokens with cumulative probabilities summing up to this value are kept.'}}}, {'type': 'dataclass-field', 'name': 'prefix', 'schema': {'type': 'default', 'schema': {'type': 'str'}, 'default': ''}, 'kw_only': False, 'init': True, 'metadata': {'pydantic_js_updates': {'description': 'Text defining context provided prior to the prompt.'}}}, {'type': 'dataclass-field', 'name': 'number_of_sequences', 'schema': {'type': 'default', 'schema': {'type': 'int'}, 'default': 8}, 'kw_only': False, 'init': True, 'metadata': {'pydantic_js_updates': {'description': 'Number of text sequences to generate.'}}}], '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='ctrl', init=True, kw_only=False), 'do_sample': FieldInfo(annotation=bool, required=False, default=True, description='Whether or not to use sampling; use greedy decoding otherwise.', init=True, kw_only=False), 'k': FieldInfo(annotation=int, required=False, default=50, description='Number of top-k probability tokens to keep.', init=True, kw_only=False), 'length': FieldInfo(annotation=int, required=False, default=20, description='Length of the generated text.', init=True, kw_only=False), 'model_type': FieldInfo(annotation=str, required=False, default='ctrl', init=True, kw_only=False), 'num_beams': FieldInfo(annotation=int, required=False, default=1, description='Number of beams for beam search.', init=True, kw_only=False), 'number_of_sequences': FieldInfo(annotation=int, required=False, default=8, description='Number of text sequences to generate.', init=True, kw_only=False), 'p': FieldInfo(annotation=float, required=False, default=1.0, description='Only tokens with cumulative probabilities summing up to this value are kept.', init=True, kw_only=False), 'prefix': FieldInfo(annotation=str, required=False, default='', description='Text defining context provided prior to the prompt.', init=True, kw_only=False), 'prompt': FieldInfo(annotation=str, required=False, default="I'm a stochastic parrot.", description='Prompt for text generation.', init=True, kw_only=False), 'repetition_penalty': FieldInfo(annotation=float, required=False, default=1.0, description='Primarily useful for CTRL model, where 1.2 should be used.', init=True, kw_only=False), 'stop_token': FieldInfo(annotation=str, required=False, default='', description='Stop token for text generation.', init=True, kw_only=False), 'temperature': FieldInfo(annotation=float, required=False, default=1.0, description='Temperature for sampling, the lower the greedier the sampling.', init=True, kw_only=False)}¶

classmethod __pydantic_fields_complete__()¶

Return whether the fields were successfully collected (i.e. type hints were successfully resolved).

This is a private helper, not meant to be used outside Pydantic.

Return type: bool

__pydantic_serializer__ = SchemaSerializer(serializer=PolymorphismTrampoline( PolymorphismTrampoline { class: Py( 0x0000563c9cbbc4e0, ), serializer: PolymorphismTrampoline( PolymorphismTrampoline { class: Py( 0x0000563c9cbbc4e0, ), serializer: Dataclass( DataclassSerializer { class: Py( 0x0000563c9cbbc4e0, ), serializer: Fields( GeneralFieldsSerializer { fields: { "num_beams": SerField { key: "num_beams", alias: None, serializer: Some( WithDefault( WithDefaultSerializer { default: Default( Py( 0x00007f222f3000f0, ), ), serializer: Int( IntSerializer, ), }, ), ), required: true, serialize_by_alias: None, serialization_exclude_if: None, }, "temperature": SerField { key: "temperature", alias: None, serializer: Some( WithDefault( WithDefaultSerializer { default: Default( Py( 0x00007f214cdf2910, ), ), serializer: Float( FloatSerializer { inf_nan_mode: Null, }, ), }, ), ), required: true, serialize_by_alias: None, serialization_exclude_if: None, }, "prefix": SerField { key: "prefix", alias: None, serializer: Some( WithDefault( WithDefaultSerializer { default: Default( Py( 0x00007f222f308030, ), ), serializer: Str( StrSerializer, ), }, ), ), required: true, serialize_by_alias: None, serialization_exclude_if: None, }, "algorithm_version": SerField { key: "algorithm_version", alias: None, serializer: Some( WithDefault( WithDefaultSerializer { default: Default( Py( 0x00007f216b8472b0, ), ), serializer: Str( StrSerializer, ), }, ), ), required: true, serialize_by_alias: None, serialization_exclude_if: None, }, "do_sample": SerField { key: "do_sample", alias: None, serializer: Some( WithDefault( WithDefaultSerializer { default: Default( Py( 0x0000563c55c1c6e0, ), ), serializer: Bool( BoolSerializer, ), }, ), ), required: true, serialize_by_alias: None, serialization_exclude_if: None, }, "stop_token": SerField { key: "stop_token", alias: None, serializer: Some( WithDefault( WithDefaultSerializer { default: Default( Py( 0x00007f222f308030, ), ), serializer: Str( StrSerializer, ), }, ), ), required: true, serialize_by_alias: None, serialization_exclude_if: None, }, "p": SerField { key: "p", alias: None, serializer: Some( WithDefault( WithDefaultSerializer { default: Default( Py( 0x00007f214cdf2910, ), ), serializer: Float( FloatSerializer { inf_nan_mode: Null, }, ), }, ), ), required: true, serialize_by_alias: None, serialization_exclude_if: None, }, "repetition_penalty": SerField { key: "repetition_penalty", alias: None, serializer: Some( WithDefault( WithDefaultSerializer { default: Default( Py( 0x00007f214cdf2910, ), ), serializer: Float( FloatSerializer { inf_nan_mode: Null, }, ), }, ), ), required: true, serialize_by_alias: None, serialization_exclude_if: None, }, "number_of_sequences": SerField { key: "number_of_sequences", alias: None, serializer: Some( WithDefault( WithDefaultSerializer { default: Default( Py( 0x00007f222f3001d0, ), ), serializer: Int( IntSerializer, ), }, ), ), required: true, serialize_by_alias: None, serialization_exclude_if: None, }, "prompt": SerField { key: "prompt", alias: None, serializer: Some( WithDefault( WithDefaultSerializer { default: Default( Py( 0x00007f214712b2d0, ), ), serializer: Str( StrSerializer, ), }, ), ), required: true, serialize_by_alias: None, serialization_exclude_if: None, }, "k": SerField { key: "k", alias: None, serializer: Some( WithDefault( WithDefaultSerializer { default: Default( Py( 0x00007f222f300710, ), ), serializer: Int( IntSerializer, ), }, ), ), required: true, serialize_by_alias: None, serialization_exclude_if: None, }, "length": SerField { key: "length", alias: None, serializer: Some( WithDefault( WithDefaultSerializer { default: Default( Py( 0x00007f222f300350, ), ), serializer: Int( IntSerializer, ), }, ), ), required: true, serialize_by_alias: None, serialization_exclude_if: None, }, "model_type": SerField { key: "model_type", alias: None, serializer: Some( WithDefault( WithDefaultSerializer { default: Default( Py( 0x00007f216b8472b0, ), ), serializer: Str( StrSerializer, ), }, ), ), required: true, serialize_by_alias: None, serialization_exclude_if: None, }, }, computed_fields: Some( ComputedFields( [], ), ), mode: SimpleDict, extra_serializer: None, filter: SchemaFilter { include: None, exclude: None, }, required_fields: 13, }, ), fields: [ Py( 0x00007f222affaf10, ), Py( 0x00007f222ba93fb0, ), Py( 0x00007f222ef49930, ), Py( 0x00007f222ec451b0, ), Py( 0x00007f221b70d830, ), Py( 0x00007f2166ad85f0, ), Py( 0x00007f2166ab6730, ), Py( 0x00007f21b65bb8b0, ), Py( 0x00007f2166ab2c90, ), Py( 0x00007f222ef253f0, ), Py( 0x00007f222f3c85b0, ), Py( 0x00007f222f3b75b0, ), Py( 0x00007f214712b4b0, ), ], name: "HuggingFaceCTRLGenerator", }, ), enabled_from_config: false, }, ), enabled_from_config: false, }, ), definitions=[])¶

__pydantic_validator__ = SchemaValidator(title="HuggingFaceCTRLGenerator", validator=Dataclass( DataclassValidator { strict: false, validator: DataclassArgs( DataclassArgsValidator { fields: [ Field { kw_only: false, name: "algorithm_version", init: true, init_only: false, lookup_path_collection: LookupPathCollection { by_name: LookupPath { first_item: PathItemString( "algorithm_version", ), rest: [], }, by_alias: [], }, validator: WithDefault( WithDefaultValidator { default: Default( Py( 0x00007f216b8472b0, ), ), on_error: Raise, validator: Str( StrValidator { strict: false, coerce_numbers_to_str: false, }, ), validate_default: false, copy_default: false, name: "default[str]", undefined: Py( 0x00007f222cf13af0, ), }, ), frozen: false, }, Field { kw_only: false, name: "model_type", init: true, init_only: false, lookup_path_collection: LookupPathCollection { by_name: LookupPath { first_item: PathItemString( "model_type", ), rest: [], }, by_alias: [], }, validator: WithDefault( WithDefaultValidator { default: Default( Py( 0x00007f216b8472b0, ), ), on_error: Raise, validator: Str( StrValidator { strict: false, coerce_numbers_to_str: false, }, ), validate_default: false, copy_default: false, name: "default[str]", undefined: Py( 0x00007f222cf13af0, ), }, ), frozen: false, }, Field { kw_only: false, name: "prompt", init: true, init_only: false, lookup_path_collection: LookupPathCollection { by_name: LookupPath { first_item: PathItemString( "prompt", ), rest: [], }, by_alias: [], }, validator: WithDefault( WithDefaultValidator { default: Default( Py( 0x00007f214712b2d0, ), ), on_error: Raise, validator: Str( StrValidator { strict: false, coerce_numbers_to_str: false, }, ), validate_default: false, copy_default: false, name: "default[str]", undefined: Py( 0x00007f222cf13af0, ), }, ), frozen: false, }, Field { kw_only: false, name: "length", init: true, init_only: false, lookup_path_collection: LookupPathCollection { by_name: LookupPath { first_item: PathItemString( "length", ), rest: [], }, by_alias: [], }, validator: WithDefault( WithDefaultValidator { default: Default( Py( 0x00007f222f300350, ), ), on_error: Raise, validator: Int( IntValidator { strict: false, }, ), validate_default: false, copy_default: false, name: "default[int]", undefined: Py( 0x00007f222cf13af0, ), }, ), frozen: false, }, Field { kw_only: false, name: "stop_token", init: true, init_only: false, lookup_path_collection: LookupPathCollection { by_name: LookupPath { first_item: PathItemString( "stop_token", ), rest: [], }, by_alias: [], }, validator: WithDefault( WithDefaultValidator { default: Default( Py( 0x00007f222f308030, ), ), on_error: Raise, validator: Str( StrValidator { strict: false, coerce_numbers_to_str: false, }, ), validate_default: false, copy_default: false, name: "default[str]", undefined: Py( 0x00007f222cf13af0, ), }, ), frozen: false, }, Field { kw_only: false, name: "num_beams", init: true, init_only: false, lookup_path_collection: LookupPathCollection { by_name: LookupPath { first_item: PathItemString( "num_beams", ), rest: [], }, by_alias: [], }, validator: WithDefault( WithDefaultValidator { default: Default( Py( 0x00007f222f3000f0, ), ), on_error: Raise, validator: Int( IntValidator { strict: false, }, ), validate_default: false, copy_default: false, name: "default[int]", undefined: Py( 0x00007f222cf13af0, ), }, ), frozen: false, }, Field { kw_only: false, name: "do_sample", init: true, init_only: false, lookup_path_collection: LookupPathCollection { by_name: LookupPath { first_item: PathItemString( "do_sample", ), rest: [], }, by_alias: [], }, validator: WithDefault( WithDefaultValidator { default: Default( Py( 0x0000563c55c1c6e0, ), ), on_error: Raise, validator: Bool( BoolValidator { strict: false, }, ), validate_default: false, copy_default: false, name: "default[bool]", undefined: Py( 0x00007f222cf13af0, ), }, ), frozen: false, }, Field { kw_only: false, name: "temperature", init: true, init_only: false, lookup_path_collection: LookupPathCollection { by_name: LookupPath { first_item: PathItemString( "temperature", ), rest: [], }, by_alias: [], }, validator: WithDefault( WithDefaultValidator { default: Default( Py( 0x00007f214cdf2910, ), ), on_error: Raise, validator: Float( FloatValidator { strict: false, allow_inf_nan: true, }, ), validate_default: false, copy_default: false, name: "default[float]", undefined: Py( 0x00007f222cf13af0, ), }, ), frozen: false, }, Field { kw_only: false, name: "repetition_penalty", init: true, init_only: false, lookup_path_collection: LookupPathCollection { by_name: LookupPath { first_item: PathItemString( "repetition_penalty", ), rest: [], }, by_alias: [], }, validator: WithDefault( WithDefaultValidator { default: Default( Py( 0x00007f214cdf2910, ), ), on_error: Raise, validator: Float( FloatValidator { strict: false, allow_inf_nan: true, }, ), validate_default: false, copy_default: false, name: "default[float]", undefined: Py( 0x00007f222cf13af0, ), }, ), frozen: false, }, Field { kw_only: false, name: "k", init: true, init_only: false, lookup_path_collection: LookupPathCollection { by_name: LookupPath { first_item: PathItemString( "k", ), rest: [], }, by_alias: [], }, validator: WithDefault( WithDefaultValidator { default: Default( Py( 0x00007f222f300710, ), ), on_error: Raise, validator: Int( IntValidator { strict: false, }, ), validate_default: false, copy_default: false, name: "default[int]", undefined: Py( 0x00007f222cf13af0, ), }, ), frozen: false, }, Field { kw_only: false, name: "p", init: true, init_only: false, lookup_path_collection: LookupPathCollection { by_name: LookupPath { first_item: PathItemString( "p", ), rest: [], }, by_alias: [], }, validator: WithDefault( WithDefaultValidator { default: Default( Py( 0x00007f214cdf2910, ), ), on_error: Raise, validator: Float( FloatValidator { strict: false, allow_inf_nan: true, }, ), validate_default: false, copy_default: false, name: "default[float]", undefined: Py( 0x00007f222cf13af0, ), }, ), frozen: false, }, Field { kw_only: false, name: "prefix", init: true, init_only: false, lookup_path_collection: LookupPathCollection { by_name: LookupPath { first_item: PathItemString( "prefix", ), rest: [], }, by_alias: [], }, validator: WithDefault( WithDefaultValidator { default: Default( Py( 0x00007f222f308030, ), ), on_error: Raise, validator: Str( StrValidator { strict: false, coerce_numbers_to_str: false, }, ), validate_default: false, copy_default: false, name: "default[str]", undefined: Py( 0x00007f222cf13af0, ), }, ), frozen: false, }, Field { kw_only: false, name: "number_of_sequences", init: true, init_only: false, lookup_path_collection: LookupPathCollection { by_name: LookupPath { first_item: PathItemString( "number_of_sequences", ), rest: [], }, by_alias: [], }, validator: WithDefault( WithDefaultValidator { default: Default( Py( 0x00007f222f3001d0, ), ), on_error: Raise, validator: Int( IntValidator { strict: false, }, ), validate_default: false, copy_default: false, name: "default[int]", undefined: Py( 0x00007f222cf13af0, ), }, ), frozen: false, }, ], positional_count: 13, init_only_count: None, dataclass_name: "HuggingFaceCTRLGenerator", validator_name: "dataclass-args[HuggingFaceCTRLGenerator]", extra_behavior: Ignore, extras_validator: None, loc_by_alias: true, validate_by_alias: None, validate_by_name: None, }, ), class: Py( 0x0000563c9cbbc4e0, ), generic_origin: None, fields: [ Py( 0x00007f222affaf10, ), Py( 0x00007f222ba93fb0, ), Py( 0x00007f222ef49930, ), Py( 0x00007f222ec451b0, ), Py( 0x00007f221b70d830, ), Py( 0x00007f2166ad85f0, ), Py( 0x00007f2166ab6730, ), Py( 0x00007f21b65bb8b0, ), Py( 0x00007f2166ab2c90, ), Py( 0x00007f222ef253f0, ), Py( 0x00007f222f3c85b0, ), Py( 0x00007f222f3b75b0, ), Py( 0x00007f214712b4b0, ), ], post_init: None, revalidate: Never, name: "HuggingFaceCTRLGenerator", frozen: false, slots: true, }, ), definitions=[], cache_strings=True)¶

__repr__()¶: Return repr(self).

__signature__ = <Signature (*args: Any, algorithm_version: str = 'ctrl', model_type: str = 'ctrl', prompt: str = "I'm a stochastic parrot.", length: int = 20, stop_token: str = '', num_beams: int = 1, do_sample: bool = True, temperature: float = 1.0, repetition_penalty: float = 1.0, k: int = 50, p: float = 1.0, prefix: str = '', number_of_sequences: int = 8) -> None>¶

__wrapped__¶: alias of HuggingFaceCTRLGenerator

algorithm_application: ClassVar[str] = 'HuggingFaceCTRLGenerator'¶

Unique name for the application that is the use of this configuration together with a specific algorithm.

Will be set when registering to ApplicationsRegistry, but can be given by direct registration (See register_algorithm_application)

algorithm_name: ClassVar[str] = 'HuggingFaceGenerationAlgorithm'¶

Name of the algorithm to use with this configuration.

Will be set when registering to ApplicationsRegistry

class HuggingFaceGPT2Generator(*args, **kwargs)[source]¶

Bases: HuggingFaceGPT2Generator

Configuration to generate text using GPT2.

algorithm_version: str = 'gpt2'¶

To differentiate between different versions of an application.

There is no imposed naming convention.

model_type: str = 'gpt2'¶

classmethod list_versions()[source]¶

Get possible algorithm versions.

Standard S3 and cache search adding the version used in the configuration.

Return type: Set[str]
Returns: viable values as algorithm_version for the environment.

__annotations__ = {'algorithm_application': 'ClassVar[str]', 'algorithm_name': 'ClassVar[str]', 'algorithm_type': 'ClassVar[str]', 'algorithm_version': <class 'str'>, 'do_sample': 'bool', 'domain': 'ClassVar[str]', 'k': 'int', 'length': 'int', 'model_type': <class 'str'>, 'num_beams': 'int', 'number_of_sequences': 'int', 'p': 'float', 'prefix': 'str', 'prompt': 'str', 'repetition_penalty': 'float', 'stop_token': 'str', 'temperature': 'float'}¶

__dataclass_fields__ = {'algorithm_application': Field(name='algorithm_application',type=typing.ClassVar[str],default='HuggingFaceGPT2Generator',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='HuggingFaceGenerationAlgorithm',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='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='gpt2',default_factory=<dataclasses._MISSING_TYPE object>,init=True,repr=True,hash=None,compare=True,metadata=mappingproxy({}),kw_only=False,_field_type=_FIELD), 'do_sample': Field(name='do_sample',type=<class 'bool'>,default=True,default_factory=<dataclasses._MISSING_TYPE object>,init=True,repr=True,hash=None,compare=True,metadata=mappingproxy({'description': 'Whether or not to use sampling; use greedy decoding otherwise.'}),kw_only=False,_field_type=_FIELD), 'domain': Field(name='domain',type=typing.ClassVar[str],default='nlp',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), 'k': Field(name='k',type=<class 'int'>,default=50,default_factory=<dataclasses._MISSING_TYPE object>,init=True,repr=True,hash=None,compare=True,metadata=mappingproxy({'description': 'Number of top-k probability tokens to keep.'}),kw_only=False,_field_type=_FIELD), 'length': Field(name='length',type=<class 'int'>,default=20,default_factory=<dataclasses._MISSING_TYPE object>,init=True,repr=True,hash=None,compare=True,metadata=mappingproxy({'description': 'Length of the generated text.'}),kw_only=False,_field_type=_FIELD), 'model_type': Field(name='model_type',type=<class 'str'>,default='gpt2',default_factory=<dataclasses._MISSING_TYPE object>,init=True,repr=True,hash=None,compare=True,metadata=mappingproxy({}),kw_only=False,_field_type=_FIELD), 'num_beams': Field(name='num_beams',type=<class 'int'>,default=1,default_factory=<dataclasses._MISSING_TYPE object>,init=True,repr=True,hash=None,compare=True,metadata=mappingproxy({'description': 'Number of beams for beam search.'}),kw_only=False,_field_type=_FIELD), 'number_of_sequences': Field(name='number_of_sequences',type=<class 'int'>,default=8,default_factory=<dataclasses._MISSING_TYPE object>,init=True,repr=True,hash=None,compare=True,metadata=mappingproxy({'description': 'Number of text sequences to generate.'}),kw_only=False,_field_type=_FIELD), 'p': Field(name='p',type=<class 'float'>,default=1.0,default_factory=<dataclasses._MISSING_TYPE object>,init=True,repr=True,hash=None,compare=True,metadata=mappingproxy({'description': 'Only tokens with cumulative probabilities summing up to this value are kept.'}),kw_only=False,_field_type=_FIELD), 'prefix': Field(name='prefix',type=<class 'str'>,default='',default_factory=<dataclasses._MISSING_TYPE object>,init=True,repr=True,hash=None,compare=True,metadata=mappingproxy({'description': 'Text defining context provided prior to the prompt.'}),kw_only=False,_field_type=_FIELD), 'prompt': Field(name='prompt',type=<class 'str'>,default="I'm a stochastic parrot.",default_factory=<dataclasses._MISSING_TYPE object>,init=True,repr=True,hash=None,compare=True,metadata=mappingproxy({'description': 'Prompt for text generation.'}),kw_only=False,_field_type=_FIELD), 'repetition_penalty': Field(name='repetition_penalty',type=<class 'float'>,default=1.0,default_factory=<dataclasses._MISSING_TYPE object>,init=True,repr=True,hash=None,compare=True,metadata=mappingproxy({'description': 'Primarily useful for CTRL model, where 1.2 should be used.'}),kw_only=False,_field_type=_FIELD), 'stop_token': Field(name='stop_token',type=<class 'str'>,default='',default_factory=<dataclasses._MISSING_TYPE object>,init=True,repr=True,hash=None,compare=True,metadata=mappingproxy({'description': 'Stop token for text generation.'}),kw_only=False,_field_type=_FIELD), 'temperature': Field(name='temperature',type=<class 'float'>,default=1.0,default_factory=<dataclasses._MISSING_TYPE object>,init=True,repr=True,hash=None,compare=True,metadata=mappingproxy({'description': 'Temperature for sampling, the lower the greedier the sampling.'}),kw_only=False,_field_type=_FIELD)}¶

__dataclass_params__ = _DataclassParams(init=True,repr=True,eq=True,order=False,unsafe_hash=False,frozen=False)¶

__doc__ = 'Configuration to generate text using GPT2.'¶

__eq__(other)¶: Return self==value.

__hash__ = None¶

__init__(*args, **kwargs)¶

__is_pydantic_dataclass__ = True¶

__match_args__ = ('algorithm_version', 'model_type', 'prompt', 'length', 'stop_token', 'num_beams', 'do_sample', 'temperature', 'repetition_penalty', 'k', 'p', 'prefix', 'number_of_sequences')¶

__module__ = 'gt4sd.algorithms.generation.hugging_face.core'¶

__parameters__ = (~T,)¶

__pydantic_complete__ = True¶

__pydantic_config__ = {}¶

__pydantic_core_schema__ = {'cls': <class 'gt4sd.algorithms.generation.hugging_face.core.HuggingFaceGPT2Generator'>, 'config': {'title': 'HuggingFaceGPT2Generator'}, 'fields': ['algorithm_version', 'model_type', 'prompt', 'length', 'stop_token', 'num_beams', 'do_sample', 'temperature', 'repetition_penalty', 'k', 'p', 'prefix', 'number_of_sequences'], 'frozen': False, 'post_init': False, 'ref': 'types.HuggingFaceGPT2Generator:94818327629088', 'schema': {'collect_init_only': False, 'computed_fields': [], 'dataclass_name': 'HuggingFaceGPT2Generator', 'fields': [{'type': 'dataclass-field', 'name': 'algorithm_version', 'schema': {'type': 'default', 'schema': {'type': 'str'}, 'default': 'gpt2'}, 'kw_only': False, 'init': True, 'metadata': {}}, {'type': 'dataclass-field', 'name': 'model_type', 'schema': {'type': 'default', 'schema': {'type': 'str'}, 'default': 'gpt2'}, 'kw_only': False, 'init': True, 'metadata': {}}, {'type': 'dataclass-field', 'name': 'prompt', 'schema': {'type': 'default', 'schema': {'type': 'str'}, 'default': "I'm a stochastic parrot."}, 'kw_only': False, 'init': True, 'metadata': {'pydantic_js_updates': {'description': 'Prompt for text generation.'}}}, {'type': 'dataclass-field', 'name': 'length', 'schema': {'type': 'default', 'schema': {'type': 'int'}, 'default': 20}, 'kw_only': False, 'init': True, 'metadata': {'pydantic_js_updates': {'description': 'Length of the generated text.'}}}, {'type': 'dataclass-field', 'name': 'stop_token', 'schema': {'type': 'default', 'schema': {'type': 'str'}, 'default': ''}, 'kw_only': False, 'init': True, 'metadata': {'pydantic_js_updates': {'description': 'Stop token for text generation.'}}}, {'type': 'dataclass-field', 'name': 'num_beams', 'schema': {'type': 'default', 'schema': {'type': 'int'}, 'default': 1}, 'kw_only': False, 'init': True, 'metadata': {'pydantic_js_updates': {'description': 'Number of beams for beam search.'}}}, {'type': 'dataclass-field', 'name': 'do_sample', 'schema': {'type': 'default', 'schema': {'type': 'bool'}, 'default': True}, 'kw_only': False, 'init': True, 'metadata': {'pydantic_js_updates': {'description': 'Whether or not to use sampling; use greedy decoding otherwise.'}}}, {'type': 'dataclass-field', 'name': 'temperature', 'schema': {'type': 'default', 'schema': {'type': 'float'}, 'default': 1.0}, 'kw_only': False, 'init': True, 'metadata': {'pydantic_js_updates': {'description': 'Temperature for sampling, the lower the greedier the sampling.'}}}, {'type': 'dataclass-field', 'name': 'repetition_penalty', 'schema': {'type': 'default', 'schema': {'type': 'float'}, 'default': 1.0}, 'kw_only': False, 'init': True, 'metadata': {'pydantic_js_updates': {'description': 'Primarily useful for CTRL model, where 1.2 should be used.'}}}, {'type': 'dataclass-field', 'name': 'k', 'schema': {'type': 'default', 'schema': {'type': 'int'}, 'default': 50}, 'kw_only': False, 'init': True, 'metadata': {'pydantic_js_updates': {'description': 'Number of top-k probability tokens to keep.'}}}, {'type': 'dataclass-field', 'name': 'p', 'schema': {'type': 'default', 'schema': {'type': 'float'}, 'default': 1.0}, 'kw_only': False, 'init': True, 'metadata': {'pydantic_js_updates': {'description': 'Only tokens with cumulative probabilities summing up to this value are kept.'}}}, {'type': 'dataclass-field', 'name': 'prefix', 'schema': {'type': 'default', 'schema': {'type': 'str'}, 'default': ''}, 'kw_only': False, 'init': True, 'metadata': {'pydantic_js_updates': {'description': 'Text defining context provided prior to the prompt.'}}}, {'type': 'dataclass-field', 'name': 'number_of_sequences', 'schema': {'type': 'default', 'schema': {'type': 'int'}, 'default': 8}, 'kw_only': False, 'init': True, 'metadata': {'pydantic_js_updates': {'description': 'Number of text sequences to generate.'}}}], '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='gpt2', init=True, kw_only=False), 'do_sample': FieldInfo(annotation=bool, required=False, default=True, description='Whether or not to use sampling; use greedy decoding otherwise.', init=True, kw_only=False), 'k': FieldInfo(annotation=int, required=False, default=50, description='Number of top-k probability tokens to keep.', init=True, kw_only=False), 'length': FieldInfo(annotation=int, required=False, default=20, description='Length of the generated text.', init=True, kw_only=False), 'model_type': FieldInfo(annotation=str, required=False, default='gpt2', init=True, kw_only=False), 'num_beams': FieldInfo(annotation=int, required=False, default=1, description='Number of beams for beam search.', init=True, kw_only=False), 'number_of_sequences': FieldInfo(annotation=int, required=False, default=8, description='Number of text sequences to generate.', init=True, kw_only=False), 'p': FieldInfo(annotation=float, required=False, default=1.0, description='Only tokens with cumulative probabilities summing up to this value are kept.', init=True, kw_only=False), 'prefix': FieldInfo(annotation=str, required=False, default='', description='Text defining context provided prior to the prompt.', init=True, kw_only=False), 'prompt': FieldInfo(annotation=str, required=False, default="I'm a stochastic parrot.", description='Prompt for text generation.', init=True, kw_only=False), 'repetition_penalty': FieldInfo(annotation=float, required=False, default=1.0, description='Primarily useful for CTRL model, where 1.2 should be used.', init=True, kw_only=False), 'stop_token': FieldInfo(annotation=str, required=False, default='', description='Stop token for text generation.', init=True, kw_only=False), 'temperature': FieldInfo(annotation=float, required=False, default=1.0, description='Temperature for sampling, the lower the greedier the sampling.', init=True, kw_only=False)}¶

classmethod __pydantic_fields_complete__()¶

Return whether the fields were successfully collected (i.e. type hints were successfully resolved).

This is a private helper, not meant to be used outside Pydantic.

Return type: bool

__pydantic_serializer__ = SchemaSerializer(serializer=PolymorphismTrampoline( PolymorphismTrampoline { class: Py( 0x0000563c9cbc8d20, ), serializer: PolymorphismTrampoline( PolymorphismTrampoline { class: Py( 0x0000563c9cbc8d20, ), serializer: Dataclass( DataclassSerializer { class: Py( 0x0000563c9cbc8d20, ), serializer: Fields( GeneralFieldsSerializer { fields: { "stop_token": SerField { key: "stop_token", alias: None, serializer: Some( WithDefault( WithDefaultSerializer { default: Default( Py( 0x00007f222f308030, ), ), serializer: Str( StrSerializer, ), }, ), ), required: true, serialize_by_alias: None, serialization_exclude_if: None, }, "algorithm_version": SerField { key: "algorithm_version", alias: None, serializer: Some( WithDefault( WithDefaultSerializer { default: Default( Py( 0x00007f2166fac8b0, ), ), serializer: Str( StrSerializer, ), }, ), ), required: true, serialize_by_alias: None, serialization_exclude_if: None, }, "prefix": SerField { key: "prefix", alias: None, serializer: Some( WithDefault( WithDefaultSerializer { default: Default( Py( 0x00007f222f308030, ), ), serializer: Str( StrSerializer, ), }, ), ), required: true, serialize_by_alias: None, serialization_exclude_if: None, }, "do_sample": SerField { key: "do_sample", alias: None, serializer: Some( WithDefault( WithDefaultSerializer { default: Default( Py( 0x0000563c55c1c6e0, ), ), serializer: Bool( BoolSerializer, ), }, ), ), required: true, serialize_by_alias: None, serialization_exclude_if: None, }, "p": SerField { key: "p", alias: None, serializer: Some( WithDefault( WithDefaultSerializer { default: Default( Py( 0x00007f214cdf2910, ), ), serializer: Float( FloatSerializer { inf_nan_mode: Null, }, ), }, ), ), required: true, serialize_by_alias: None, serialization_exclude_if: None, }, "repetition_penalty": SerField { key: "repetition_penalty", alias: None, serializer: Some( WithDefault( WithDefaultSerializer { default: Default( Py( 0x00007f214cdf2910, ), ), serializer: Float( FloatSerializer { inf_nan_mode: Null, }, ), }, ), ), required: true, serialize_by_alias: None, serialization_exclude_if: None, }, "k": SerField { key: "k", alias: None, serializer: Some( WithDefault( WithDefaultSerializer { default: Default( Py( 0x00007f222f300710, ), ), serializer: Int( IntSerializer, ), }, ), ), required: true, serialize_by_alias: None, serialization_exclude_if: None, }, "number_of_sequences": SerField { key: "number_of_sequences", alias: None, serializer: Some( WithDefault( WithDefaultSerializer { default: Default( Py( 0x00007f222f3001d0, ), ), serializer: Int( IntSerializer, ), }, ), ), required: true, serialize_by_alias: None, serialization_exclude_if: None, }, "model_type": SerField { key: "model_type", alias: None, serializer: Some( WithDefault( WithDefaultSerializer { default: Default( Py( 0x00007f2166fac8b0, ), ), serializer: Str( StrSerializer, ), }, ), ), required: true, serialize_by_alias: None, serialization_exclude_if: None, }, "num_beams": SerField { key: "num_beams", alias: None, serializer: Some( WithDefault( WithDefaultSerializer { default: Default( Py( 0x00007f222f3000f0, ), ), serializer: Int( IntSerializer, ), }, ), ), required: true, serialize_by_alias: None, serialization_exclude_if: None, }, "length": SerField { key: "length", alias: None, serializer: Some( WithDefault( WithDefaultSerializer { default: Default( Py( 0x00007f222f300350, ), ), serializer: Int( IntSerializer, ), }, ), ), required: true, serialize_by_alias: None, serialization_exclude_if: None, }, "prompt": SerField { key: "prompt", alias: None, serializer: Some( WithDefault( WithDefaultSerializer { default: Default( Py( 0x00007f214712b2d0, ), ), serializer: Str( StrSerializer, ), }, ), ), required: true, serialize_by_alias: None, serialization_exclude_if: None, }, "temperature": SerField { key: "temperature", alias: None, serializer: Some( WithDefault( WithDefaultSerializer { default: Default( Py( 0x00007f214cdf2910, ), ), serializer: Float( FloatSerializer { inf_nan_mode: Null, }, ), }, ), ), required: true, serialize_by_alias: None, serialization_exclude_if: None, }, }, computed_fields: Some( ComputedFields( [], ), ), mode: SimpleDict, extra_serializer: None, filter: SchemaFilter { include: None, exclude: None, }, required_fields: 13, }, ), fields: [ Py( 0x00007f222affaf10, ), Py( 0x00007f222ba93fb0, ), Py( 0x00007f222ef49930, ), Py( 0x00007f222ec451b0, ), Py( 0x00007f221b70d830, ), Py( 0x00007f2166ad85f0, ), Py( 0x00007f2166ab6730, ), Py( 0x00007f21b65bb8b0, ), Py( 0x00007f2166ab2c90, ), Py( 0x00007f222ef253f0, ), Py( 0x00007f222f3c85b0, ), Py( 0x00007f222f3b75b0, ), Py( 0x00007f214712b4b0, ), ], name: "HuggingFaceGPT2Generator", }, ), enabled_from_config: false, }, ), enabled_from_config: false, }, ), definitions=[])¶

__pydantic_validator__ = SchemaValidator(title="HuggingFaceGPT2Generator", validator=Dataclass( DataclassValidator { strict: false, validator: DataclassArgs( DataclassArgsValidator { fields: [ Field { kw_only: false, name: "algorithm_version", init: true, init_only: false, lookup_path_collection: LookupPathCollection { by_name: LookupPath { first_item: PathItemString( "algorithm_version", ), rest: [], }, by_alias: [], }, validator: WithDefault( WithDefaultValidator { default: Default( Py( 0x00007f2166fac8b0, ), ), on_error: Raise, validator: Str( StrValidator { strict: false, coerce_numbers_to_str: false, }, ), validate_default: false, copy_default: false, name: "default[str]", undefined: Py( 0x00007f222cf13af0, ), }, ), frozen: false, }, Field { kw_only: false, name: "model_type", init: true, init_only: false, lookup_path_collection: LookupPathCollection { by_name: LookupPath { first_item: PathItemString( "model_type", ), rest: [], }, by_alias: [], }, validator: WithDefault( WithDefaultValidator { default: Default( Py( 0x00007f2166fac8b0, ), ), on_error: Raise, validator: Str( StrValidator { strict: false, coerce_numbers_to_str: false, }, ), validate_default: false, copy_default: false, name: "default[str]", undefined: Py( 0x00007f222cf13af0, ), }, ), frozen: false, }, Field { kw_only: false, name: "prompt", init: true, init_only: false, lookup_path_collection: LookupPathCollection { by_name: LookupPath { first_item: PathItemString( "prompt", ), rest: [], }, by_alias: [], }, validator: WithDefault( WithDefaultValidator { default: Default( Py( 0x00007f214712b2d0, ), ), on_error: Raise, validator: Str( StrValidator { strict: false, coerce_numbers_to_str: false, }, ), validate_default: false, copy_default: false, name: "default[str]", undefined: Py( 0x00007f222cf13af0, ), }, ), frozen: false, }, Field { kw_only: false, name: "length", init: true, init_only: false, lookup_path_collection: LookupPathCollection { by_name: LookupPath { first_item: PathItemString( "length", ), rest: [], }, by_alias: [], }, validator: WithDefault( WithDefaultValidator { default: Default( Py( 0x00007f222f300350, ), ), on_error: Raise, validator: Int( IntValidator { strict: false, }, ), validate_default: false, copy_default: false, name: "default[int]", undefined: Py( 0x00007f222cf13af0, ), }, ), frozen: false, }, Field { kw_only: false, name: "stop_token", init: true, init_only: false, lookup_path_collection: LookupPathCollection { by_name: LookupPath { first_item: PathItemString( "stop_token", ), rest: [], }, by_alias: [], }, validator: WithDefault( WithDefaultValidator { default: Default( Py( 0x00007f222f308030, ), ), on_error: Raise, validator: Str( StrValidator { strict: false, coerce_numbers_to_str: false, }, ), validate_default: false, copy_default: false, name: "default[str]", undefined: Py( 0x00007f222cf13af0, ), }, ), frozen: false, }, Field { kw_only: false, name: "num_beams", init: true, init_only: false, lookup_path_collection: LookupPathCollection { by_name: LookupPath { first_item: PathItemString( "num_beams", ), rest: [], }, by_alias: [], }, validator: WithDefault( WithDefaultValidator { default: Default( Py( 0x00007f222f3000f0, ), ), on_error: Raise, validator: Int( IntValidator { strict: false, }, ), validate_default: false, copy_default: false, name: "default[int]", undefined: Py( 0x00007f222cf13af0, ), }, ), frozen: false, }, Field { kw_only: false, name: "do_sample", init: true, init_only: false, lookup_path_collection: LookupPathCollection { by_name: LookupPath { first_item: PathItemString( "do_sample", ), rest: [], }, by_alias: [], }, validator: WithDefault( WithDefaultValidator { default: Default( Py( 0x0000563c55c1c6e0, ), ), on_error: Raise, validator: Bool( BoolValidator { strict: false, }, ), validate_default: false, copy_default: false, name: "default[bool]", undefined: Py( 0x00007f222cf13af0, ), }, ), frozen: false, }, Field { kw_only: false, name: "temperature", init: true, init_only: false, lookup_path_collection: LookupPathCollection { by_name: LookupPath { first_item: PathItemString( "temperature", ), rest: [], }, by_alias: [], }, validator: WithDefault( WithDefaultValidator { default: Default( Py( 0x00007f214cdf2910, ), ), on_error: Raise, validator: Float( FloatValidator { strict: false, allow_inf_nan: true, }, ), validate_default: false, copy_default: false, name: "default[float]", undefined: Py( 0x00007f222cf13af0, ), }, ), frozen: false, }, Field { kw_only: false, name: "repetition_penalty", init: true, init_only: false, lookup_path_collection: LookupPathCollection { by_name: LookupPath { first_item: PathItemString( "repetition_penalty", ), rest: [], }, by_alias: [], }, validator: WithDefault( WithDefaultValidator { default: Default( Py( 0x00007f214cdf2910, ), ), on_error: Raise, validator: Float( FloatValidator { strict: false, allow_inf_nan: true, }, ), validate_default: false, copy_default: false, name: "default[float]", undefined: Py( 0x00007f222cf13af0, ), }, ), frozen: false, }, Field { kw_only: false, name: "k", init: true, init_only: false, lookup_path_collection: LookupPathCollection { by_name: LookupPath { first_item: PathItemString( "k", ), rest: [], }, by_alias: [], }, validator: WithDefault( WithDefaultValidator { default: Default( Py( 0x00007f222f300710, ), ), on_error: Raise, validator: Int( IntValidator { strict: false, }, ), validate_default: false, copy_default: false, name: "default[int]", undefined: Py( 0x00007f222cf13af0, ), }, ), frozen: false, }, Field { kw_only: false, name: "p", init: true, init_only: false, lookup_path_collection: LookupPathCollection { by_name: LookupPath { first_item: PathItemString( "p", ), rest: [], }, by_alias: [], }, validator: WithDefault( WithDefaultValidator { default: Default( Py( 0x00007f214cdf2910, ), ), on_error: Raise, validator: Float( FloatValidator { strict: false, allow_inf_nan: true, }, ), validate_default: false, copy_default: false, name: "default[float]", undefined: Py( 0x00007f222cf13af0, ), }, ), frozen: false, }, Field { kw_only: false, name: "prefix", init: true, init_only: false, lookup_path_collection: LookupPathCollection { by_name: LookupPath { first_item: PathItemString( "prefix", ), rest: [], }, by_alias: [], }, validator: WithDefault( WithDefaultValidator { default: Default( Py( 0x00007f222f308030, ), ), on_error: Raise, validator: Str( StrValidator { strict: false, coerce_numbers_to_str: false, }, ), validate_default: false, copy_default: false, name: "default[str]", undefined: Py( 0x00007f222cf13af0, ), }, ), frozen: false, }, Field { kw_only: false, name: "number_of_sequences", init: true, init_only: false, lookup_path_collection: LookupPathCollection { by_name: LookupPath { first_item: PathItemString( "number_of_sequences", ), rest: [], }, by_alias: [], }, validator: WithDefault( WithDefaultValidator { default: Default( Py( 0x00007f222f3001d0, ), ), on_error: Raise, validator: Int( IntValidator { strict: false, }, ), validate_default: false, copy_default: false, name: "default[int]", undefined: Py( 0x00007f222cf13af0, ), }, ), frozen: false, }, ], positional_count: 13, init_only_count: None, dataclass_name: "HuggingFaceGPT2Generator", validator_name: "dataclass-args[HuggingFaceGPT2Generator]", extra_behavior: Ignore, extras_validator: None, loc_by_alias: true, validate_by_alias: None, validate_by_name: None, }, ), class: Py( 0x0000563c9cbc8d20, ), generic_origin: None, fields: [ Py( 0x00007f222affaf10, ), Py( 0x00007f222ba93fb0, ), Py( 0x00007f222ef49930, ), Py( 0x00007f222ec451b0, ), Py( 0x00007f221b70d830, ), Py( 0x00007f2166ad85f0, ), Py( 0x00007f2166ab6730, ), Py( 0x00007f21b65bb8b0, ), Py( 0x00007f2166ab2c90, ), Py( 0x00007f222ef253f0, ), Py( 0x00007f222f3c85b0, ), Py( 0x00007f222f3b75b0, ), Py( 0x00007f214712b4b0, ), ], post_init: None, revalidate: Never, name: "HuggingFaceGPT2Generator", frozen: false, slots: true, }, ), definitions=[], cache_strings=True)¶

__repr__()¶: Return repr(self).

__signature__ = <Signature (*args: Any, algorithm_version: str = 'gpt2', model_type: str = 'gpt2', prompt: str = "I'm a stochastic parrot.", length: int = 20, stop_token: str = '', num_beams: int = 1, do_sample: bool = True, temperature: float = 1.0, repetition_penalty: float = 1.0, k: int = 50, p: float = 1.0, prefix: str = '', number_of_sequences: int = 8) -> None>¶

__wrapped__¶: alias of HuggingFaceGPT2Generator

algorithm_application: ClassVar[str] = 'HuggingFaceGPT2Generator'¶

Unique name for the application that is the use of this configuration together with a specific algorithm.

Will be set when registering to ApplicationsRegistry, but can be given by direct registration (See register_algorithm_application)

algorithm_name: ClassVar[str] = 'HuggingFaceGenerationAlgorithm'¶

Name of the algorithm to use with this configuration.

Will be set when registering to ApplicationsRegistry

class HuggingFaceOpenAIGPTGenerator(*args, **kwargs)[source]¶

Bases: HuggingFaceOpenAIGPTGenerator

Configuration to generate text using OpenAIGPT.

algorithm_version: str = 'openai-gpt'¶

To differentiate between different versions of an application.

There is no imposed naming convention.

model_type: str = 'openai-gpt'¶

classmethod list_versions()[source]¶

Get possible algorithm versions.

Standard S3 and cache search adding the version used in the configuration.

Return type: Set[str]
Returns: viable values as algorithm_version for the environment.

__annotations__ = {'algorithm_application': 'ClassVar[str]', 'algorithm_name': 'ClassVar[str]', 'algorithm_type': 'ClassVar[str]', 'algorithm_version': <class 'str'>, 'do_sample': 'bool', 'domain': 'ClassVar[str]', 'k': 'int', 'length': 'int', 'model_type': <class 'str'>, 'num_beams': 'int', 'number_of_sequences': 'int', 'p': 'float', 'prefix': 'str', 'prompt': 'str', 'repetition_penalty': 'float', 'stop_token': 'str', 'temperature': 'float'}¶

__dataclass_fields__ = {'algorithm_application': Field(name='algorithm_application',type=typing.ClassVar[str],default='HuggingFaceOpenAIGPTGenerator',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='HuggingFaceGenerationAlgorithm',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='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='openai-gpt',default_factory=<dataclasses._MISSING_TYPE object>,init=True,repr=True,hash=None,compare=True,metadata=mappingproxy({}),kw_only=False,_field_type=_FIELD), 'do_sample': Field(name='do_sample',type=<class 'bool'>,default=True,default_factory=<dataclasses._MISSING_TYPE object>,init=True,repr=True,hash=None,compare=True,metadata=mappingproxy({'description': 'Whether or not to use sampling; use greedy decoding otherwise.'}),kw_only=False,_field_type=_FIELD), 'domain': Field(name='domain',type=typing.ClassVar[str],default='nlp',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), 'k': Field(name='k',type=<class 'int'>,default=50,default_factory=<dataclasses._MISSING_TYPE object>,init=True,repr=True,hash=None,compare=True,metadata=mappingproxy({'description': 'Number of top-k probability tokens to keep.'}),kw_only=False,_field_type=_FIELD), 'length': Field(name='length',type=<class 'int'>,default=20,default_factory=<dataclasses._MISSING_TYPE object>,init=True,repr=True,hash=None,compare=True,metadata=mappingproxy({'description': 'Length of the generated text.'}),kw_only=False,_field_type=_FIELD), 'model_type': Field(name='model_type',type=<class 'str'>,default='openai-gpt',default_factory=<dataclasses._MISSING_TYPE object>,init=True,repr=True,hash=None,compare=True,metadata=mappingproxy({}),kw_only=False,_field_type=_FIELD), 'num_beams': Field(name='num_beams',type=<class 'int'>,default=1,default_factory=<dataclasses._MISSING_TYPE object>,init=True,repr=True,hash=None,compare=True,metadata=mappingproxy({'description': 'Number of beams for beam search.'}),kw_only=False,_field_type=_FIELD), 'number_of_sequences': Field(name='number_of_sequences',type=<class 'int'>,default=8,default_factory=<dataclasses._MISSING_TYPE object>,init=True,repr=True,hash=None,compare=True,metadata=mappingproxy({'description': 'Number of text sequences to generate.'}),kw_only=False,_field_type=_FIELD), 'p': Field(name='p',type=<class 'float'>,default=1.0,default_factory=<dataclasses._MISSING_TYPE object>,init=True,repr=True,hash=None,compare=True,metadata=mappingproxy({'description': 'Only tokens with cumulative probabilities summing up to this value are kept.'}),kw_only=False,_field_type=_FIELD), 'prefix': Field(name='prefix',type=<class 'str'>,default='',default_factory=<dataclasses._MISSING_TYPE object>,init=True,repr=True,hash=None,compare=True,metadata=mappingproxy({'description': 'Text defining context provided prior to the prompt.'}),kw_only=False,_field_type=_FIELD), 'prompt': Field(name='prompt',type=<class 'str'>,default="I'm a stochastic parrot.",default_factory=<dataclasses._MISSING_TYPE object>,init=True,repr=True,hash=None,compare=True,metadata=mappingproxy({'description': 'Prompt for text generation.'}),kw_only=False,_field_type=_FIELD), 'repetition_penalty': Field(name='repetition_penalty',type=<class 'float'>,default=1.0,default_factory=<dataclasses._MISSING_TYPE object>,init=True,repr=True,hash=None,compare=True,metadata=mappingproxy({'description': 'Primarily useful for CTRL model, where 1.2 should be used.'}),kw_only=False,_field_type=_FIELD), 'stop_token': Field(name='stop_token',type=<class 'str'>,default='',default_factory=<dataclasses._MISSING_TYPE object>,init=True,repr=True,hash=None,compare=True,metadata=mappingproxy({'description': 'Stop token for text generation.'}),kw_only=False,_field_type=_FIELD), 'temperature': Field(name='temperature',type=<class 'float'>,default=1.0,default_factory=<dataclasses._MISSING_TYPE object>,init=True,repr=True,hash=None,compare=True,metadata=mappingproxy({'description': 'Temperature for sampling, the lower the greedier the sampling.'}),kw_only=False,_field_type=_FIELD)}¶

__dataclass_params__ = _DataclassParams(init=True,repr=True,eq=True,order=False,unsafe_hash=False,frozen=False)¶

__doc__ = 'Configuration to generate text using OpenAIGPT.'¶

__eq__(other)¶: Return self==value.

__hash__ = None¶

__init__(*args, **kwargs)¶

__is_pydantic_dataclass__ = True¶

__match_args__ = ('algorithm_version', 'model_type', 'prompt', 'length', 'stop_token', 'num_beams', 'do_sample', 'temperature', 'repetition_penalty', 'k', 'p', 'prefix', 'number_of_sequences')¶

__module__ = 'gt4sd.algorithms.generation.hugging_face.core'¶

__parameters__ = (~T,)¶

__pydantic_complete__ = True¶

__pydantic_config__ = {}¶

__pydantic_core_schema__ = {'cls': <class 'gt4sd.algorithms.generation.hugging_face.core.HuggingFaceOpenAIGPTGenerator'>, 'config': {'title': 'HuggingFaceOpenAIGPTGenerator'}, 'fields': ['algorithm_version', 'model_type', 'prompt', 'length', 'stop_token', 'num_beams', 'do_sample', 'temperature', 'repetition_penalty', 'k', 'p', 'prefix', 'number_of_sequences'], 'frozen': False, 'post_init': False, 'ref': 'types.HuggingFaceOpenAIGPTGenerator:94818327639984', 'schema': {'collect_init_only': False, 'computed_fields': [], 'dataclass_name': 'HuggingFaceOpenAIGPTGenerator', 'fields': [{'type': 'dataclass-field', 'name': 'algorithm_version', 'schema': {'type': 'default', 'schema': {'type': 'str'}, 'default': 'openai-gpt'}, 'kw_only': False, 'init': True, 'metadata': {}}, {'type': 'dataclass-field', 'name': 'model_type', 'schema': {'type': 'default', 'schema': {'type': 'str'}, 'default': 'openai-gpt'}, 'kw_only': False, 'init': True, 'metadata': {}}, {'type': 'dataclass-field', 'name': 'prompt', 'schema': {'type': 'default', 'schema': {'type': 'str'}, 'default': "I'm a stochastic parrot."}, 'kw_only': False, 'init': True, 'metadata': {'pydantic_js_updates': {'description': 'Prompt for text generation.'}}}, {'type': 'dataclass-field', 'name': 'length', 'schema': {'type': 'default', 'schema': {'type': 'int'}, 'default': 20}, 'kw_only': False, 'init': True, 'metadata': {'pydantic_js_updates': {'description': 'Length of the generated text.'}}}, {'type': 'dataclass-field', 'name': 'stop_token', 'schema': {'type': 'default', 'schema': {'type': 'str'}, 'default': ''}, 'kw_only': False, 'init': True, 'metadata': {'pydantic_js_updates': {'description': 'Stop token for text generation.'}}}, {'type': 'dataclass-field', 'name': 'num_beams', 'schema': {'type': 'default', 'schema': {'type': 'int'}, 'default': 1}, 'kw_only': False, 'init': True, 'metadata': {'pydantic_js_updates': {'description': 'Number of beams for beam search.'}}}, {'type': 'dataclass-field', 'name': 'do_sample', 'schema': {'type': 'default', 'schema': {'type': 'bool'}, 'default': True}, 'kw_only': False, 'init': True, 'metadata': {'pydantic_js_updates': {'description': 'Whether or not to use sampling; use greedy decoding otherwise.'}}}, {'type': 'dataclass-field', 'name': 'temperature', 'schema': {'type': 'default', 'schema': {'type': 'float'}, 'default': 1.0}, 'kw_only': False, 'init': True, 'metadata': {'pydantic_js_updates': {'description': 'Temperature for sampling, the lower the greedier the sampling.'}}}, {'type': 'dataclass-field', 'name': 'repetition_penalty', 'schema': {'type': 'default', 'schema': {'type': 'float'}, 'default': 1.0}, 'kw_only': False, 'init': True, 'metadata': {'pydantic_js_updates': {'description': 'Primarily useful for CTRL model, where 1.2 should be used.'}}}, {'type': 'dataclass-field', 'name': 'k', 'schema': {'type': 'default', 'schema': {'type': 'int'}, 'default': 50}, 'kw_only': False, 'init': True, 'metadata': {'pydantic_js_updates': {'description': 'Number of top-k probability tokens to keep.'}}}, {'type': 'dataclass-field', 'name': 'p', 'schema': {'type': 'default', 'schema': {'type': 'float'}, 'default': 1.0}, 'kw_only': False, 'init': True, 'metadata': {'pydantic_js_updates': {'description': 'Only tokens with cumulative probabilities summing up to this value are kept.'}}}, {'type': 'dataclass-field', 'name': 'prefix', 'schema': {'type': 'default', 'schema': {'type': 'str'}, 'default': ''}, 'kw_only': False, 'init': True, 'metadata': {'pydantic_js_updates': {'description': 'Text defining context provided prior to the prompt.'}}}, {'type': 'dataclass-field', 'name': 'number_of_sequences', 'schema': {'type': 'default', 'schema': {'type': 'int'}, 'default': 8}, 'kw_only': False, 'init': True, 'metadata': {'pydantic_js_updates': {'description': 'Number of text sequences to generate.'}}}], '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='openai-gpt', init=True, kw_only=False), 'do_sample': FieldInfo(annotation=bool, required=False, default=True, description='Whether or not to use sampling; use greedy decoding otherwise.', init=True, kw_only=False), 'k': FieldInfo(annotation=int, required=False, default=50, description='Number of top-k probability tokens to keep.', init=True, kw_only=False), 'length': FieldInfo(annotation=int, required=False, default=20, description='Length of the generated text.', init=True, kw_only=False), 'model_type': FieldInfo(annotation=str, required=False, default='openai-gpt', init=True, kw_only=False), 'num_beams': FieldInfo(annotation=int, required=False, default=1, description='Number of beams for beam search.', init=True, kw_only=False), 'number_of_sequences': FieldInfo(annotation=int, required=False, default=8, description='Number of text sequences to generate.', init=True, kw_only=False), 'p': FieldInfo(annotation=float, required=False, default=1.0, description='Only tokens with cumulative probabilities summing up to this value are kept.', init=True, kw_only=False), 'prefix': FieldInfo(annotation=str, required=False, default='', description='Text defining context provided prior to the prompt.', init=True, kw_only=False), 'prompt': FieldInfo(annotation=str, required=False, default="I'm a stochastic parrot.", description='Prompt for text generation.', init=True, kw_only=False), 'repetition_penalty': FieldInfo(annotation=float, required=False, default=1.0, description='Primarily useful for CTRL model, where 1.2 should be used.', init=True, kw_only=False), 'stop_token': FieldInfo(annotation=str, required=False, default='', description='Stop token for text generation.', init=True, kw_only=False), 'temperature': FieldInfo(annotation=float, required=False, default=1.0, description='Temperature for sampling, the lower the greedier the sampling.', init=True, kw_only=False)}¶

classmethod __pydantic_fields_complete__()¶

Return whether the fields were successfully collected (i.e. type hints were successfully resolved).

This is a private helper, not meant to be used outside Pydantic.

Return type: bool

__pydantic_serializer__ = SchemaSerializer(serializer=PolymorphismTrampoline( PolymorphismTrampoline { class: Py( 0x0000563c9cbcb7b0, ), serializer: PolymorphismTrampoline( PolymorphismTrampoline { class: Py( 0x0000563c9cbcb7b0, ), serializer: Dataclass( DataclassSerializer { class: Py( 0x0000563c9cbcb7b0, ), serializer: Fields( GeneralFieldsSerializer { fields: { "model_type": SerField { key: "model_type", alias: None, serializer: Some( WithDefault( WithDefaultSerializer { default: Default( Py( 0x00007f214c6a7d70, ), ), serializer: Str( StrSerializer, ), }, ), ), required: true, serialize_by_alias: None, serialization_exclude_if: None, }, "temperature": SerField { key: "temperature", alias: None, serializer: Some( WithDefault( WithDefaultSerializer { default: Default( Py( 0x00007f214cdf2910, ), ), serializer: Float( FloatSerializer { inf_nan_mode: Null, }, ), }, ), ), required: true, serialize_by_alias: None, serialization_exclude_if: None, }, "prefix": SerField { key: "prefix", alias: None, serializer: Some( WithDefault( WithDefaultSerializer { default: Default( Py( 0x00007f222f308030, ), ), serializer: Str( StrSerializer, ), }, ), ), required: true, serialize_by_alias: None, serialization_exclude_if: None, }, "algorithm_version": SerField { key: "algorithm_version", alias: None, serializer: Some( WithDefault( WithDefaultSerializer { default: Default( Py( 0x00007f214c6a7d70, ), ), serializer: Str( StrSerializer, ), }, ), ), required: true, serialize_by_alias: None, serialization_exclude_if: None, }, "p": SerField { key: "p", alias: None, serializer: Some( WithDefault( WithDefaultSerializer { default: Default( Py( 0x00007f214cdf2910, ), ), serializer: Float( FloatSerializer { inf_nan_mode: Null, }, ), }, ), ), required: true, serialize_by_alias: None, serialization_exclude_if: None, }, "prompt": SerField { key: "prompt", alias: None, serializer: Some( WithDefault( WithDefaultSerializer { default: Default( Py( 0x00007f214712b2d0, ), ), serializer: Str( StrSerializer, ), }, ), ), required: true, serialize_by_alias: None, serialization_exclude_if: None, }, "stop_token": SerField { key: "stop_token", alias: None, serializer: Some( WithDefault( WithDefaultSerializer { default: Default( Py( 0x00007f222f308030, ), ), serializer: Str( StrSerializer, ), }, ), ), required: true, serialize_by_alias: None, serialization_exclude_if: None, }, "num_beams": SerField { key: "num_beams", alias: None, serializer: Some( WithDefault( WithDefaultSerializer { default: Default( Py( 0x00007f222f3000f0, ), ), serializer: Int( IntSerializer, ), }, ), ), required: true, serialize_by_alias: None, serialization_exclude_if: None, }, "do_sample": SerField { key: "do_sample", alias: None, serializer: Some( WithDefault( WithDefaultSerializer { default: Default( Py( 0x0000563c55c1c6e0, ), ), serializer: Bool( BoolSerializer, ), }, ), ), required: true, serialize_by_alias: None, serialization_exclude_if: None, }, "k": SerField { key: "k", alias: None, serializer: Some( WithDefault( WithDefaultSerializer { default: Default( Py( 0x00007f222f300710, ), ), serializer: Int( IntSerializer, ), }, ), ), required: true, serialize_by_alias: None, serialization_exclude_if: None, }, "number_of_sequences": SerField { key: "number_of_sequences", alias: None, serializer: Some( WithDefault( WithDefaultSerializer { default: Default( Py( 0x00007f222f3001d0, ), ), serializer: Int( IntSerializer, ), }, ), ), required: true, serialize_by_alias: None, serialization_exclude_if: None, }, "repetition_penalty": SerField { key: "repetition_penalty", alias: None, serializer: Some( WithDefault( WithDefaultSerializer { default: Default( Py( 0x00007f214cdf2910, ), ), serializer: Float( FloatSerializer { inf_nan_mode: Null, }, ), }, ), ), required: true, serialize_by_alias: None, serialization_exclude_if: None, }, "length": SerField { key: "length", alias: None, serializer: Some( WithDefault( WithDefaultSerializer { default: Default( Py( 0x00007f222f300350, ), ), serializer: Int( IntSerializer, ), }, ), ), required: true, serialize_by_alias: None, serialization_exclude_if: None, }, }, computed_fields: Some( ComputedFields( [], ), ), mode: SimpleDict, extra_serializer: None, filter: SchemaFilter { include: None, exclude: None, }, required_fields: 13, }, ), fields: [ Py( 0x00007f222affaf10, ), Py( 0x00007f222ba93fb0, ), Py( 0x00007f222ef49930, ), Py( 0x00007f222ec451b0, ), Py( 0x00007f221b70d830, ), Py( 0x00007f2166ad85f0, ), Py( 0x00007f2166ab6730, ), Py( 0x00007f21b65bb8b0, ), Py( 0x00007f2166ab2c90, ), Py( 0x00007f222ef253f0, ), Py( 0x00007f222f3c85b0, ), Py( 0x00007f222f3b75b0, ), Py( 0x00007f214712b4b0, ), ], name: "HuggingFaceOpenAIGPTGenerator", }, ), enabled_from_config: false, }, ), enabled_from_config: false, }, ), definitions=[])¶

__pydantic_validator__ = SchemaValidator(title="HuggingFaceOpenAIGPTGenerator", validator=Dataclass( DataclassValidator { strict: false, validator: DataclassArgs( DataclassArgsValidator { fields: [ Field { kw_only: false, name: "algorithm_version", init: true, init_only: false, lookup_path_collection: LookupPathCollection { by_name: LookupPath { first_item: PathItemString( "algorithm_version", ), rest: [], }, by_alias: [], }, validator: WithDefault( WithDefaultValidator { default: Default( Py( 0x00007f214c6a7d70, ), ), on_error: Raise, validator: Str( StrValidator { strict: false, coerce_numbers_to_str: false, }, ), validate_default: false, copy_default: false, name: "default[str]", undefined: Py( 0x00007f222cf13af0, ), }, ), frozen: false, }, Field { kw_only: false, name: "model_type", init: true, init_only: false, lookup_path_collection: LookupPathCollection { by_name: LookupPath { first_item: PathItemString( "model_type", ), rest: [], }, by_alias: [], }, validator: WithDefault( WithDefaultValidator { default: Default( Py( 0x00007f214c6a7d70, ), ), on_error: Raise, validator: Str( StrValidator { strict: false, coerce_numbers_to_str: false, }, ), validate_default: false, copy_default: false, name: "default[str]", undefined: Py( 0x00007f222cf13af0, ), }, ), frozen: false, }, Field { kw_only: false, name: "prompt", init: true, init_only: false, lookup_path_collection: LookupPathCollection { by_name: LookupPath { first_item: PathItemString( "prompt", ), rest: [], }, by_alias: [], }, validator: WithDefault( WithDefaultValidator { default: Default( Py( 0x00007f214712b2d0, ), ), on_error: Raise, validator: Str( StrValidator { strict: false, coerce_numbers_to_str: false, }, ), validate_default: false, copy_default: false, name: "default[str]", undefined: Py( 0x00007f222cf13af0, ), }, ), frozen: false, }, Field { kw_only: false, name: "length", init: true, init_only: false, lookup_path_collection: LookupPathCollection { by_name: LookupPath { first_item: PathItemString( "length", ), rest: [], }, by_alias: [], }, validator: WithDefault( WithDefaultValidator { default: Default( Py( 0x00007f222f300350, ), ), on_error: Raise, validator: Int( IntValidator { strict: false, }, ), validate_default: false, copy_default: false, name: "default[int]", undefined: Py( 0x00007f222cf13af0, ), }, ), frozen: false, }, Field { kw_only: false, name: "stop_token", init: true, init_only: false, lookup_path_collection: LookupPathCollection { by_name: LookupPath { first_item: PathItemString( "stop_token", ), rest: [], }, by_alias: [], }, validator: WithDefault( WithDefaultValidator { default: Default( Py( 0x00007f222f308030, ), ), on_error: Raise, validator: Str( StrValidator { strict: false, coerce_numbers_to_str: false, }, ), validate_default: false, copy_default: false, name: "default[str]", undefined: Py( 0x00007f222cf13af0, ), }, ), frozen: false, }, Field { kw_only: false, name: "num_beams", init: true, init_only: false, lookup_path_collection: LookupPathCollection { by_name: LookupPath { first_item: PathItemString( "num_beams", ), rest: [], }, by_alias: [], }, validator: WithDefault( WithDefaultValidator { default: Default( Py( 0x00007f222f3000f0, ), ), on_error: Raise, validator: Int( IntValidator { strict: false, }, ), validate_default: false, copy_default: false, name: "default[int]", undefined: Py( 0x00007f222cf13af0, ), }, ), frozen: false, }, Field { kw_only: false, name: "do_sample", init: true, init_only: false, lookup_path_collection: LookupPathCollection { by_name: LookupPath { first_item: PathItemString( "do_sample", ), rest: [], }, by_alias: [], }, validator: WithDefault( WithDefaultValidator { default: Default( Py( 0x0000563c55c1c6e0, ), ), on_error: Raise, validator: Bool( BoolValidator { strict: false, }, ), validate_default: false, copy_default: false, name: "default[bool]", undefined: Py( 0x00007f222cf13af0, ), }, ), frozen: false, }, Field { kw_only: false, name: "temperature", init: true, init_only: false, lookup_path_collection: LookupPathCollection { by_name: LookupPath { first_item: PathItemString( "temperature", ), rest: [], }, by_alias: [], }, validator: WithDefault( WithDefaultValidator { default: Default( Py( 0x00007f214cdf2910, ), ), on_error: Raise, validator: Float( FloatValidator { strict: false, allow_inf_nan: true, }, ), validate_default: false, copy_default: false, name: "default[float]", undefined: Py( 0x00007f222cf13af0, ), }, ), frozen: false, }, Field { kw_only: false, name: "repetition_penalty", init: true, init_only: false, lookup_path_collection: LookupPathCollection { by_name: LookupPath { first_item: PathItemString( "repetition_penalty", ), rest: [], }, by_alias: [], }, validator: WithDefault( WithDefaultValidator { default: Default( Py( 0x00007f214cdf2910, ), ), on_error: Raise, validator: Float( FloatValidator { strict: false, allow_inf_nan: true, }, ), validate_default: false, copy_default: false, name: "default[float]", undefined: Py( 0x00007f222cf13af0, ), }, ), frozen: false, }, Field { kw_only: false, name: "k", init: true, init_only: false, lookup_path_collection: LookupPathCollection { by_name: LookupPath { first_item: PathItemString( "k", ), rest: [], }, by_alias: [], }, validator: WithDefault( WithDefaultValidator { default: Default( Py( 0x00007f222f300710, ), ), on_error: Raise, validator: Int( IntValidator { strict: false, }, ), validate_default: false, copy_default: false, name: "default[int]", undefined: Py( 0x00007f222cf13af0, ), }, ), frozen: false, }, Field { kw_only: false, name: "p", init: true, init_only: false, lookup_path_collection: LookupPathCollection { by_name: LookupPath { first_item: PathItemString( "p", ), rest: [], }, by_alias: [], }, validator: WithDefault( WithDefaultValidator { default: Default( Py( 0x00007f214cdf2910, ), ), on_error: Raise, validator: Float( FloatValidator { strict: false, allow_inf_nan: true, }, ), validate_default: false, copy_default: false, name: "default[float]", undefined: Py( 0x00007f222cf13af0, ), }, ), frozen: false, }, Field { kw_only: false, name: "prefix", init: true, init_only: false, lookup_path_collection: LookupPathCollection { by_name: LookupPath { first_item: PathItemString( "prefix", ), rest: [], }, by_alias: [], }, validator: WithDefault( WithDefaultValidator { default: Default( Py( 0x00007f222f308030, ), ), on_error: Raise, validator: Str( StrValidator { strict: false, coerce_numbers_to_str: false, }, ), validate_default: false, copy_default: false, name: "default[str]", undefined: Py( 0x00007f222cf13af0, ), }, ), frozen: false, }, Field { kw_only: false, name: "number_of_sequences", init: true, init_only: false, lookup_path_collection: LookupPathCollection { by_name: LookupPath { first_item: PathItemString( "number_of_sequences", ), rest: [], }, by_alias: [], }, validator: WithDefault( WithDefaultValidator { default: Default( Py( 0x00007f222f3001d0, ), ), on_error: Raise, validator: Int( IntValidator { strict: false, }, ), validate_default: false, copy_default: false, name: "default[int]", undefined: Py( 0x00007f222cf13af0, ), }, ), frozen: false, }, ], positional_count: 13, init_only_count: None, dataclass_name: "HuggingFaceOpenAIGPTGenerator", validator_name: "dataclass-args[HuggingFaceOpenAIGPTGenerator]", extra_behavior: Ignore, extras_validator: None, loc_by_alias: true, validate_by_alias: None, validate_by_name: None, }, ), class: Py( 0x0000563c9cbcb7b0, ), generic_origin: None, fields: [ Py( 0x00007f222affaf10, ), Py( 0x00007f222ba93fb0, ), Py( 0x00007f222ef49930, ), Py( 0x00007f222ec451b0, ), Py( 0x00007f221b70d830, ), Py( 0x00007f2166ad85f0, ), Py( 0x00007f2166ab6730, ), Py( 0x00007f21b65bb8b0, ), Py( 0x00007f2166ab2c90, ), Py( 0x00007f222ef253f0, ), Py( 0x00007f222f3c85b0, ), Py( 0x00007f222f3b75b0, ), Py( 0x00007f214712b4b0, ), ], post_init: None, revalidate: Never, name: "HuggingFaceOpenAIGPTGenerator", frozen: false, slots: true, }, ), definitions=[], cache_strings=True)¶

__repr__()¶: Return repr(self).

__signature__ = <Signature (*args: Any, algorithm_version: str = 'openai-gpt', model_type: str = 'openai-gpt', prompt: str = "I'm a stochastic parrot.", length: int = 20, stop_token: str = '', num_beams: int = 1, do_sample: bool = True, temperature: float = 1.0, repetition_penalty: float = 1.0, k: int = 50, p: float = 1.0, prefix: str = '', number_of_sequences: int = 8) -> None>¶

__wrapped__¶: alias of HuggingFaceOpenAIGPTGenerator

algorithm_application: ClassVar[str] = 'HuggingFaceOpenAIGPTGenerator'¶

Unique name for the application that is the use of this configuration together with a specific algorithm.

Will be set when registering to ApplicationsRegistry, but can be given by direct registration (See register_algorithm_application)

algorithm_name: ClassVar[str] = 'HuggingFaceGenerationAlgorithm'¶

Name of the algorithm to use with this configuration.

Will be set when registering to ApplicationsRegistry

class HuggingFaceXLNetGenerator(*args, **kwargs)[source]¶

Bases: HuggingFaceXLNetGenerator

Configuration to generate text using XLNet.

algorithm_version: str = 'xlnet-large-cased'¶

To differentiate between different versions of an application.

There is no imposed naming convention.

model_type: str = 'xlnet'¶

classmethod list_versions()[source]¶

Get possible algorithm versions.

Standard S3 and cache search adding the version used in the configuration.

Return type: Set[str]
Returns: viable values as algorithm_version for the environment.

__annotations__ = {'algorithm_application': 'ClassVar[str]', 'algorithm_name': 'ClassVar[str]', 'algorithm_type': 'ClassVar[str]', 'algorithm_version': <class 'str'>, 'do_sample': 'bool', 'domain': 'ClassVar[str]', 'k': 'int', 'length': 'int', 'model_type': <class 'str'>, 'num_beams': 'int', 'number_of_sequences': 'int', 'p': 'float', 'prefix': 'str', 'prompt': 'str', 'repetition_penalty': 'float', 'stop_token': 'str', 'temperature': 'float'}¶

__dataclass_fields__ = {'algorithm_application': Field(name='algorithm_application',type=typing.ClassVar[str],default='HuggingFaceXLNetGenerator',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='HuggingFaceGenerationAlgorithm',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='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='xlnet-large-cased',default_factory=<dataclasses._MISSING_TYPE object>,init=True,repr=True,hash=None,compare=True,metadata=mappingproxy({}),kw_only=False,_field_type=_FIELD), 'do_sample': Field(name='do_sample',type=<class 'bool'>,default=True,default_factory=<dataclasses._MISSING_TYPE object>,init=True,repr=True,hash=None,compare=True,metadata=mappingproxy({'description': 'Whether or not to use sampling; use greedy decoding otherwise.'}),kw_only=False,_field_type=_FIELD), 'domain': Field(name='domain',type=typing.ClassVar[str],default='nlp',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), 'k': Field(name='k',type=<class 'int'>,default=50,default_factory=<dataclasses._MISSING_TYPE object>,init=True,repr=True,hash=None,compare=True,metadata=mappingproxy({'description': 'Number of top-k probability tokens to keep.'}),kw_only=False,_field_type=_FIELD), 'length': Field(name='length',type=<class 'int'>,default=20,default_factory=<dataclasses._MISSING_TYPE object>,init=True,repr=True,hash=None,compare=True,metadata=mappingproxy({'description': 'Length of the generated text.'}),kw_only=False,_field_type=_FIELD), 'model_type': Field(name='model_type',type=<class 'str'>,default='xlnet',default_factory=<dataclasses._MISSING_TYPE object>,init=True,repr=True,hash=None,compare=True,metadata=mappingproxy({}),kw_only=False,_field_type=_FIELD), 'num_beams': Field(name='num_beams',type=<class 'int'>,default=1,default_factory=<dataclasses._MISSING_TYPE object>,init=True,repr=True,hash=None,compare=True,metadata=mappingproxy({'description': 'Number of beams for beam search.'}),kw_only=False,_field_type=_FIELD), 'number_of_sequences': Field(name='number_of_sequences',type=<class 'int'>,default=8,default_factory=<dataclasses._MISSING_TYPE object>,init=True,repr=True,hash=None,compare=True,metadata=mappingproxy({'description': 'Number of text sequences to generate.'}),kw_only=False,_field_type=_FIELD), 'p': Field(name='p',type=<class 'float'>,default=1.0,default_factory=<dataclasses._MISSING_TYPE object>,init=True,repr=True,hash=None,compare=True,metadata=mappingproxy({'description': 'Only tokens with cumulative probabilities summing up to this value are kept.'}),kw_only=False,_field_type=_FIELD), 'prefix': Field(name='prefix',type=<class 'str'>,default='',default_factory=<dataclasses._MISSING_TYPE object>,init=True,repr=True,hash=None,compare=True,metadata=mappingproxy({'description': 'Text defining context provided prior to the prompt.'}),kw_only=False,_field_type=_FIELD), 'prompt': Field(name='prompt',type=<class 'str'>,default="I'm a stochastic parrot.",default_factory=<dataclasses._MISSING_TYPE object>,init=True,repr=True,hash=None,compare=True,metadata=mappingproxy({'description': 'Prompt for text generation.'}),kw_only=False,_field_type=_FIELD), 'repetition_penalty': Field(name='repetition_penalty',type=<class 'float'>,default=1.0,default_factory=<dataclasses._MISSING_TYPE object>,init=True,repr=True,hash=None,compare=True,metadata=mappingproxy({'description': 'Primarily useful for CTRL model, where 1.2 should be used.'}),kw_only=False,_field_type=_FIELD), 'stop_token': Field(name='stop_token',type=<class 'str'>,default='',default_factory=<dataclasses._MISSING_TYPE object>,init=True,repr=True,hash=None,compare=True,metadata=mappingproxy({'description': 'Stop token for text generation.'}),kw_only=False,_field_type=_FIELD), 'temperature': Field(name='temperature',type=<class 'float'>,default=1.0,default_factory=<dataclasses._MISSING_TYPE object>,init=True,repr=True,hash=None,compare=True,metadata=mappingproxy({'description': 'Temperature for sampling, the lower the greedier the sampling.'}),kw_only=False,_field_type=_FIELD)}¶

__dataclass_params__ = _DataclassParams(init=True,repr=True,eq=True,order=False,unsafe_hash=False,frozen=False)¶

__doc__ = 'Configuration to generate text using XLNet.'¶

__eq__(other)¶: Return self==value.

__hash__ = None¶

__init__(*args, **kwargs)¶

__is_pydantic_dataclass__ = True¶

__match_args__ = ('algorithm_version', 'model_type', 'prompt', 'length', 'stop_token', 'num_beams', 'do_sample', 'temperature', 'repetition_penalty', 'k', 'p', 'prefix', 'number_of_sequences')¶

__module__ = 'gt4sd.algorithms.generation.hugging_face.core'¶

__parameters__ = (~T,)¶

__pydantic_complete__ = True¶

__pydantic_config__ = {}¶

__pydantic_core_schema__ = {'cls': <class 'gt4sd.algorithms.generation.hugging_face.core.HuggingFaceXLNetGenerator'>, 'config': {'title': 'HuggingFaceXLNetGenerator'}, 'fields': ['algorithm_version', 'model_type', 'prompt', 'length', 'stop_token', 'num_beams', 'do_sample', 'temperature', 'repetition_penalty', 'k', 'p', 'prefix', 'number_of_sequences'], 'frozen': False, 'post_init': False, 'ref': 'types.HuggingFaceXLNetGenerator:94818327536160', 'schema': {'collect_init_only': False, 'computed_fields': [], 'dataclass_name': 'HuggingFaceXLNetGenerator', 'fields': [{'type': 'dataclass-field', 'name': 'algorithm_version', 'schema': {'type': 'default', 'schema': {'type': 'str'}, 'default': 'xlnet-large-cased'}, 'kw_only': False, 'init': True, 'metadata': {}}, {'type': 'dataclass-field', 'name': 'model_type', 'schema': {'type': 'default', 'schema': {'type': 'str'}, 'default': 'xlnet'}, 'kw_only': False, 'init': True, 'metadata': {}}, {'type': 'dataclass-field', 'name': 'prompt', 'schema': {'type': 'default', 'schema': {'type': 'str'}, 'default': "I'm a stochastic parrot."}, 'kw_only': False, 'init': True, 'metadata': {'pydantic_js_updates': {'description': 'Prompt for text generation.'}}}, {'type': 'dataclass-field', 'name': 'length', 'schema': {'type': 'default', 'schema': {'type': 'int'}, 'default': 20}, 'kw_only': False, 'init': True, 'metadata': {'pydantic_js_updates': {'description': 'Length of the generated text.'}}}, {'type': 'dataclass-field', 'name': 'stop_token', 'schema': {'type': 'default', 'schema': {'type': 'str'}, 'default': ''}, 'kw_only': False, 'init': True, 'metadata': {'pydantic_js_updates': {'description': 'Stop token for text generation.'}}}, {'type': 'dataclass-field', 'name': 'num_beams', 'schema': {'type': 'default', 'schema': {'type': 'int'}, 'default': 1}, 'kw_only': False, 'init': True, 'metadata': {'pydantic_js_updates': {'description': 'Number of beams for beam search.'}}}, {'type': 'dataclass-field', 'name': 'do_sample', 'schema': {'type': 'default', 'schema': {'type': 'bool'}, 'default': True}, 'kw_only': False, 'init': True, 'metadata': {'pydantic_js_updates': {'description': 'Whether or not to use sampling; use greedy decoding otherwise.'}}}, {'type': 'dataclass-field', 'name': 'temperature', 'schema': {'type': 'default', 'schema': {'type': 'float'}, 'default': 1.0}, 'kw_only': False, 'init': True, 'metadata': {'pydantic_js_updates': {'description': 'Temperature for sampling, the lower the greedier the sampling.'}}}, {'type': 'dataclass-field', 'name': 'repetition_penalty', 'schema': {'type': 'default', 'schema': {'type': 'float'}, 'default': 1.0}, 'kw_only': False, 'init': True, 'metadata': {'pydantic_js_updates': {'description': 'Primarily useful for CTRL model, where 1.2 should be used.'}}}, {'type': 'dataclass-field', 'name': 'k', 'schema': {'type': 'default', 'schema': {'type': 'int'}, 'default': 50}, 'kw_only': False, 'init': True, 'metadata': {'pydantic_js_updates': {'description': 'Number of top-k probability tokens to keep.'}}}, {'type': 'dataclass-field', 'name': 'p', 'schema': {'type': 'default', 'schema': {'type': 'float'}, 'default': 1.0}, 'kw_only': False, 'init': True, 'metadata': {'pydantic_js_updates': {'description': 'Only tokens with cumulative probabilities summing up to this value are kept.'}}}, {'type': 'dataclass-field', 'name': 'prefix', 'schema': {'type': 'default', 'schema': {'type': 'str'}, 'default': ''}, 'kw_only': False, 'init': True, 'metadata': {'pydantic_js_updates': {'description': 'Text defining context provided prior to the prompt.'}}}, {'type': 'dataclass-field', 'name': 'number_of_sequences', 'schema': {'type': 'default', 'schema': {'type': 'int'}, 'default': 8}, 'kw_only': False, 'init': True, 'metadata': {'pydantic_js_updates': {'description': 'Number of text sequences to generate.'}}}], '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='xlnet-large-cased', init=True, kw_only=False), 'do_sample': FieldInfo(annotation=bool, required=False, default=True, description='Whether or not to use sampling; use greedy decoding otherwise.', init=True, kw_only=False), 'k': FieldInfo(annotation=int, required=False, default=50, description='Number of top-k probability tokens to keep.', init=True, kw_only=False), 'length': FieldInfo(annotation=int, required=False, default=20, description='Length of the generated text.', init=True, kw_only=False), 'model_type': FieldInfo(annotation=str, required=False, default='xlnet', init=True, kw_only=False), 'num_beams': FieldInfo(annotation=int, required=False, default=1, description='Number of beams for beam search.', init=True, kw_only=False), 'number_of_sequences': FieldInfo(annotation=int, required=False, default=8, description='Number of text sequences to generate.', init=True, kw_only=False), 'p': FieldInfo(annotation=float, required=False, default=1.0, description='Only tokens with cumulative probabilities summing up to this value are kept.', init=True, kw_only=False), 'prefix': FieldInfo(annotation=str, required=False, default='', description='Text defining context provided prior to the prompt.', init=True, kw_only=False), 'prompt': FieldInfo(annotation=str, required=False, default="I'm a stochastic parrot.", description='Prompt for text generation.', init=True, kw_only=False), 'repetition_penalty': FieldInfo(annotation=float, required=False, default=1.0, description='Primarily useful for CTRL model, where 1.2 should be used.', init=True, kw_only=False), 'stop_token': FieldInfo(annotation=str, required=False, default='', description='Stop token for text generation.', init=True, kw_only=False), 'temperature': FieldInfo(annotation=float, required=False, default=1.0, description='Temperature for sampling, the lower the greedier the sampling.', init=True, kw_only=False)}¶

classmethod __pydantic_fields_complete__()¶

Return whether the fields were successfully collected (i.e. type hints were successfully resolved).

This is a private helper, not meant to be used outside Pydantic.

Return type: bool

__pydantic_serializer__ = SchemaSerializer(serializer=PolymorphismTrampoline( PolymorphismTrampoline { class: Py( 0x0000563c9cbb2220, ), serializer: PolymorphismTrampoline( PolymorphismTrampoline { class: Py( 0x0000563c9cbb2220, ), serializer: Dataclass( DataclassSerializer { class: Py( 0x0000563c9cbb2220, ), serializer: Fields( GeneralFieldsSerializer { fields: { "num_beams": SerField { key: "num_beams", alias: None, serializer: Some( WithDefault( WithDefaultSerializer { default: Default( Py( 0x00007f222f3000f0, ), ), serializer: Int( IntSerializer, ), }, ), ), required: true, serialize_by_alias: None, serialization_exclude_if: None, }, "k": SerField { key: "k", alias: None, serializer: Some( WithDefault( WithDefaultSerializer { default: Default( Py( 0x00007f222f300710, ), ), serializer: Int( IntSerializer, ), }, ), ), required: true, serialize_by_alias: None, serialization_exclude_if: None, }, "do_sample": SerField { key: "do_sample", alias: None, serializer: Some( WithDefault( WithDefaultSerializer { default: Default( Py( 0x0000563c55c1c6e0, ), ), serializer: Bool( BoolSerializer, ), }, ), ), required: true, serialize_by_alias: None, serialization_exclude_if: None, }, "temperature": SerField { key: "temperature", alias: None, serializer: Some( WithDefault( WithDefaultSerializer { default: Default( Py( 0x00007f214cdf2910, ), ), serializer: Float( FloatSerializer { inf_nan_mode: Null, }, ), }, ), ), required: true, serialize_by_alias: None, serialization_exclude_if: None, }, "stop_token": SerField { key: "stop_token", alias: None, serializer: Some( WithDefault( WithDefaultSerializer { default: Default( Py( 0x00007f222f308030, ), ), serializer: Str( StrSerializer, ), }, ), ), required: true, serialize_by_alias: None, serialization_exclude_if: None, }, "p": SerField { key: "p", alias: None, serializer: Some( WithDefault( WithDefaultSerializer { default: Default( Py( 0x00007f214cdf2910, ), ), serializer: Float( FloatSerializer { inf_nan_mode: Null, }, ), }, ), ), required: true, serialize_by_alias: None, serialization_exclude_if: None, }, "length": SerField { key: "length", alias: None, serializer: Some( WithDefault( WithDefaultSerializer { default: Default( Py( 0x00007f222f300350, ), ), serializer: Int( IntSerializer, ), }, ), ), required: true, serialize_by_alias: None, serialization_exclude_if: None, }, "algorithm_version": SerField { key: "algorithm_version", alias: None, serializer: Some( WithDefault( WithDefaultSerializer { default: Default( Py( 0x00007f214712b640, ), ), serializer: Str( StrSerializer, ), }, ), ), required: true, serialize_by_alias: None, serialization_exclude_if: None, }, "prefix": SerField { key: "prefix", alias: None, serializer: Some( WithDefault( WithDefaultSerializer { default: Default( Py( 0x00007f222f308030, ), ), serializer: Str( StrSerializer, ), }, ), ), required: true, serialize_by_alias: None, serialization_exclude_if: None, }, "number_of_sequences": SerField { key: "number_of_sequences", alias: None, serializer: Some( WithDefault( WithDefaultSerializer { default: Default( Py( 0x00007f222f3001d0, ), ), serializer: Int( IntSerializer, ), }, ), ), required: true, serialize_by_alias: None, serialization_exclude_if: None, }, "prompt": SerField { key: "prompt", alias: None, serializer: Some( WithDefault( WithDefaultSerializer { default: Default( Py( 0x00007f214712b2d0, ), ), serializer: Str( StrSerializer, ), }, ), ), required: true, serialize_by_alias: None, serialization_exclude_if: None, }, "repetition_penalty": SerField { key: "repetition_penalty", alias: None, serializer: Some( WithDefault( WithDefaultSerializer { default: Default( Py( 0x00007f214cdf2910, ), ), serializer: Float( FloatSerializer { inf_nan_mode: Null, }, ), }, ), ), required: true, serialize_by_alias: None, serialization_exclude_if: None, }, "model_type": SerField { key: "model_type", alias: None, serializer: Some( WithDefault( WithDefaultSerializer { default: Default( Py( 0x00007f216688cbb0, ), ), serializer: Str( StrSerializer, ), }, ), ), required: true, serialize_by_alias: None, serialization_exclude_if: None, }, }, computed_fields: Some( ComputedFields( [], ), ), mode: SimpleDict, extra_serializer: None, filter: SchemaFilter { include: None, exclude: None, }, required_fields: 13, }, ), fields: [ Py( 0x00007f222affaf10, ), Py( 0x00007f222ba93fb0, ), Py( 0x00007f222ef49930, ), Py( 0x00007f222ec451b0, ), Py( 0x00007f221b70d830, ), Py( 0x00007f2166ad85f0, ), Py( 0x00007f2166ab6730, ), Py( 0x00007f21b65bb8b0, ), Py( 0x00007f2166ab2c90, ), Py( 0x00007f222ef253f0, ), Py( 0x00007f222f3c85b0, ), Py( 0x00007f222f3b75b0, ), Py( 0x00007f214712b4b0, ), ], name: "HuggingFaceXLNetGenerator", }, ), enabled_from_config: false, }, ), enabled_from_config: false, }, ), definitions=[])¶

__pydantic_validator__ = SchemaValidator(title="HuggingFaceXLNetGenerator", validator=Dataclass( DataclassValidator { strict: false, validator: DataclassArgs( DataclassArgsValidator { fields: [ Field { kw_only: false, name: "algorithm_version", init: true, init_only: false, lookup_path_collection: LookupPathCollection { by_name: LookupPath { first_item: PathItemString( "algorithm_version", ), rest: [], }, by_alias: [], }, validator: WithDefault( WithDefaultValidator { default: Default( Py( 0x00007f214712b640, ), ), on_error: Raise, validator: Str( StrValidator { strict: false, coerce_numbers_to_str: false, }, ), validate_default: false, copy_default: false, name: "default[str]", undefined: Py( 0x00007f222cf13af0, ), }, ), frozen: false, }, Field { kw_only: false, name: "model_type", init: true, init_only: false, lookup_path_collection: LookupPathCollection { by_name: LookupPath { first_item: PathItemString( "model_type", ), rest: [], }, by_alias: [], }, validator: WithDefault( WithDefaultValidator { default: Default( Py( 0x00007f216688cbb0, ), ), on_error: Raise, validator: Str( StrValidator { strict: false, coerce_numbers_to_str: false, }, ), validate_default: false, copy_default: false, name: "default[str]", undefined: Py( 0x00007f222cf13af0, ), }, ), frozen: false, }, Field { kw_only: false, name: "prompt", init: true, init_only: false, lookup_path_collection: LookupPathCollection { by_name: LookupPath { first_item: PathItemString( "prompt", ), rest: [], }, by_alias: [], }, validator: WithDefault( WithDefaultValidator { default: Default( Py( 0x00007f214712b2d0, ), ), on_error: Raise, validator: Str( StrValidator { strict: false, coerce_numbers_to_str: false, }, ), validate_default: false, copy_default: false, name: "default[str]", undefined: Py( 0x00007f222cf13af0, ), }, ), frozen: false, }, Field { kw_only: false, name: "length", init: true, init_only: false, lookup_path_collection: LookupPathCollection { by_name: LookupPath { first_item: PathItemString( "length", ), rest: [], }, by_alias: [], }, validator: WithDefault( WithDefaultValidator { default: Default( Py( 0x00007f222f300350, ), ), on_error: Raise, validator: Int( IntValidator { strict: false, }, ), validate_default: false, copy_default: false, name: "default[int]", undefined: Py( 0x00007f222cf13af0, ), }, ), frozen: false, }, Field { kw_only: false, name: "stop_token", init: true, init_only: false, lookup_path_collection: LookupPathCollection { by_name: LookupPath { first_item: PathItemString( "stop_token", ), rest: [], }, by_alias: [], }, validator: WithDefault( WithDefaultValidator { default: Default( Py( 0x00007f222f308030, ), ), on_error: Raise, validator: Str( StrValidator { strict: false, coerce_numbers_to_str: false, }, ), validate_default: false, copy_default: false, name: "default[str]", undefined: Py( 0x00007f222cf13af0, ), }, ), frozen: false, }, Field { kw_only: false, name: "num_beams", init: true, init_only: false, lookup_path_collection: LookupPathCollection { by_name: LookupPath { first_item: PathItemString( "num_beams", ), rest: [], }, by_alias: [], }, validator: WithDefault( WithDefaultValidator { default: Default( Py( 0x00007f222f3000f0, ), ), on_error: Raise, validator: Int( IntValidator { strict: false, }, ), validate_default: false, copy_default: false, name: "default[int]", undefined: Py( 0x00007f222cf13af0, ), }, ), frozen: false, }, Field { kw_only: false, name: "do_sample", init: true, init_only: false, lookup_path_collection: LookupPathCollection { by_name: LookupPath { first_item: PathItemString( "do_sample", ), rest: [], }, by_alias: [], }, validator: WithDefault( WithDefaultValidator { default: Default( Py( 0x0000563c55c1c6e0, ), ), on_error: Raise, validator: Bool( BoolValidator { strict: false, }, ), validate_default: false, copy_default: false, name: "default[bool]", undefined: Py( 0x00007f222cf13af0, ), }, ), frozen: false, }, Field { kw_only: false, name: "temperature", init: true, init_only: false, lookup_path_collection: LookupPathCollection { by_name: LookupPath { first_item: PathItemString( "temperature", ), rest: [], }, by_alias: [], }, validator: WithDefault( WithDefaultValidator { default: Default( Py( 0x00007f214cdf2910, ), ), on_error: Raise, validator: Float( FloatValidator { strict: false, allow_inf_nan: true, }, ), validate_default: false, copy_default: false, name: "default[float]", undefined: Py( 0x00007f222cf13af0, ), }, ), frozen: false, }, Field { kw_only: false, name: "repetition_penalty", init: true, init_only: false, lookup_path_collection: LookupPathCollection { by_name: LookupPath { first_item: PathItemString( "repetition_penalty", ), rest: [], }, by_alias: [], }, validator: WithDefault( WithDefaultValidator { default: Default( Py( 0x00007f214cdf2910, ), ), on_error: Raise, validator: Float( FloatValidator { strict: false, allow_inf_nan: true, }, ), validate_default: false, copy_default: false, name: "default[float]", undefined: Py( 0x00007f222cf13af0, ), }, ), frozen: false, }, Field { kw_only: false, name: "k", init: true, init_only: false, lookup_path_collection: LookupPathCollection { by_name: LookupPath { first_item: PathItemString( "k", ), rest: [], }, by_alias: [], }, validator: WithDefault( WithDefaultValidator { default: Default( Py( 0x00007f222f300710, ), ), on_error: Raise, validator: Int( IntValidator { strict: false, }, ), validate_default: false, copy_default: false, name: "default[int]", undefined: Py( 0x00007f222cf13af0, ), }, ), frozen: false, }, Field { kw_only: false, name: "p", init: true, init_only: false, lookup_path_collection: LookupPathCollection { by_name: LookupPath { first_item: PathItemString( "p", ), rest: [], }, by_alias: [], }, validator: WithDefault( WithDefaultValidator { default: Default( Py( 0x00007f214cdf2910, ), ), on_error: Raise, validator: Float( FloatValidator { strict: false, allow_inf_nan: true, }, ), validate_default: false, copy_default: false, name: "default[float]", undefined: Py( 0x00007f222cf13af0, ), }, ), frozen: false, }, Field { kw_only: false, name: "prefix", init: true, init_only: false, lookup_path_collection: LookupPathCollection { by_name: LookupPath { first_item: PathItemString( "prefix", ), rest: [], }, by_alias: [], }, validator: WithDefault( WithDefaultValidator { default: Default( Py( 0x00007f222f308030, ), ), on_error: Raise, validator: Str( StrValidator { strict: false, coerce_numbers_to_str: false, }, ), validate_default: false, copy_default: false, name: "default[str]", undefined: Py( 0x00007f222cf13af0, ), }, ), frozen: false, }, Field { kw_only: false, name: "number_of_sequences", init: true, init_only: false, lookup_path_collection: LookupPathCollection { by_name: LookupPath { first_item: PathItemString( "number_of_sequences", ), rest: [], }, by_alias: [], }, validator: WithDefault( WithDefaultValidator { default: Default( Py( 0x00007f222f3001d0, ), ), on_error: Raise, validator: Int( IntValidator { strict: false, }, ), validate_default: false, copy_default: false, name: "default[int]", undefined: Py( 0x00007f222cf13af0, ), }, ), frozen: false, }, ], positional_count: 13, init_only_count: None, dataclass_name: "HuggingFaceXLNetGenerator", validator_name: "dataclass-args[HuggingFaceXLNetGenerator]", extra_behavior: Ignore, extras_validator: None, loc_by_alias: true, validate_by_alias: None, validate_by_name: None, }, ), class: Py( 0x0000563c9cbb2220, ), generic_origin: None, fields: [ Py( 0x00007f222affaf10, ), Py( 0x00007f222ba93fb0, ), Py( 0x00007f222ef49930, ), Py( 0x00007f222ec451b0, ), Py( 0x00007f221b70d830, ), Py( 0x00007f2166ad85f0, ), Py( 0x00007f2166ab6730, ), Py( 0x00007f21b65bb8b0, ), Py( 0x00007f2166ab2c90, ), Py( 0x00007f222ef253f0, ), Py( 0x00007f222f3c85b0, ), Py( 0x00007f222f3b75b0, ), Py( 0x00007f214712b4b0, ), ], post_init: None, revalidate: Never, name: "HuggingFaceXLNetGenerator", frozen: false, slots: true, }, ), definitions=[], cache_strings=True)¶

__repr__()¶: Return repr(self).

__signature__ = <Signature (*args: Any, algorithm_version: str = 'xlnet-large-cased', model_type: str = 'xlnet', prompt: str = "I'm a stochastic parrot.", length: int = 20, stop_token: str = '', num_beams: int = 1, do_sample: bool = True, temperature: float = 1.0, repetition_penalty: float = 1.0, k: int = 50, p: float = 1.0, prefix: str = '', number_of_sequences: int = 8) -> None>¶

__wrapped__¶: alias of HuggingFaceXLNetGenerator

algorithm_application: ClassVar[str] = 'HuggingFaceXLNetGenerator'¶

Unique name for the application that is the use of this configuration together with a specific algorithm.

Will be set when registering to ApplicationsRegistry, but can be given by direct registration (See register_algorithm_application)

algorithm_name: ClassVar[str] = 'HuggingFaceGenerationAlgorithm'¶

Name of the algorithm to use with this configuration.

Will be set when registering to ApplicationsRegistry

class HuggingFaceTransfoXLGenerator(*args, **kwargs)[source]¶

Bases: HuggingFaceTransfoXLGenerator

Configuration to generate text using TransfoXL.

algorithm_version: str = 'transfo-xl-wt103'¶

To differentiate between different versions of an application.

There is no imposed naming convention.

model_type: str = 'transfo-xl'¶

classmethod list_versions()[source]¶

Get possible algorithm versions.

Standard S3 and cache search adding the version used in the configuration.

Return type: Set[str]
Returns: viable values as algorithm_version for the environment.

__annotations__ = {'algorithm_application': 'ClassVar[str]', 'algorithm_name': 'ClassVar[str]', 'algorithm_type': 'ClassVar[str]', 'algorithm_version': <class 'str'>, 'do_sample': 'bool', 'domain': 'ClassVar[str]', 'k': 'int', 'length': 'int', 'model_type': <class 'str'>, 'num_beams': 'int', 'number_of_sequences': 'int', 'p': 'float', 'prefix': 'str', 'prompt': 'str', 'repetition_penalty': 'float', 'stop_token': 'str', 'temperature': 'float'}¶

__dataclass_fields__ = {'algorithm_application': Field(name='algorithm_application',type=typing.ClassVar[str],default='HuggingFaceTransfoXLGenerator',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='HuggingFaceGenerationAlgorithm',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='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='transfo-xl-wt103',default_factory=<dataclasses._MISSING_TYPE object>,init=True,repr=True,hash=None,compare=True,metadata=mappingproxy({}),kw_only=False,_field_type=_FIELD), 'do_sample': Field(name='do_sample',type=<class 'bool'>,default=True,default_factory=<dataclasses._MISSING_TYPE object>,init=True,repr=True,hash=None,compare=True,metadata=mappingproxy({'description': 'Whether or not to use sampling; use greedy decoding otherwise.'}),kw_only=False,_field_type=_FIELD), 'domain': Field(name='domain',type=typing.ClassVar[str],default='nlp',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), 'k': Field(name='k',type=<class 'int'>,default=50,default_factory=<dataclasses._MISSING_TYPE object>,init=True,repr=True,hash=None,compare=True,metadata=mappingproxy({'description': 'Number of top-k probability tokens to keep.'}),kw_only=False,_field_type=_FIELD), 'length': Field(name='length',type=<class 'int'>,default=20,default_factory=<dataclasses._MISSING_TYPE object>,init=True,repr=True,hash=None,compare=True,metadata=mappingproxy({'description': 'Length of the generated text.'}),kw_only=False,_field_type=_FIELD), 'model_type': Field(name='model_type',type=<class 'str'>,default='transfo-xl',default_factory=<dataclasses._MISSING_TYPE object>,init=True,repr=True,hash=None,compare=True,metadata=mappingproxy({}),kw_only=False,_field_type=_FIELD), 'num_beams': Field(name='num_beams',type=<class 'int'>,default=1,default_factory=<dataclasses._MISSING_TYPE object>,init=True,repr=True,hash=None,compare=True,metadata=mappingproxy({'description': 'Number of beams for beam search.'}),kw_only=False,_field_type=_FIELD), 'number_of_sequences': Field(name='number_of_sequences',type=<class 'int'>,default=8,default_factory=<dataclasses._MISSING_TYPE object>,init=True,repr=True,hash=None,compare=True,metadata=mappingproxy({'description': 'Number of text sequences to generate.'}),kw_only=False,_field_type=_FIELD), 'p': Field(name='p',type=<class 'float'>,default=1.0,default_factory=<dataclasses._MISSING_TYPE object>,init=True,repr=True,hash=None,compare=True,metadata=mappingproxy({'description': 'Only tokens with cumulative probabilities summing up to this value are kept.'}),kw_only=False,_field_type=_FIELD), 'prefix': Field(name='prefix',type=<class 'str'>,default='',default_factory=<dataclasses._MISSING_TYPE object>,init=True,repr=True,hash=None,compare=True,metadata=mappingproxy({'description': 'Text defining context provided prior to the prompt.'}),kw_only=False,_field_type=_FIELD), 'prompt': Field(name='prompt',type=<class 'str'>,default="I'm a stochastic parrot.",default_factory=<dataclasses._MISSING_TYPE object>,init=True,repr=True,hash=None,compare=True,metadata=mappingproxy({'description': 'Prompt for text generation.'}),kw_only=False,_field_type=_FIELD), 'repetition_penalty': Field(name='repetition_penalty',type=<class 'float'>,default=1.0,default_factory=<dataclasses._MISSING_TYPE object>,init=True,repr=True,hash=None,compare=True,metadata=mappingproxy({'description': 'Primarily useful for CTRL model, where 1.2 should be used.'}),kw_only=False,_field_type=_FIELD), 'stop_token': Field(name='stop_token',type=<class 'str'>,default='',default_factory=<dataclasses._MISSING_TYPE object>,init=True,repr=True,hash=None,compare=True,metadata=mappingproxy({'description': 'Stop token for text generation.'}),kw_only=False,_field_type=_FIELD), 'temperature': Field(name='temperature',type=<class 'float'>,default=1.0,default_factory=<dataclasses._MISSING_TYPE object>,init=True,repr=True,hash=None,compare=True,metadata=mappingproxy({'description': 'Temperature for sampling, the lower the greedier the sampling.'}),kw_only=False,_field_type=_FIELD)}¶

__dataclass_params__ = _DataclassParams(init=True,repr=True,eq=True,order=False,unsafe_hash=False,frozen=False)¶

__doc__ = 'Configuration to generate text using TransfoXL.'¶

__eq__(other)¶: Return self==value.

__hash__ = None¶

__init__(*args, **kwargs)¶

__is_pydantic_dataclass__ = True¶

__match_args__ = ('algorithm_version', 'model_type', 'prompt', 'length', 'stop_token', 'num_beams', 'do_sample', 'temperature', 'repetition_penalty', 'k', 'p', 'prefix', 'number_of_sequences')¶

__module__ = 'gt4sd.algorithms.generation.hugging_face.core'¶

__parameters__ = (~T,)¶

__pydantic_complete__ = True¶

__pydantic_config__ = {}¶

__pydantic_core_schema__ = {'cls': <class 'gt4sd.algorithms.generation.hugging_face.core.HuggingFaceTransfoXLGenerator'>, 'config': {'title': 'HuggingFaceTransfoXLGenerator'}, 'fields': ['algorithm_version', 'model_type', 'prompt', 'length', 'stop_token', 'num_beams', 'do_sample', 'temperature', 'repetition_penalty', 'k', 'p', 'prefix', 'number_of_sequences'], 'frozen': False, 'post_init': False, 'ref': 'types.HuggingFaceTransfoXLGenerator:94818327680336', 'schema': {'collect_init_only': False, 'computed_fields': [], 'dataclass_name': 'HuggingFaceTransfoXLGenerator', 'fields': [{'type': 'dataclass-field', 'name': 'algorithm_version', 'schema': {'type': 'default', 'schema': {'type': 'str'}, 'default': 'transfo-xl-wt103'}, 'kw_only': False, 'init': True, 'metadata': {}}, {'type': 'dataclass-field', 'name': 'model_type', 'schema': {'type': 'default', 'schema': {'type': 'str'}, 'default': 'transfo-xl'}, 'kw_only': False, 'init': True, 'metadata': {}}, {'type': 'dataclass-field', 'name': 'prompt', 'schema': {'type': 'default', 'schema': {'type': 'str'}, 'default': "I'm a stochastic parrot."}, 'kw_only': False, 'init': True, 'metadata': {'pydantic_js_updates': {'description': 'Prompt for text generation.'}}}, {'type': 'dataclass-field', 'name': 'length', 'schema': {'type': 'default', 'schema': {'type': 'int'}, 'default': 20}, 'kw_only': False, 'init': True, 'metadata': {'pydantic_js_updates': {'description': 'Length of the generated text.'}}}, {'type': 'dataclass-field', 'name': 'stop_token', 'schema': {'type': 'default', 'schema': {'type': 'str'}, 'default': ''}, 'kw_only': False, 'init': True, 'metadata': {'pydantic_js_updates': {'description': 'Stop token for text generation.'}}}, {'type': 'dataclass-field', 'name': 'num_beams', 'schema': {'type': 'default', 'schema': {'type': 'int'}, 'default': 1}, 'kw_only': False, 'init': True, 'metadata': {'pydantic_js_updates': {'description': 'Number of beams for beam search.'}}}, {'type': 'dataclass-field', 'name': 'do_sample', 'schema': {'type': 'default', 'schema': {'type': 'bool'}, 'default': True}, 'kw_only': False, 'init': True, 'metadata': {'pydantic_js_updates': {'description': 'Whether or not to use sampling; use greedy decoding otherwise.'}}}, {'type': 'dataclass-field', 'name': 'temperature', 'schema': {'type': 'default', 'schema': {'type': 'float'}, 'default': 1.0}, 'kw_only': False, 'init': True, 'metadata': {'pydantic_js_updates': {'description': 'Temperature for sampling, the lower the greedier the sampling.'}}}, {'type': 'dataclass-field', 'name': 'repetition_penalty', 'schema': {'type': 'default', 'schema': {'type': 'float'}, 'default': 1.0}, 'kw_only': False, 'init': True, 'metadata': {'pydantic_js_updates': {'description': 'Primarily useful for CTRL model, where 1.2 should be used.'}}}, {'type': 'dataclass-field', 'name': 'k', 'schema': {'type': 'default', 'schema': {'type': 'int'}, 'default': 50}, 'kw_only': False, 'init': True, 'metadata': {'pydantic_js_updates': {'description': 'Number of top-k probability tokens to keep.'}}}, {'type': 'dataclass-field', 'name': 'p', 'schema': {'type': 'default', 'schema': {'type': 'float'}, 'default': 1.0}, 'kw_only': False, 'init': True, 'metadata': {'pydantic_js_updates': {'description': 'Only tokens with cumulative probabilities summing up to this value are kept.'}}}, {'type': 'dataclass-field', 'name': 'prefix', 'schema': {'type': 'default', 'schema': {'type': 'str'}, 'default': ''}, 'kw_only': False, 'init': True, 'metadata': {'pydantic_js_updates': {'description': 'Text defining context provided prior to the prompt.'}}}, {'type': 'dataclass-field', 'name': 'number_of_sequences', 'schema': {'type': 'default', 'schema': {'type': 'int'}, 'default': 8}, 'kw_only': False, 'init': True, 'metadata': {'pydantic_js_updates': {'description': 'Number of text sequences to generate.'}}}], '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='transfo-xl-wt103', init=True, kw_only=False), 'do_sample': FieldInfo(annotation=bool, required=False, default=True, description='Whether or not to use sampling; use greedy decoding otherwise.', init=True, kw_only=False), 'k': FieldInfo(annotation=int, required=False, default=50, description='Number of top-k probability tokens to keep.', init=True, kw_only=False), 'length': FieldInfo(annotation=int, required=False, default=20, description='Length of the generated text.', init=True, kw_only=False), 'model_type': FieldInfo(annotation=str, required=False, default='transfo-xl', init=True, kw_only=False), 'num_beams': FieldInfo(annotation=int, required=False, default=1, description='Number of beams for beam search.', init=True, kw_only=False), 'number_of_sequences': FieldInfo(annotation=int, required=False, default=8, description='Number of text sequences to generate.', init=True, kw_only=False), 'p': FieldInfo(annotation=float, required=False, default=1.0, description='Only tokens with cumulative probabilities summing up to this value are kept.', init=True, kw_only=False), 'prefix': FieldInfo(annotation=str, required=False, default='', description='Text defining context provided prior to the prompt.', init=True, kw_only=False), 'prompt': FieldInfo(annotation=str, required=False, default="I'm a stochastic parrot.", description='Prompt for text generation.', init=True, kw_only=False), 'repetition_penalty': FieldInfo(annotation=float, required=False, default=1.0, description='Primarily useful for CTRL model, where 1.2 should be used.', init=True, kw_only=False), 'stop_token': FieldInfo(annotation=str, required=False, default='', description='Stop token for text generation.', init=True, kw_only=False), 'temperature': FieldInfo(annotation=float, required=False, default=1.0, description='Temperature for sampling, the lower the greedier the sampling.', init=True, kw_only=False)}¶

classmethod __pydantic_fields_complete__()¶

Return whether the fields were successfully collected (i.e. type hints were successfully resolved).

This is a private helper, not meant to be used outside Pydantic.

Return type: bool

__pydantic_serializer__ = SchemaSerializer(serializer=PolymorphismTrampoline( PolymorphismTrampoline { class: Py( 0x0000563c9cbd5550, ), serializer: PolymorphismTrampoline( PolymorphismTrampoline { class: Py( 0x0000563c9cbd5550, ), serializer: Dataclass( DataclassSerializer { class: Py( 0x0000563c9cbd5550, ), serializer: Fields( GeneralFieldsSerializer { fields: { "repetition_penalty": SerField { key: "repetition_penalty", alias: None, serializer: Some( WithDefault( WithDefaultSerializer { default: Default( Py( 0x00007f214cdf2910, ), ), serializer: Float( FloatSerializer { inf_nan_mode: Null, }, ), }, ), ), required: true, serialize_by_alias: None, serialization_exclude_if: None, }, "prompt": SerField { key: "prompt", alias: None, serializer: Some( WithDefault( WithDefaultSerializer { default: Default( Py( 0x00007f214712b2d0, ), ), serializer: Str( StrSerializer, ), }, ), ), required: true, serialize_by_alias: None, serialization_exclude_if: None, }, "p": SerField { key: "p", alias: None, serializer: Some( WithDefault( WithDefaultSerializer { default: Default( Py( 0x00007f214cdf2910, ), ), serializer: Float( FloatSerializer { inf_nan_mode: Null, }, ), }, ), ), required: true, serialize_by_alias: None, serialization_exclude_if: None, }, "prefix": SerField { key: "prefix", alias: None, serializer: Some( WithDefault( WithDefaultSerializer { default: Default( Py( 0x00007f222f308030, ), ), serializer: Str( StrSerializer, ), }, ), ), required: true, serialize_by_alias: None, serialization_exclude_if: None, }, "length": SerField { key: "length", alias: None, serializer: Some( WithDefault( WithDefaultSerializer { default: Default( Py( 0x00007f222f300350, ), ), serializer: Int( IntSerializer, ), }, ), ), required: true, serialize_by_alias: None, serialization_exclude_if: None, }, "temperature": SerField { key: "temperature", alias: None, serializer: Some( WithDefault( WithDefaultSerializer { default: Default( Py( 0x00007f214cdf2910, ), ), serializer: Float( FloatSerializer { inf_nan_mode: Null, }, ), }, ), ), required: true, serialize_by_alias: None, serialization_exclude_if: None, }, "number_of_sequences": SerField { key: "number_of_sequences", alias: None, serializer: Some( WithDefault( WithDefaultSerializer { default: Default( Py( 0x00007f222f3001d0, ), ), serializer: Int( IntSerializer, ), }, ), ), required: true, serialize_by_alias: None, serialization_exclude_if: None, }, "stop_token": SerField { key: "stop_token", alias: None, serializer: Some( WithDefault( WithDefaultSerializer { default: Default( Py( 0x00007f222f308030, ), ), serializer: Str( StrSerializer, ), }, ), ), required: true, serialize_by_alias: None, serialization_exclude_if: None, }, "do_sample": SerField { key: "do_sample", alias: None, serializer: Some( WithDefault( WithDefaultSerializer { default: Default( Py( 0x0000563c55c1c6e0, ), ), serializer: Bool( BoolSerializer, ), }, ), ), required: true, serialize_by_alias: None, serialization_exclude_if: None, }, "model_type": SerField { key: "model_type", alias: None, serializer: Some( WithDefault( WithDefaultSerializer { default: Default( Py( 0x00007f214c6a7b70, ), ), serializer: Str( StrSerializer, ), }, ), ), required: true, serialize_by_alias: None, serialization_exclude_if: None, }, "k": SerField { key: "k", alias: None, serializer: Some( WithDefault( WithDefaultSerializer { default: Default( Py( 0x00007f222f300710, ), ), serializer: Int( IntSerializer, ), }, ), ), required: true, serialize_by_alias: None, serialization_exclude_if: None, }, "num_beams": SerField { key: "num_beams", alias: None, serializer: Some( WithDefault( WithDefaultSerializer { default: Default( Py( 0x00007f222f3000f0, ), ), serializer: Int( IntSerializer, ), }, ), ), required: true, serialize_by_alias: None, serialization_exclude_if: None, }, "algorithm_version": SerField { key: "algorithm_version", alias: None, serializer: Some( WithDefault( WithDefaultSerializer { default: Default( Py( 0x00007f214712b690, ), ), serializer: Str( StrSerializer, ), }, ), ), required: true, serialize_by_alias: None, serialization_exclude_if: None, }, }, computed_fields: Some( ComputedFields( [], ), ), mode: SimpleDict, extra_serializer: None, filter: SchemaFilter { include: None, exclude: None, }, required_fields: 13, }, ), fields: [ Py( 0x00007f222affaf10, ), Py( 0x00007f222ba93fb0, ), Py( 0x00007f222ef49930, ), Py( 0x00007f222ec451b0, ), Py( 0x00007f221b70d830, ), Py( 0x00007f2166ad85f0, ), Py( 0x00007f2166ab6730, ), Py( 0x00007f21b65bb8b0, ), Py( 0x00007f2166ab2c90, ), Py( 0x00007f222ef253f0, ), Py( 0x00007f222f3c85b0, ), Py( 0x00007f222f3b75b0, ), Py( 0x00007f214712b4b0, ), ], name: "HuggingFaceTransfoXLGenerator", }, ), enabled_from_config: false, }, ), enabled_from_config: false, }, ), definitions=[])¶

__pydantic_validator__ = SchemaValidator(title="HuggingFaceTransfoXLGenerator", validator=Dataclass( DataclassValidator { strict: false, validator: DataclassArgs( DataclassArgsValidator { fields: [ Field { kw_only: false, name: "algorithm_version", init: true, init_only: false, lookup_path_collection: LookupPathCollection { by_name: LookupPath { first_item: PathItemString( "algorithm_version", ), rest: [], }, by_alias: [], }, validator: WithDefault( WithDefaultValidator { default: Default( Py( 0x00007f214712b690, ), ), on_error: Raise, validator: Str( StrValidator { strict: false, coerce_numbers_to_str: false, }, ), validate_default: false, copy_default: false, name: "default[str]", undefined: Py( 0x00007f222cf13af0, ), }, ), frozen: false, }, Field { kw_only: false, name: "model_type", init: true, init_only: false, lookup_path_collection: LookupPathCollection { by_name: LookupPath { first_item: PathItemString( "model_type", ), rest: [], }, by_alias: [], }, validator: WithDefault( WithDefaultValidator { default: Default( Py( 0x00007f214c6a7b70, ), ), on_error: Raise, validator: Str( StrValidator { strict: false, coerce_numbers_to_str: false, }, ), validate_default: false, copy_default: false, name: "default[str]", undefined: Py( 0x00007f222cf13af0, ), }, ), frozen: false, }, Field { kw_only: false, name: "prompt", init: true, init_only: false, lookup_path_collection: LookupPathCollection { by_name: LookupPath { first_item: PathItemString( "prompt", ), rest: [], }, by_alias: [], }, validator: WithDefault( WithDefaultValidator { default: Default( Py( 0x00007f214712b2d0, ), ), on_error: Raise, validator: Str( StrValidator { strict: false, coerce_numbers_to_str: false, }, ), validate_default: false, copy_default: false, name: "default[str]", undefined: Py( 0x00007f222cf13af0, ), }, ), frozen: false, }, Field { kw_only: false, name: "length", init: true, init_only: false, lookup_path_collection: LookupPathCollection { by_name: LookupPath { first_item: PathItemString( "length", ), rest: [], }, by_alias: [], }, validator: WithDefault( WithDefaultValidator { default: Default( Py( 0x00007f222f300350, ), ), on_error: Raise, validator: Int( IntValidator { strict: false, }, ), validate_default: false, copy_default: false, name: "default[int]", undefined: Py( 0x00007f222cf13af0, ), }, ), frozen: false, }, Field { kw_only: false, name: "stop_token", init: true, init_only: false, lookup_path_collection: LookupPathCollection { by_name: LookupPath { first_item: PathItemString( "stop_token", ), rest: [], }, by_alias: [], }, validator: WithDefault( WithDefaultValidator { default: Default( Py( 0x00007f222f308030, ), ), on_error: Raise, validator: Str( StrValidator { strict: false, coerce_numbers_to_str: false, }, ), validate_default: false, copy_default: false, name: "default[str]", undefined: Py( 0x00007f222cf13af0, ), }, ), frozen: false, }, Field { kw_only: false, name: "num_beams", init: true, init_only: false, lookup_path_collection: LookupPathCollection { by_name: LookupPath { first_item: PathItemString( "num_beams", ), rest: [], }, by_alias: [], }, validator: WithDefault( WithDefaultValidator { default: Default( Py( 0x00007f222f3000f0, ), ), on_error: Raise, validator: Int( IntValidator { strict: false, }, ), validate_default: false, copy_default: false, name: "default[int]", undefined: Py( 0x00007f222cf13af0, ), }, ), frozen: false, }, Field { kw_only: false, name: "do_sample", init: true, init_only: false, lookup_path_collection: LookupPathCollection { by_name: LookupPath { first_item: PathItemString( "do_sample", ), rest: [], }, by_alias: [], }, validator: WithDefault( WithDefaultValidator { default: Default( Py( 0x0000563c55c1c6e0, ), ), on_error: Raise, validator: Bool( BoolValidator { strict: false, }, ), validate_default: false, copy_default: false, name: "default[bool]", undefined: Py( 0x00007f222cf13af0, ), }, ), frozen: false, }, Field { kw_only: false, name: "temperature", init: true, init_only: false, lookup_path_collection: LookupPathCollection { by_name: LookupPath { first_item: PathItemString( "temperature", ), rest: [], }, by_alias: [], }, validator: WithDefault( WithDefaultValidator { default: Default( Py( 0x00007f214cdf2910, ), ), on_error: Raise, validator: Float( FloatValidator { strict: false, allow_inf_nan: true, }, ), validate_default: false, copy_default: false, name: "default[float]", undefined: Py( 0x00007f222cf13af0, ), }, ), frozen: false, }, Field { kw_only: false, name: "repetition_penalty", init: true, init_only: false, lookup_path_collection: LookupPathCollection { by_name: LookupPath { first_item: PathItemString( "repetition_penalty", ), rest: [], }, by_alias: [], }, validator: WithDefault( WithDefaultValidator { default: Default( Py( 0x00007f214cdf2910, ), ), on_error: Raise, validator: Float( FloatValidator { strict: false, allow_inf_nan: true, }, ), validate_default: false, copy_default: false, name: "default[float]", undefined: Py( 0x00007f222cf13af0, ), }, ), frozen: false, }, Field { kw_only: false, name: "k", init: true, init_only: false, lookup_path_collection: LookupPathCollection { by_name: LookupPath { first_item: PathItemString( "k", ), rest: [], }, by_alias: [], }, validator: WithDefault( WithDefaultValidator { default: Default( Py( 0x00007f222f300710, ), ), on_error: Raise, validator: Int( IntValidator { strict: false, }, ), validate_default: false, copy_default: false, name: "default[int]", undefined: Py( 0x00007f222cf13af0, ), }, ), frozen: false, }, Field { kw_only: false, name: "p", init: true, init_only: false, lookup_path_collection: LookupPathCollection { by_name: LookupPath { first_item: PathItemString( "p", ), rest: [], }, by_alias: [], }, validator: WithDefault( WithDefaultValidator { default: Default( Py( 0x00007f214cdf2910, ), ), on_error: Raise, validator: Float( FloatValidator { strict: false, allow_inf_nan: true, }, ), validate_default: false, copy_default: false, name: "default[float]", undefined: Py( 0x00007f222cf13af0, ), }, ), frozen: false, }, Field { kw_only: false, name: "prefix", init: true, init_only: false, lookup_path_collection: LookupPathCollection { by_name: LookupPath { first_item: PathItemString( "prefix", ), rest: [], }, by_alias: [], }, validator: WithDefault( WithDefaultValidator { default: Default( Py( 0x00007f222f308030, ), ), on_error: Raise, validator: Str( StrValidator { strict: false, coerce_numbers_to_str: false, }, ), validate_default: false, copy_default: false, name: "default[str]", undefined: Py( 0x00007f222cf13af0, ), }, ), frozen: false, }, Field { kw_only: false, name: "number_of_sequences", init: true, init_only: false, lookup_path_collection: LookupPathCollection { by_name: LookupPath { first_item: PathItemString( "number_of_sequences", ), rest: [], }, by_alias: [], }, validator: WithDefault( WithDefaultValidator { default: Default( Py( 0x00007f222f3001d0, ), ), on_error: Raise, validator: Int( IntValidator { strict: false, }, ), validate_default: false, copy_default: false, name: "default[int]", undefined: Py( 0x00007f222cf13af0, ), }, ), frozen: false, }, ], positional_count: 13, init_only_count: None, dataclass_name: "HuggingFaceTransfoXLGenerator", validator_name: "dataclass-args[HuggingFaceTransfoXLGenerator]", extra_behavior: Ignore, extras_validator: None, loc_by_alias: true, validate_by_alias: None, validate_by_name: None, }, ), class: Py( 0x0000563c9cbd5550, ), generic_origin: None, fields: [ Py( 0x00007f222affaf10, ), Py( 0x00007f222ba93fb0, ), Py( 0x00007f222ef49930, ), Py( 0x00007f222ec451b0, ), Py( 0x00007f221b70d830, ), Py( 0x00007f2166ad85f0, ), Py( 0x00007f2166ab6730, ), Py( 0x00007f21b65bb8b0, ), Py( 0x00007f2166ab2c90, ), Py( 0x00007f222ef253f0, ), Py( 0x00007f222f3c85b0, ), Py( 0x00007f222f3b75b0, ), Py( 0x00007f214712b4b0, ), ], post_init: None, revalidate: Never, name: "HuggingFaceTransfoXLGenerator", frozen: false, slots: true, }, ), definitions=[], cache_strings=True)¶

__repr__()¶: Return repr(self).

__signature__ = <Signature (*args: Any, algorithm_version: str = 'transfo-xl-wt103', model_type: str = 'transfo-xl', prompt: str = "I'm a stochastic parrot.", length: int = 20, stop_token: str = '', num_beams: int = 1, do_sample: bool = True, temperature: float = 1.0, repetition_penalty: float = 1.0, k: int = 50, p: float = 1.0, prefix: str = '', number_of_sequences: int = 8) -> None>¶

__wrapped__¶: alias of HuggingFaceTransfoXLGenerator

algorithm_application: ClassVar[str] = 'HuggingFaceTransfoXLGenerator'¶

Unique name for the application that is the use of this configuration together with a specific algorithm.

Will be set when registering to ApplicationsRegistry, but can be given by direct registration (See register_algorithm_application)

algorithm_name: ClassVar[str] = 'HuggingFaceGenerationAlgorithm'¶

Name of the algorithm to use with this configuration.

Will be set when registering to ApplicationsRegistry

class HuggingFaceSeq2SeqGenerator(*args, **kwargs)[source]¶

Bases: HuggingFaceSeq2SeqGenerator

Configuration to generate text using Seq2Seq LMs.

algorithm_version: str = 't5-small'¶

To differentiate between different versions of an application.

There is no imposed naming convention.

model_type: str = 'auto-seq2seq-lm'¶

classmethod list_versions()[source]¶

Get possible algorithm versions.

Standard S3 and cache search adding the version used in the configuration.

Return type: Set[str]
Returns: viable values as algorithm_version for the environment.

__annotations__ = {'algorithm_application': 'ClassVar[str]', 'algorithm_name': 'ClassVar[str]', 'algorithm_type': 'ClassVar[str]', 'algorithm_version': <class 'str'>, 'do_sample': 'bool', 'domain': 'ClassVar[str]', 'k': 'int', 'length': 'int', 'model_type': <class 'str'>, 'num_beams': 'int', 'number_of_sequences': 'int', 'p': 'float', 'prefix': 'str', 'prompt': 'str', 'repetition_penalty': 'float', 'stop_token': 'str', 'temperature': 'float'}¶

__dataclass_fields__ = {'algorithm_application': Field(name='algorithm_application',type=typing.ClassVar[str],default='HuggingFaceSeq2SeqGenerator',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='HuggingFaceGenerationAlgorithm',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='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='t5-small',default_factory=<dataclasses._MISSING_TYPE object>,init=True,repr=True,hash=None,compare=True,metadata=mappingproxy({}),kw_only=False,_field_type=_FIELD), 'do_sample': Field(name='do_sample',type=<class 'bool'>,default=True,default_factory=<dataclasses._MISSING_TYPE object>,init=True,repr=True,hash=None,compare=True,metadata=mappingproxy({'description': 'Whether or not to use sampling; use greedy decoding otherwise.'}),kw_only=False,_field_type=_FIELD), 'domain': Field(name='domain',type=typing.ClassVar[str],default='nlp',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), 'k': Field(name='k',type=<class 'int'>,default=50,default_factory=<dataclasses._MISSING_TYPE object>,init=True,repr=True,hash=None,compare=True,metadata=mappingproxy({'description': 'Number of top-k probability tokens to keep.'}),kw_only=False,_field_type=_FIELD), 'length': Field(name='length',type=<class 'int'>,default=20,default_factory=<dataclasses._MISSING_TYPE object>,init=True,repr=True,hash=None,compare=True,metadata=mappingproxy({'description': 'Length of the generated text.'}),kw_only=False,_field_type=_FIELD), 'model_type': Field(name='model_type',type=<class 'str'>,default='auto-seq2seq-lm',default_factory=<dataclasses._MISSING_TYPE object>,init=True,repr=True,hash=None,compare=True,metadata=mappingproxy({}),kw_only=False,_field_type=_FIELD), 'num_beams': Field(name='num_beams',type=<class 'int'>,default=1,default_factory=<dataclasses._MISSING_TYPE object>,init=True,repr=True,hash=None,compare=True,metadata=mappingproxy({'description': 'Number of beams for beam search.'}),kw_only=False,_field_type=_FIELD), 'number_of_sequences': Field(name='number_of_sequences',type=<class 'int'>,default=8,default_factory=<dataclasses._MISSING_TYPE object>,init=True,repr=True,hash=None,compare=True,metadata=mappingproxy({'description': 'Number of text sequences to generate.'}),kw_only=False,_field_type=_FIELD), 'p': Field(name='p',type=<class 'float'>,default=1.0,default_factory=<dataclasses._MISSING_TYPE object>,init=True,repr=True,hash=None,compare=True,metadata=mappingproxy({'description': 'Only tokens with cumulative probabilities summing up to this value are kept.'}),kw_only=False,_field_type=_FIELD), 'prefix': Field(name='prefix',type=<class 'str'>,default='',default_factory=<dataclasses._MISSING_TYPE object>,init=True,repr=True,hash=None,compare=True,metadata=mappingproxy({'description': 'Text defining context provided prior to the prompt.'}),kw_only=False,_field_type=_FIELD), 'prompt': Field(name='prompt',type=<class 'str'>,default="I'm a stochastic parrot.",default_factory=<dataclasses._MISSING_TYPE object>,init=True,repr=True,hash=None,compare=True,metadata=mappingproxy({'description': 'Prompt for text generation.'}),kw_only=False,_field_type=_FIELD), 'repetition_penalty': Field(name='repetition_penalty',type=<class 'float'>,default=1.0,default_factory=<dataclasses._MISSING_TYPE object>,init=True,repr=True,hash=None,compare=True,metadata=mappingproxy({'description': 'Primarily useful for CTRL model, where 1.2 should be used.'}),kw_only=False,_field_type=_FIELD), 'stop_token': Field(name='stop_token',type=<class 'str'>,default='',default_factory=<dataclasses._MISSING_TYPE object>,init=True,repr=True,hash=None,compare=True,metadata=mappingproxy({'description': 'Stop token for text generation.'}),kw_only=False,_field_type=_FIELD), 'temperature': Field(name='temperature',type=<class 'float'>,default=1.0,default_factory=<dataclasses._MISSING_TYPE object>,init=True,repr=True,hash=None,compare=True,metadata=mappingproxy({'description': 'Temperature for sampling, the lower the greedier the sampling.'}),kw_only=False,_field_type=_FIELD)}¶

__dataclass_params__ = _DataclassParams(init=True,repr=True,eq=True,order=False,unsafe_hash=False,frozen=False)¶

__doc__ = 'Configuration to generate text using Seq2Seq LMs.'¶

__eq__(other)¶: Return self==value.

__hash__ = None¶

__init__(*args, **kwargs)¶

__is_pydantic_dataclass__ = True¶

__match_args__ = ('algorithm_version', 'model_type', 'prompt', 'length', 'stop_token', 'num_beams', 'do_sample', 'temperature', 'repetition_penalty', 'k', 'p', 'prefix', 'number_of_sequences')¶

__module__ = 'gt4sd.algorithms.generation.hugging_face.core'¶

__parameters__ = (~T,)¶

__pydantic_complete__ = True¶

__pydantic_config__ = {}¶

__pydantic_core_schema__ = {'cls': <class 'gt4sd.algorithms.generation.hugging_face.core.HuggingFaceSeq2SeqGenerator'>, 'config': {'title': 'HuggingFaceSeq2SeqGenerator'}, 'fields': ['algorithm_version', 'model_type', 'prompt', 'length', 'stop_token', 'num_beams', 'do_sample', 'temperature', 'repetition_penalty', 'k', 'p', 'prefix', 'number_of_sequences'], 'frozen': False, 'post_init': False, 'ref': 'types.HuggingFaceSeq2SeqGenerator:94818327646544', 'schema': {'collect_init_only': False, 'computed_fields': [], 'dataclass_name': 'HuggingFaceSeq2SeqGenerator', 'fields': [{'type': 'dataclass-field', 'name': 'algorithm_version', 'schema': {'type': 'default', 'schema': {'type': 'str'}, 'default': 't5-small'}, 'kw_only': False, 'init': True, 'metadata': {}}, {'type': 'dataclass-field', 'name': 'model_type', 'schema': {'type': 'default', 'schema': {'type': 'str'}, 'default': 'auto-seq2seq-lm'}, 'kw_only': False, 'init': True, 'metadata': {}}, {'type': 'dataclass-field', 'name': 'prompt', 'schema': {'type': 'default', 'schema': {'type': 'str'}, 'default': "I'm a stochastic parrot."}, 'kw_only': False, 'init': True, 'metadata': {'pydantic_js_updates': {'description': 'Prompt for text generation.'}}}, {'type': 'dataclass-field', 'name': 'length', 'schema': {'type': 'default', 'schema': {'type': 'int'}, 'default': 20}, 'kw_only': False, 'init': True, 'metadata': {'pydantic_js_updates': {'description': 'Length of the generated text.'}}}, {'type': 'dataclass-field', 'name': 'stop_token', 'schema': {'type': 'default', 'schema': {'type': 'str'}, 'default': ''}, 'kw_only': False, 'init': True, 'metadata': {'pydantic_js_updates': {'description': 'Stop token for text generation.'}}}, {'type': 'dataclass-field', 'name': 'num_beams', 'schema': {'type': 'default', 'schema': {'type': 'int'}, 'default': 1}, 'kw_only': False, 'init': True, 'metadata': {'pydantic_js_updates': {'description': 'Number of beams for beam search.'}}}, {'type': 'dataclass-field', 'name': 'do_sample', 'schema': {'type': 'default', 'schema': {'type': 'bool'}, 'default': True}, 'kw_only': False, 'init': True, 'metadata': {'pydantic_js_updates': {'description': 'Whether or not to use sampling; use greedy decoding otherwise.'}}}, {'type': 'dataclass-field', 'name': 'temperature', 'schema': {'type': 'default', 'schema': {'type': 'float'}, 'default': 1.0}, 'kw_only': False, 'init': True, 'metadata': {'pydantic_js_updates': {'description': 'Temperature for sampling, the lower the greedier the sampling.'}}}, {'type': 'dataclass-field', 'name': 'repetition_penalty', 'schema': {'type': 'default', 'schema': {'type': 'float'}, 'default': 1.0}, 'kw_only': False, 'init': True, 'metadata': {'pydantic_js_updates': {'description': 'Primarily useful for CTRL model, where 1.2 should be used.'}}}, {'type': 'dataclass-field', 'name': 'k', 'schema': {'type': 'default', 'schema': {'type': 'int'}, 'default': 50}, 'kw_only': False, 'init': True, 'metadata': {'pydantic_js_updates': {'description': 'Number of top-k probability tokens to keep.'}}}, {'type': 'dataclass-field', 'name': 'p', 'schema': {'type': 'default', 'schema': {'type': 'float'}, 'default': 1.0}, 'kw_only': False, 'init': True, 'metadata': {'pydantic_js_updates': {'description': 'Only tokens with cumulative probabilities summing up to this value are kept.'}}}, {'type': 'dataclass-field', 'name': 'prefix', 'schema': {'type': 'default', 'schema': {'type': 'str'}, 'default': ''}, 'kw_only': False, 'init': True, 'metadata': {'pydantic_js_updates': {'description': 'Text defining context provided prior to the prompt.'}}}, {'type': 'dataclass-field', 'name': 'number_of_sequences', 'schema': {'type': 'default', 'schema': {'type': 'int'}, 'default': 8}, 'kw_only': False, 'init': True, 'metadata': {'pydantic_js_updates': {'description': 'Number of text sequences to generate.'}}}], '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='t5-small', init=True, kw_only=False), 'do_sample': FieldInfo(annotation=bool, required=False, default=True, description='Whether or not to use sampling; use greedy decoding otherwise.', init=True, kw_only=False), 'k': FieldInfo(annotation=int, required=False, default=50, description='Number of top-k probability tokens to keep.', init=True, kw_only=False), 'length': FieldInfo(annotation=int, required=False, default=20, description='Length of the generated text.', init=True, kw_only=False), 'model_type': FieldInfo(annotation=str, required=False, default='auto-seq2seq-lm', init=True, kw_only=False), 'num_beams': FieldInfo(annotation=int, required=False, default=1, description='Number of beams for beam search.', init=True, kw_only=False), 'number_of_sequences': FieldInfo(annotation=int, required=False, default=8, description='Number of text sequences to generate.', init=True, kw_only=False), 'p': FieldInfo(annotation=float, required=False, default=1.0, description='Only tokens with cumulative probabilities summing up to this value are kept.', init=True, kw_only=False), 'prefix': FieldInfo(annotation=str, required=False, default='', description='Text defining context provided prior to the prompt.', init=True, kw_only=False), 'prompt': FieldInfo(annotation=str, required=False, default="I'm a stochastic parrot.", description='Prompt for text generation.', init=True, kw_only=False), 'repetition_penalty': FieldInfo(annotation=float, required=False, default=1.0, description='Primarily useful for CTRL model, where 1.2 should be used.', init=True, kw_only=False), 'stop_token': FieldInfo(annotation=str, required=False, default='', description='Stop token for text generation.', init=True, kw_only=False), 'temperature': FieldInfo(annotation=float, required=False, default=1.0, description='Temperature for sampling, the lower the greedier the sampling.', init=True, kw_only=False)}¶

classmethod __pydantic_fields_complete__()¶

Return whether the fields were successfully collected (i.e. type hints were successfully resolved).

This is a private helper, not meant to be used outside Pydantic.

Return type: bool

__pydantic_serializer__ = SchemaSerializer(serializer=PolymorphismTrampoline( PolymorphismTrampoline { class: Py( 0x0000563c9cbcd150, ), serializer: PolymorphismTrampoline( PolymorphismTrampoline { class: Py( 0x0000563c9cbcd150, ), serializer: Dataclass( DataclassSerializer { class: Py( 0x0000563c9cbcd150, ), serializer: Fields( GeneralFieldsSerializer { fields: { "stop_token": SerField { key: "stop_token", alias: None, serializer: Some( WithDefault( WithDefaultSerializer { default: Default( Py( 0x00007f222f308030, ), ), serializer: Str( StrSerializer, ), }, ), ), required: true, serialize_by_alias: None, serialization_exclude_if: None, }, "do_sample": SerField { key: "do_sample", alias: None, serializer: Some( WithDefault( WithDefaultSerializer { default: Default( Py( 0x0000563c55c1c6e0, ), ), serializer: Bool( BoolSerializer, ), }, ), ), required: true, serialize_by_alias: None, serialization_exclude_if: None, }, "prompt": SerField { key: "prompt", alias: None, serializer: Some( WithDefault( WithDefaultSerializer { default: Default( Py( 0x00007f214712b2d0, ), ), serializer: Str( StrSerializer, ), }, ), ), required: true, serialize_by_alias: None, serialization_exclude_if: None, }, "num_beams": SerField { key: "num_beams", alias: None, serializer: Some( WithDefault( WithDefaultSerializer { default: Default( Py( 0x00007f222f3000f0, ), ), serializer: Int( IntSerializer, ), }, ), ), required: true, serialize_by_alias: None, serialization_exclude_if: None, }, "repetition_penalty": SerField { key: "repetition_penalty", alias: None, serializer: Some( WithDefault( WithDefaultSerializer { default: Default( Py( 0x00007f214cdf2910, ), ), serializer: Float( FloatSerializer { inf_nan_mode: Null, }, ), }, ), ), required: true, serialize_by_alias: None, serialization_exclude_if: None, }, "model_type": SerField { key: "model_type", alias: None, serializer: Some( WithDefault( WithDefaultSerializer { default: Default( Py( 0x00007f21471331b0, ), ), serializer: Str( StrSerializer, ), }, ), ), required: true, serialize_by_alias: None, serialization_exclude_if: None, }, "k": SerField { key: "k", alias: None, serializer: Some( WithDefault( WithDefaultSerializer { default: Default( Py( 0x00007f222f300710, ), ), serializer: Int( IntSerializer, ), }, ), ), required: true, serialize_by_alias: None, serialization_exclude_if: None, }, "prefix": SerField { key: "prefix", alias: None, serializer: Some( WithDefault( WithDefaultSerializer { default: Default( Py( 0x00007f222f308030, ), ), serializer: Str( StrSerializer, ), }, ), ), required: true, serialize_by_alias: None, serialization_exclude_if: None, }, "length": SerField { key: "length", alias: None, serializer: Some( WithDefault( WithDefaultSerializer { default: Default( Py( 0x00007f222f300350, ), ), serializer: Int( IntSerializer, ), }, ), ), required: true, serialize_by_alias: None, serialization_exclude_if: None, }, "p": SerField { key: "p", alias: None, serializer: Some( WithDefault( WithDefaultSerializer { default: Default( Py( 0x00007f214cdf2910, ), ), serializer: Float( FloatSerializer { inf_nan_mode: Null, }, ), }, ), ), required: true, serialize_by_alias: None, serialization_exclude_if: None, }, "number_of_sequences": SerField { key: "number_of_sequences", alias: None, serializer: Some( WithDefault( WithDefaultSerializer { default: Default( Py( 0x00007f222f3001d0, ), ), serializer: Int( IntSerializer, ), }, ), ), required: true, serialize_by_alias: None, serialization_exclude_if: None, }, "temperature": SerField { key: "temperature", alias: None, serializer: Some( WithDefault( WithDefaultSerializer { default: Default( Py( 0x00007f214cdf2910, ), ), serializer: Float( FloatSerializer { inf_nan_mode: Null, }, ), }, ), ), required: true, serialize_by_alias: None, serialization_exclude_if: None, }, "algorithm_version": SerField { key: "algorithm_version", alias: None, serializer: Some( WithDefault( WithDefaultSerializer { default: Default( Py( 0x00007f214c6a7fb0, ), ), serializer: Str( StrSerializer, ), }, ), ), required: true, serialize_by_alias: None, serialization_exclude_if: None, }, }, computed_fields: Some( ComputedFields( [], ), ), mode: SimpleDict, extra_serializer: None, filter: SchemaFilter { include: None, exclude: None, }, required_fields: 13, }, ), fields: [ Py( 0x00007f222affaf10, ), Py( 0x00007f222ba93fb0, ), Py( 0x00007f222ef49930, ), Py( 0x00007f222ec451b0, ), Py( 0x00007f221b70d830, ), Py( 0x00007f2166ad85f0, ), Py( 0x00007f2166ab6730, ), Py( 0x00007f21b65bb8b0, ), Py( 0x00007f2166ab2c90, ), Py( 0x00007f222ef253f0, ), Py( 0x00007f222f3c85b0, ), Py( 0x00007f222f3b75b0, ), Py( 0x00007f214712b4b0, ), ], name: "HuggingFaceSeq2SeqGenerator", }, ), enabled_from_config: false, }, ), enabled_from_config: false, }, ), definitions=[])¶

__pydantic_validator__ = SchemaValidator(title="HuggingFaceSeq2SeqGenerator", validator=Dataclass( DataclassValidator { strict: false, validator: DataclassArgs( DataclassArgsValidator { fields: [ Field { kw_only: false, name: "algorithm_version", init: true, init_only: false, lookup_path_collection: LookupPathCollection { by_name: LookupPath { first_item: PathItemString( "algorithm_version", ), rest: [], }, by_alias: [], }, validator: WithDefault( WithDefaultValidator { default: Default( Py( 0x00007f214c6a7fb0, ), ), on_error: Raise, validator: Str( StrValidator { strict: false, coerce_numbers_to_str: false, }, ), validate_default: false, copy_default: false, name: "default[str]", undefined: Py( 0x00007f222cf13af0, ), }, ), frozen: false, }, Field { kw_only: false, name: "model_type", init: true, init_only: false, lookup_path_collection: LookupPathCollection { by_name: LookupPath { first_item: PathItemString( "model_type", ), rest: [], }, by_alias: [], }, validator: WithDefault( WithDefaultValidator { default: Default( Py( 0x00007f21471331b0, ), ), on_error: Raise, validator: Str( StrValidator { strict: false, coerce_numbers_to_str: false, }, ), validate_default: false, copy_default: false, name: "default[str]", undefined: Py( 0x00007f222cf13af0, ), }, ), frozen: false, }, Field { kw_only: false, name: "prompt", init: true, init_only: false, lookup_path_collection: LookupPathCollection { by_name: LookupPath { first_item: PathItemString( "prompt", ), rest: [], }, by_alias: [], }, validator: WithDefault( WithDefaultValidator { default: Default( Py( 0x00007f214712b2d0, ), ), on_error: Raise, validator: Str( StrValidator { strict: false, coerce_numbers_to_str: false, }, ), validate_default: false, copy_default: false, name: "default[str]", undefined: Py( 0x00007f222cf13af0, ), }, ), frozen: false, }, Field { kw_only: false, name: "length", init: true, init_only: false, lookup_path_collection: LookupPathCollection { by_name: LookupPath { first_item: PathItemString( "length", ), rest: [], }, by_alias: [], }, validator: WithDefault( WithDefaultValidator { default: Default( Py( 0x00007f222f300350, ), ), on_error: Raise, validator: Int( IntValidator { strict: false, }, ), validate_default: false, copy_default: false, name: "default[int]", undefined: Py( 0x00007f222cf13af0, ), }, ), frozen: false, }, Field { kw_only: false, name: "stop_token", init: true, init_only: false, lookup_path_collection: LookupPathCollection { by_name: LookupPath { first_item: PathItemString( "stop_token", ), rest: [], }, by_alias: [], }, validator: WithDefault( WithDefaultValidator { default: Default( Py( 0x00007f222f308030, ), ), on_error: Raise, validator: Str( StrValidator { strict: false, coerce_numbers_to_str: false, }, ), validate_default: false, copy_default: false, name: "default[str]", undefined: Py( 0x00007f222cf13af0, ), }, ), frozen: false, }, Field { kw_only: false, name: "num_beams", init: true, init_only: false, lookup_path_collection: LookupPathCollection { by_name: LookupPath { first_item: PathItemString( "num_beams", ), rest: [], }, by_alias: [], }, validator: WithDefault( WithDefaultValidator { default: Default( Py( 0x00007f222f3000f0, ), ), on_error: Raise, validator: Int( IntValidator { strict: false, }, ), validate_default: false, copy_default: false, name: "default[int]", undefined: Py( 0x00007f222cf13af0, ), }, ), frozen: false, }, Field { kw_only: false, name: "do_sample", init: true, init_only: false, lookup_path_collection: LookupPathCollection { by_name: LookupPath { first_item: PathItemString( "do_sample", ), rest: [], }, by_alias: [], }, validator: WithDefault( WithDefaultValidator { default: Default( Py( 0x0000563c55c1c6e0, ), ), on_error: Raise, validator: Bool( BoolValidator { strict: false, }, ), validate_default: false, copy_default: false, name: "default[bool]", undefined: Py( 0x00007f222cf13af0, ), }, ), frozen: false, }, Field { kw_only: false, name: "temperature", init: true, init_only: false, lookup_path_collection: LookupPathCollection { by_name: LookupPath { first_item: PathItemString( "temperature", ), rest: [], }, by_alias: [], }, validator: WithDefault( WithDefaultValidator { default: Default( Py( 0x00007f214cdf2910, ), ), on_error: Raise, validator: Float( FloatValidator { strict: false, allow_inf_nan: true, }, ), validate_default: false, copy_default: false, name: "default[float]", undefined: Py( 0x00007f222cf13af0, ), }, ), frozen: false, }, Field { kw_only: false, name: "repetition_penalty", init: true, init_only: false, lookup_path_collection: LookupPathCollection { by_name: LookupPath { first_item: PathItemString( "repetition_penalty", ), rest: [], }, by_alias: [], }, validator: WithDefault( WithDefaultValidator { default: Default( Py( 0x00007f214cdf2910, ), ), on_error: Raise, validator: Float( FloatValidator { strict: false, allow_inf_nan: true, }, ), validate_default: false, copy_default: false, name: "default[float]", undefined: Py( 0x00007f222cf13af0, ), }, ), frozen: false, }, Field { kw_only: false, name: "k", init: true, init_only: false, lookup_path_collection: LookupPathCollection { by_name: LookupPath { first_item: PathItemString( "k", ), rest: [], }, by_alias: [], }, validator: WithDefault( WithDefaultValidator { default: Default( Py( 0x00007f222f300710, ), ), on_error: Raise, validator: Int( IntValidator { strict: false, }, ), validate_default: false, copy_default: false, name: "default[int]", undefined: Py( 0x00007f222cf13af0, ), }, ), frozen: false, }, Field { kw_only: false, name: "p", init: true, init_only: false, lookup_path_collection: LookupPathCollection { by_name: LookupPath { first_item: PathItemString( "p", ), rest: [], }, by_alias: [], }, validator: WithDefault( WithDefaultValidator { default: Default( Py( 0x00007f214cdf2910, ), ), on_error: Raise, validator: Float( FloatValidator { strict: false, allow_inf_nan: true, }, ), validate_default: false, copy_default: false, name: "default[float]", undefined: Py( 0x00007f222cf13af0, ), }, ), frozen: false, }, Field { kw_only: false, name: "prefix", init: true, init_only: false, lookup_path_collection: LookupPathCollection { by_name: LookupPath { first_item: PathItemString( "prefix", ), rest: [], }, by_alias: [], }, validator: WithDefault( WithDefaultValidator { default: Default( Py( 0x00007f222f308030, ), ), on_error: Raise, validator: Str( StrValidator { strict: false, coerce_numbers_to_str: false, }, ), validate_default: false, copy_default: false, name: "default[str]", undefined: Py( 0x00007f222cf13af0, ), }, ), frozen: false, }, Field { kw_only: false, name: "number_of_sequences", init: true, init_only: false, lookup_path_collection: LookupPathCollection { by_name: LookupPath { first_item: PathItemString( "number_of_sequences", ), rest: [], }, by_alias: [], }, validator: WithDefault( WithDefaultValidator { default: Default( Py( 0x00007f222f3001d0, ), ), on_error: Raise, validator: Int( IntValidator { strict: false, }, ), validate_default: false, copy_default: false, name: "default[int]", undefined: Py( 0x00007f222cf13af0, ), }, ), frozen: false, }, ], positional_count: 13, init_only_count: None, dataclass_name: "HuggingFaceSeq2SeqGenerator", validator_name: "dataclass-args[HuggingFaceSeq2SeqGenerator]", extra_behavior: Ignore, extras_validator: None, loc_by_alias: true, validate_by_alias: None, validate_by_name: None, }, ), class: Py( 0x0000563c9cbcd150, ), generic_origin: None, fields: [ Py( 0x00007f222affaf10, ), Py( 0x00007f222ba93fb0, ), Py( 0x00007f222ef49930, ), Py( 0x00007f222ec451b0, ), Py( 0x00007f221b70d830, ), Py( 0x00007f2166ad85f0, ), Py( 0x00007f2166ab6730, ), Py( 0x00007f21b65bb8b0, ), Py( 0x00007f2166ab2c90, ), Py( 0x00007f222ef253f0, ), Py( 0x00007f222f3c85b0, ), Py( 0x00007f222f3b75b0, ), Py( 0x00007f214712b4b0, ), ], post_init: None, revalidate: Never, name: "HuggingFaceSeq2SeqGenerator", frozen: false, slots: true, }, ), definitions=[], cache_strings=True)¶

__repr__()¶: Return repr(self).

__signature__ = <Signature (*args: Any, algorithm_version: str = 't5-small', model_type: str = 'auto-seq2seq-lm', prompt: str = "I'm a stochastic parrot.", length: int = 20, stop_token: str = '', num_beams: int = 1, do_sample: bool = True, temperature: float = 1.0, repetition_penalty: float = 1.0, k: int = 50, p: float = 1.0, prefix: str = '', number_of_sequences: int = 8) -> None>¶

__wrapped__¶: alias of HuggingFaceSeq2SeqGenerator

algorithm_application: ClassVar[str] = 'HuggingFaceSeq2SeqGenerator'¶

Unique name for the application that is the use of this configuration together with a specific algorithm.

Will be set when registering to ApplicationsRegistry, but can be given by direct registration (See register_algorithm_application)

algorithm_name: ClassVar[str] = 'HuggingFaceGenerationAlgorithm'¶

Name of the algorithm to use with this configuration.

Will be set when registering to ApplicationsRegistry