FlowGraph

Applicability

Product

Supported

Atlas A3 training product / Atlas A3 inference product

Atlas A2 training product / Atlas A2 inference product

Atlas 200I/500 A2 inference product

x

Atlas inference product

x

Atlas training product

x

Function Description

Defines a DataFlow graph, which consists of the input node FlowData and compute node FlowNode.

Prototype

1
FlowGraph(outputs, graph_options={}, name=None, graphpp_builder_async = False)

Parameters

Parameter

Data Type

Description

outputs

List[FlowOutput]

All outputs of the FlowGraph output node must be included. For details, see dataflow.FlowOutput.

graph_options

Dict[str, str]

Options compiled by FlowGraph, which currently supports the configuration parameters passed by the AddGraph API.

For details about options, see Options.

The configuration example must be adapted based on Python.

name

str

Graph name. The framework automatically ensures that the graph name is unique. If this parameter is not set, names such as FlowGraph, FlowGraph_1, FlowGraph_2, and the like will be automatically generated.

graphpp_builder_async

bool

Whether the builder of GraphProcessPoint in FlowGraph is executed asynchronously. The values are as follows:

  • True: yes
  • False: no

The default value is False.

Returns

None is returned in normal scenarios.

A DfException is thrown upon exceptions. You can catch DfException and retrieve its error_code and message attributes to check the specific error code and error details. For details, see DataFlow Error Codes.

Examples

1
2
import dataflow as df
graph = df.FlowGraph(...)

Constraints

None