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

Config model.

Source code in aineko/models/config_schema.py 
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
class Config(BaseModel):
    """Config model."""

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

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

            type: str
            params: Optional[dict] = None

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

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

        name: str
        default_node_settings: Optional[dict] = None
        nodes: Dict[str, Node]
        datasets: Dict[str, Dataset]

    pipeline: Pipeline

pipeline instance-attribute 

pipeline: Pipeline

Pipeline

Pipeline model.

Source code in aineko/models/config_schema.py 
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
class Pipeline(BaseModel):
    """Pipeline model."""

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

        type: str
        params: Optional[dict] = None

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

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

    name: str
    default_node_settings: Optional[dict] = None
    nodes: Dict[str, Node]
    datasets: Dict[str, Dataset]

datasets instance-attribute 

datasets: Dict[str, Dataset]

default_node_settings class-attribute instance-attribute 

default_node_settings: Optional[dict] = None

name instance-attribute 

name: str

nodes instance-attribute 

nodes: Dict[str, Node]

Dataset

Dataset model.

Source code in aineko/models/config_schema.py 
15
16
17
18
19
class Dataset(BaseModel):
    """Dataset model."""

    type: str
    params: Optional[dict] = None
params class-attribute instance-attribute 
params: Optional[dict] = None
type instance-attribute 
type: str

Node

Node model.

Source code in aineko/models/config_schema.py 
21
22
23
24
25
26
27
28
class Node(BaseModel):
    """Node model."""

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