接口列表

DataFlow构图接口

表1 DataFlow构图接口
接口名称	简介
FlowOperator类	FlowOperator类是Dataflow Graph的节点基类，继承于GE的Operator。
FlowData的构造函数和析构函数	FlowData构造函数和析构函数，构造函数会返回一个FlowData节点。
FlowNode构造函数和析构函数	FlowNode构造函数和析构函数，构造函数返回一个FlowNode节点。
SetInput	给FlowNode设置输入，表示将src_op的第src_index个输出作为FlowNode的第dst_index个输入，返回设置好输入的FlowNode节点。
AddPp	给FlowNode添加映射的ProcessPoint，当前一个FlowNode仅能添加一个ProcessPoint，添加后会默认将FlowNode的输入输出和ProcessPoint的输入输出按顺序进行映射。
MapInput	给FlowNode映射输入，表示将FlowNode的第node_input_index个输入给到ProcessPoint的第pp_input_index个输入，并且给ProcessPoint的该输入设置上attr里的所有属性，返回映射好的FlowNode节点。该函数可选，不被调用时会默认按顺序去映射FlowNode和ProcessPoint的输入。
MapOutput	给FlowNode映射输出，表示将ProcessPoint的第pp_output_index个输出给到FlowNode的第node_output_index个输出，返回映射好的FlowNode节点。
SetBalanceScatter	设置节点balance scatter属性，具有balance scatter属性的UDF可以使用balance options设置负载均衡输出。
SetBalanceGather	设置节点balance gather属性，具有balance gather属性的UDF可以使用balance options设置负载均衡亲和输出。
FlowGraph构造函数和析构函数	FlowGraph构造函数和析构函数，构造函数会返回一张空的FlowGraph图。
SetInputs	设置FlowGraph的输入节点，会自动根据节点的输出连接关系构建出一张FlowGraph图，并返回该图。
SetOutputs	设置FlowGraph的输出节点，并返回该图。
SetOutputs	设置FlowGraph中的FlowNode和FlowNode输出index的关联关系，并返回该图。常用于设置FlowNode部分输出场景，比如FlowNode1有2个输出，但是作为FlowNode2输入的时候只需要FlowNode1的一个输出，这种情况下可以设置FlowNode1的一个输出index。
SetContainsNMappingNode	设置FlowGraph是否包含n_mapping节点。
SetInputsAlignAttrs	设置FlowGraph中的输入对齐属性。
const ge::Graph &ToGeGraph() const	将FlowGraph转换到GE的Graph。
SetGraphPpBuilderAsync	设置FlowGraph中的GraphPp的Builder是否异步执行。
SetExceptionCatch	设置用户异常捕获功能是否开启。
ProcessPoint析构函数	ProcessPoint析构函数。
GetProcessPointType	获取ProcessPoint的类型。
GetProcessPointName	获取ProcessPoint的名称。
GetCompileConfig	获取ProcessPoint编译配置的文件。
Serialize	ProcessPoint的序列化方法。由ProcessPoint的子类去实现该方法的功能。
FunctionPp构造函数和析构函数	FunctionPp的构造函数和析构函数，构造函数会返回一个FunctionPp对象。
SetCompileConfig	设置FunctionPp的json配置文件名字和路径，该配置文件用于将FunctionPp和UDF进行映射。
AddInvokedClosure(const char_t *name, const GraphPp &graph_pp)	添加FunctionPp调用的GraphPp，返回添加好的FunctionPp。
AddInvokedClosure(const char_t *name, const ProcessPoint &pp)	添加FunctionPp调用的GraphPp，返回添加好的FunctionPp。
SetInitParam	设置FunctionPp的初始化参数，返回设置好的FunctionPp。
Serialize	FunctionPp的序列化方法。
GetInvokedClosures	获取FunctionPp调用的GraphPp。
GraphPp构造函数和析构函数	GraphPp构造函数和析构函数，构造函数会返回一个GraphPp对象。
SetCompileConfig	设置GraphPp的json配置文件路径和文件名。配置文件用于AscendGraph的描述和编译。
Serialize	GraphPp的序列化方法。
GetGraphBuilder	获取GraphPp中Graph的创建函数。
TimeBatch	TimeBatch功能是基于UDF为前提的。正常模型每次处理一个数据，当需要一次处理一批数据时，就需要将这批数据组成一个Batch，最基本的Batch方式是将这批N个数据直接拼接，然后shape前加N，而某些场景需要将某段或者某几段时间数据组成一个batch，并且按特定的维度拼接，则可以通过使用TimeBatch功能来组Batch。
CountBatch	CountBatch功能是指基于UDF为计算处理点将多个数据按batchSize组成batch。

DataFlow运行接口

表2 DataFlow运行接口
接口名称	简介
FeedDataFlowGraph（feed所有输入）	将所有数据输入到Graph图。
FeedRawData	将原始数据输入到Graph图。
FetchDataFlowGraph（获取所有输出数据）	获取图形输出数据。
FetchDataFlowGraph（按索引获取输出数据）	按索引获取图形输出数据。
构造函数和析构函数	DataFlowInfo构造函数和析构函数。
SetUserData	设置用户信息。
GetUserData	获取用户信息。
SetStartTime	设置数据的开始时间戳。
GetStartTime	获取数据的开始时间戳。
SetEndTime	设置数据的结束时间戳。
GetEndTime	获取数据的结束时间戳。
SetFlowFlags	设置数据中的flags。
GetFlowFlags	获取数据中的flags。

父主题： DataFlow API（C++）