Protobuf Data Types

syntax = "proto3";IAITensor

package hiai;

// Tensor parameter description
message AITensorParaDescription
{
    string name = 1; // Parameter name
    string type = 2; // Parameter type
    string value = 3;  // Parameter value
    string desc = 4; // Parameter description
    repeated AITensorParaDescription sub_paras = 5; // Sub-parameter list
};

// Tensor description
message AITensorDescription
{
    string name = 1; // Tensor name
    string type = 2; // Tensor type
    repeated string compatible_type = 3; // Specifies all types of parent classes that are compatible.
   repeated AITensorParaDescription paras = 4; // Parameter list
};

// Tensor description list
message AITensorDescriptionList
{
    repeated AITensorDescription tensor_descs = 1; // Tensor list
}

// Common configuration items
// If sub_items exists, the current node is the parent node and the value is invalid.
message AIConfigItem
{
    string name = 1; // Configuration item name
    string value = 2;  // Configuration item value. When this parameter is set to the path of a model file, it contains the file name, supporting only digits, letters, underscores (_), and dots (.). You can set this parameter to the path of a single model file, for example, ./test_data/model/resnet18.om. You can also compress the model files into a tar package and set the parameter to the path of the tar package, for example, ./test_data/model/resnet18.tar. If there are multiple AIConfigItem, the files with the same name but in different formats cannot be in the same directory when you set the path of the tar package, for example, ./test_data/model/test and ./test_data/model/test.tar. The APIs for creating graphs include Graph::CreateGraph or HIAI_CreateGraph.
    repeated AIConfigItem sub_items = 3; // Configuration subitem
};

// Configuration parameter for running an NN node or API
message AIConfig
{
    repeated AIConfigItem items = 1; // Configuration item list
};

// Model description
message AIModelDescription
{
      string name = 1; // Model name
    int32 type = 2; // Model type. Currently, only the DAVINCI_OFFLINE_MODEL type is supported. The value is 0.
    string version = 3; // Model version
    int32 size = 4; // Model size
    string path = 5; // Model path
    string key = 8; // Model key
    bytes data = 100; // Model data
    repeated AITensorDescription inputs = 6; // Description of input tensors
    repeated AITensorDescription outputs = 7; // Description of output tensors
};

// NNNode description
message AINNNodeDescription
{
    string name = 1; // NN node name
    string desc = 2; // NN node description
   bool isPreAllocateOutputMem = 3; // Whether to pre-allocate the output memory
   AIConfig config = 4; // Configuration parameter
   repeated AIModelDescription model_list = 5;  // List of models required by an NN node
    repeated AITensorDescription inputs = 6; // Description of input tensors
    repeated AITensorDescription outputs = 7; // Description of output tensors
    bool need_verify = 8; // Whether to verify the tensor match during connection
    repeated string ignored_check_aitensor = 9; // Specifies the list of tensors for which the mechanism for verifying whether they match the tensors of the inputs is ignored during connection.
};

// NNNode description list
message AINNNodeDescriptionList
{
    repeated AINNNodeDescription nnnode_descs = 1; // NN node list
}

// API description
message AIAPIDescription
{
    string name = 1; // API name
    string desc = 2; // API description
    bool isPreAllocateOutputMem = 3; // Whether to pre-allocate the output memory
    AIConfig config = 4; // Configuration parameter
    repeated AITensorDescription inputs = 5; // Description of input tensors
    repeated AITensorDescription outputs = 6; // Description of output tensors
    bool need_verify = 7; // Whether to verify the tensor match during connection
    repeated string ignored_check_aitensor = 8; // Specifies the list of tensors for which the mechanism for verifying whether they match the tensors of the inputs is ignored during connection.
};

// API description list
message AIAPIDescriptionList
{
    repeated AIAPIDescription api_descs = 1; // API list
}

// AI operation description
message AIOPDescription
{
    enum OP_Type
    {
        AI_API = 0;
        AI_NNNODE = 1;
    }

    OP_Type type = 1;
    AINNNodeDescription nnnode_desc = 2;
    AIAPIDescription api_desc = 3;
};

// AI operation description list
message AIOPDescriptionList
{
   repeated AIOPDescription op_descs = 1; // AI operation list
}

// IDE passes parameters to Matrix APIs.

message NodeDesc
{
   string name=1; // IAINNNode or ALG_API name
   AIConfig config=2; // Initialization parameter required by IAINNNode or ALG_API
   repeated AIModelDescription mode_desc=3; // Initialization parameter required by IAINNNode
}

message EngineDesc
{
    enum RunSide
    {
        DEVICE=0;
        HOST=1;
    }
    enum EngineType
    {
        NORMAL=0;
        SOURCE=1;
        DEST=2;
    }
    uint32 id =1; // Engine ID (node)
    EngineType type=2; //
    string name =3; // Engine node name
    repeated string so_name=4; // The list of all DLL .so file names that need to be copied is loaded first according to the configuration sequence. If the loading fails, the system tries to load the list of files according to another loading sequence.
    RunSide side=5; // Run on the host side or device side.
    int32 priority=6; // Node priority
    uint32 instance_cnt=7; // Number of instances (equivalent to the number of threads)
    repeated uint32 next_node_id=8; // Next node list
    bool user_input_cb=9; // IDE can be ignored.
    bool user_output_cb=10; // IDE can be ignored.
    repeated NodeDesc oper=11; // Matrix node list
}

message GraphInitDesc
{
    int32 priority=1; // Priority of the entire process for a graph
   //Runside side = 2; // Assume that the graph is deployed on the host and cannot be configured.
}

message GeneralFileBuffer
{
    bytes raw_data = 1;
    string file_name = 2;
}