SweepModel#

class SweepModel(*, parameter, data, **extra_data)#

Bases: BaseModel

Pydantic sweep model.

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Module: exa.common.api.model.sweep_model

Attributes

model_config

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

parameter

data

Methods

decode

Creates instance of exa.common.control.sweep.fixed_sweep.FixedSweep out of pydantic SweepModel.

encode

Creates pydantic SweepModel out of exa.common.control.sweep.sweep.Sweep instance.

serialize_data

Parameters:
model_config: ClassVar[ConfigDict] = {'extra': 'allow'}#

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

decode()#

Creates instance of exa.common.control.sweep.fixed_sweep.FixedSweep out of pydantic SweepModel.

Return type:

FixedSweep

classmethod encode(sweep)#

Creates pydantic SweepModel out of exa.common.control.sweep.sweep.Sweep instance.

Parameters:

sweep (Sweep) –

Return type:

SweepModel