Skip to content

models

DLite-specific data models.

DLiteConfiguration

Bases: DLiteResult

Data model representing recurring fields necessary in strategy-specific configurations for DLite strategies.

Note, this data model already includes the collection_id field from the DLiteResult data model.

Source code in oteapi_dlite/models.py 
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
class DLiteConfiguration(DLiteResult):
    """Data model representing recurring fields necessary in strategy-specific
    configurations for DLite strategies.

    Note, this data model already includes the `collection_id` field from the
    `DLiteResult` data model.
    """

    dlite_settings: Annotated[
        dict[str, JsonValue],
        Field(
            description=(
                "Settings used by DLite strategies within a single pipeline "
                "run."
            )
        ),
    ] = {}  # noqa: RUF012

DLiteResult

Bases: AttrDict

Class for returning values from DLite strategies.

Source code in oteapi_dlite/models.py 
11
12
13
14
15
16
class DLiteResult(AttrDict):
    """Class for returning values from DLite strategies."""

    collection_id: Annotated[
        Optional[str], Field(description="A reference to a DLite collection.")
    ] = None