Skip to main content

module aixplain.modules.pipeline.designer.nodes

Global Variables​

  • TYPE_CHECKING

class AssetNode​

Asset node class, this node will be used to fetch the asset from the aixplain platform and use it in the pipeline.

assetId is required and will be used to fetch the asset from the aixplain platform.

Input and output parameters will be automatically added based on the asset function spec.

method __init__​

__init__(
    asset_id: Union[Model, str] = None,
    supplier: str = None,
    version: str = None,
    pipeline: 'DesignerPipeline' = None,
    **kwargs
)

method populate_asset​

populate_asset()

method serialize​

serialize() → dict

class BareAssetInputs​

class BareAssetOutputs​

class BareAsset​

method __init__​

__init__(
    asset_id: Union[Model, str] = None,
    supplier: str = None,
    version: str = None,
    pipeline: 'DesignerPipeline' = None,
    **kwargs
)

method populate_asset​

populate_asset()

method serialize​

serialize() → dict

class InputInputs​

class InputOutputs​

method __init__​

__init__(node: Node)

class Input​

Input node class, this node will be used to input the data to the pipeline.

Input nodes has only one output parameter called input.

data is a special convenient parameter that will be uploaded to the aixplain platform and the link will be passed as the input to the node.

method __init__​

__init__(
    data: Optional[str] = None,
    data_types: Optional[List[DataType]] = None,
    pipeline: 'DesignerPipeline' = None,
    **kwargs
)

method serialize​

serialize() → dict

class OutputInputs​

method __init__​

__init__(node: Node)

class OutputOutputs​

class Output​

Output node class, this node will be used to output the result of the pipeline.

Output nodes has only one input parameter called output.

method __init__​

__init__(
    data_types: Optional[List[DataType]] = None,
    pipeline: 'DesignerPipeline' = None,
    **kwargs
)

method serialize​

serialize() → dict

class Script​

Script node class, this node will be used to run a script on the input data.

script_path is a special convenient parameter that will be uploaded to the aixplain platform and the link will be passed as the input to the node.

method __init__​

__init__(
    pipeline: 'DesignerPipeline' = None,
    script_path: Optional[str] = None,
    fileId: Optional[str] = None,
    fileMetadata: Optional[str] = None,
    **kwargs
)

method serialize​

serialize() → dict

class Route​

Route class, this class will be used to route the input data to different nodes based on the input data type.

method __init__​

__init__(
    value: DataType,
    path: List[Union[Node, int]],
    operation: Operation,
    type: RouteType,
    **kwargs
)

Post init method to convert the nodes to node numbers if they are nodes.

method serialize​

serialize() → dict

class RouterInputs​

method __init__​

__init__(node: Node)

class RouterOutputs​

method __init__​

__init__(node: Node)

class Router​

Router node class, this node will be used to route the input data to different nodes based on the input data type.

method __init__​

__init__(routes: List[Route], pipeline: 'DesignerPipeline' = None, **kwargs)

method serialize​

serialize() → dict

class DecisionInputs​

method __init__​

__init__(node: Node)

class DecisionOutputs​

method __init__​

__init__(node: Node)

class Decision​

Decision node class, this node will be used to make decisions based on the input data.

method __init__​

__init__(routes: List[Route], pipeline: 'DesignerPipeline' = None, **kwargs)
link(
    to_node: Node,
    from_param: Union[str, Param],
    to_param: Union[str, Param]
) → Link

method serialize​

serialize() → dict

class BaseSegmentor​

Segmentor node class, this node will be used to segment the input data into smaller fragments for much easier and efficient processing.

method __init__​

__init__(
    asset_id: Union[Model, str] = None,
    supplier: str = None,
    version: str = None,
    pipeline: 'DesignerPipeline' = None,
    **kwargs
)

method populate_asset​

populate_asset()

method serialize​

serialize() → dict

class SegmentorInputs​

class SegmentorOutputs​

method __init__​

__init__(node: Node)

class BareSegmentor​

Segmentor node class, this node will be used to segment the input data into smaller fragments for much easier and efficient processing.

method __init__​

__init__(
    asset_id: Union[Model, str] = None,
    supplier: str = None,
    version: str = None,
    pipeline: 'DesignerPipeline' = None,
    **kwargs
)

method populate_asset​

populate_asset()

method serialize​

serialize() → dict

class BaseReconstructor​

Reconstructor node class, this node will be used to reconstruct the output of the segmented lines of execution.

method __init__​

__init__(
    asset_id: Union[Model, str] = None,
    supplier: str = None,
    version: str = None,
    pipeline: 'DesignerPipeline' = None,
    **kwargs
)

method populate_asset​

populate_asset()

method serialize​

serialize() → dict

class ReconstructorInputs​

method __init__​

__init__(node: Node)

class ReconstructorOutputs​

method __init__​

__init__(node: Node)

class BareReconstructor​

Reconstructor node class, this node will be used to reconstruct the output of the segmented lines of execution.

method __init__​

__init__(
    asset_id: Union[Model, str] = None,
    supplier: str = None,
    version: str = None,
    pipeline: 'DesignerPipeline' = None,
    **kwargs
)

method populate_asset​

populate_asset()

method serialize​

serialize() → dict

class BaseMetric​

method __init__​

__init__(
    asset_id: Union[Model, str] = None,
    supplier: str = None,
    version: str = None,
    pipeline: 'DesignerPipeline' = None,
    **kwargs
)

method build_label​

build_label()

method populate_asset​

populate_asset()

method serialize​

serialize() → dict

class MetricInputs​

method __init__​

__init__(node: Node)

class MetricOutputs​

method __init__​

__init__(node: Node)

class BareMetric​

method __init__​

__init__(
    asset_id: Union[Model, str] = None,
    supplier: str = None,
    version: str = None,
    pipeline: 'DesignerPipeline' = None,
    **kwargs
)

method build_label​

build_label()

method populate_asset​

populate_asset()

method serialize​

serialize() → dict