Skip to content

Pipeline Config

The following Pydantic schema shows the format of a pipeline configuration file. Expand the following source code blocks to view the keys at each level.

aineko.models.config_schema.Config

Pipeline configuration model.

Pipeline configurations are defined by the user in a YAML file. This model is a representation of a serialized pipeline configuration.

Source code in aineko/models/config_schema.py 
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
class Config(BaseModel):
    """Pipeline configuration model.

    Pipeline configurations are defined by the user in a YAML file. This model
    is a representation of a serialized pipeline configuration.
    """

    class Pipeline(BaseModel):
        """Pipeline model."""

        class Node(BaseModel):
            """Node model."""

            class_name: str = Field(..., alias="class")
            node_params: Optional[dict] = None
            node_settings: Optional[NodeSettings] = None
            inputs: Optional[List[str]] = None
            outputs: Optional[List[str]] = None

        name: str
        default_node_settings: Optional[NodeSettings] = None
        nodes: Dict[str, Node]
        datasets: Dict[str, DatasetConfig]

    pipeline: Pipeline

pipeline instance-attribute 

pipeline: Pipeline

Pipeline

Pipeline model.

Source code in aineko/models/config_schema.py 
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
class Pipeline(BaseModel):
    """Pipeline model."""

    class Node(BaseModel):
        """Node model."""

        class_name: str = Field(..., alias="class")
        node_params: Optional[dict] = None
        node_settings: Optional[NodeSettings] = None
        inputs: Optional[List[str]] = None
        outputs: Optional[List[str]] = None

    name: str
    default_node_settings: Optional[NodeSettings] = None
    nodes: Dict[str, Node]
    datasets: Dict[str, DatasetConfig]

datasets instance-attribute 

datasets: Dict[str, DatasetConfig]

default_node_settings class-attribute instance-attribute 

default_node_settings: Optional[NodeSettings] = None

name instance-attribute 

name: str

nodes instance-attribute 

nodes: Dict[str, Node]

Node

Node model.

Source code in aineko/models/config_schema.py 
40
41
42
43
44
45
46
47
class Node(BaseModel):
    """Node model."""

    class_name: str = Field(..., alias="class")
    node_params: Optional[dict] = None
    node_settings: Optional[NodeSettings] = None
    inputs: Optional[List[str]] = None
    outputs: Optional[List[str]] = None
class_name class-attribute instance-attribute 
class_name: str = Field(..., alias='class')
inputs class-attribute instance-attribute 
inputs: Optional[List[str]] = None
node_params class-attribute instance-attribute 
node_params: Optional[dict] = None
node_settings class-attribute instance-attribute 
node_settings: Optional[NodeSettings] = None
outputs class-attribute instance-attribute 
outputs: Optional[List[str]] = None