qat.core.config module

class ClassDescription(**data)

Bases: BaseModel, Generic[T]

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.

config: dict

model_config: ClassVar[ConfigDict] = {}

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

partial()

Returns a partially configured class

type: TypeVar(T)

class ClassDescription(**data)

Bases: BaseModel, Generic[T]

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.

config: dict

model_config: ClassVar[ConfigDict] = {}

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

partial()

Returns a partially configured class

type: TypeVar(T)

class HardwareLoaderDescription(**data)

Bases: BaseModel

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.

config: dict

construct()

Returns the described Hardware Loader

Return type:

BaseModelLoader

model_config: ClassVar[ConfigDict] = {}

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

name: str

type: Annotated[ImportString]

class PipelineClassDescription(**data)

Bases: BaseModel

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.

backend: Union[Annotated[ImportString], Annotated[ClassDescription[Annotated[ImportString, AfterValidator]]]]

config: dict

construct(model)

Constructs and returns a Pipeline from its description

Parameters:

model (LogicalHardwareModel | HardwareModel) – The instantiated hardware model, this is required to be the model provided by the associated hardware_loader

Return type:

Pipeline

Returns:

The constructed pipeline

default: bool

engine: Union[Annotated[ImportString], Annotated[ClassDescription[Annotated[ImportString, AfterValidator]]]]

frontend: Union[Annotated[ImportString], Annotated[ClassDescription[Annotated[ImportString, AfterValidator]]]]

hardware_loader: str | None

middleend: Union[Annotated[ImportString], Annotated[ClassDescription[Annotated[ImportString, AfterValidator]]]]

model_config: ClassVar[ConfigDict] = {'validate_default': True}

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

name: str

results_pipeline: Union[Annotated[ImportString], Annotated[ClassDescription[Annotated[ImportString, AfterValidator]]], None]

runtime: Union[Annotated[ImportString], Annotated[ClassDescription[Annotated[ImportString, AfterValidator]]]]

class PipelineFactoryDescription(**data)

Bases: BaseModel

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.

config: dict

construct(model)

Constructs and returns a Pipeline from its description

Parameters:

model (LogicalHardwareModel | HardwareModel) – The instantiated hardware model, this is required to be the model provided by the associated hardware_loader

Return type:

Pipeline

Returns:

The constructed pipeline

default: bool

engine: Union[Annotated[ImportString], Annotated[ClassDescription[Annotated[ImportString, AfterValidator]]], None]

hardware_loader: str | None

model_config: ClassVar[ConfigDict] = {}

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

name: str

pipeline: Annotated[ImportString]

class PipelineInstanceDescription(**data)

Bases: BaseModel

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.

construct()

Returns the requested Pipeline instance

Return type:

Pipeline

default: bool

model_config: ClassVar[ConfigDict] = {}

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

name: str

pipeline: Annotated[ImportString]