Model

查看源文件

import com.mindspore.Model;

Model定义了MindSpore中编译和运行的模型。

公有成员函数

function

boolean build(MappedByteBuffer buffer, int modelType, MSContext context, char[] dec_key, String dec_mode)

boolean build(Graph graph, MSContext context, TrainCfg cfg)

boolean build(MappedByteBuffer buffer, MSContext context)

boolean build(String modelPath, MSContext context, char[] dec_key, String dec_mode)

boolean build(String modelPath, MSContext context)

boolean predict()

boolean runStep()

boolean resize(List<MSTensor> inputs, int[][] dims)

List<MSTensor> getInputs()

List<MSTensor> getOutputs()

MSTensor getInputsByTensorName(String tensorName)

MSTensor getOutputByTensorName(String tensorName)

List<MSTensor> getOutputsByNodeName(String nodeName)

List<String> getOutputTensorNames()

boolean export(String fileName, int quantizationType, boolean isOnlyExportInfer,List<String> outputTensorNames)

List<MSTensor> getFeatureMaps()

boolean updateFeatureMaps(List<MSTensor> features)

boolean setTrainMode(boolean isTrain)

boolean getTrainMode()

boolean setLearningRate(float learning_rate)

boolean setupVirtualBatch(int virtualBatchMultiplier, float learningRate, float momentum)

void free()

ModelType

build

public boolean build(Graph graph, MSContext context, TrainCfg cfg)

通过模型计算图编译MindSpore模型。

  • 参数

    • graph: 模型计算图。

    • context: 编译运行上下文。

    • cfg: 训练配置。

  • 返回值

    是否编译成功。

public boolean build(MappedByteBuffer buffer, int modelType, MSContext context, char[] dec_key, String dec_mode)

通过模型计算图内存块编译MindSpore模型。

  • 参数

    • buffer: 模型计算图内存块。

    • modelType: 模型计算图类型,可选MindIR、ONNX。

    • context: 运行时Context上下文。

    • dec_key: 模型解密秘钥。

    • dec_mode: 模型解密算法,可选AES-GCM、AES-CBC。

  • 返回值

    是否编译成功。

public boolean build(final MappedByteBuffer buffer, int modelType, MSContext context)

通过模型计算图内存块编译MindSpore模型。

  • 参数

    • buffer: 模型计算图内存块。

    • modelType: 模型计算图类型,可选MindIR、ONNX。

    • context: 运行时Context上下文。

  • 返回值

    是否编译成功。

public boolean build(String modelPath, int modelType, MSContext context, char[] dec_key, String dec_mode)

通过模型计算图文件编译MindSpore MindiR模型。

  • 参数

    • modelPath: 模型计算图文件。

    • modelType: 模型计算图类型,可选MindIR、ONNX。

    • context: 运行时Context上下文。

    • dec_key: 模型解密秘钥。

    • dec_mode: 模型解密算法,可选AES-GCM、AES-CBC。

  • 返回值

    是否编译成功。

public boolean build(String modelPath, int modelType, MSContext context)

通过模型计算图文件编译MindSpore MindIR模型。

  • 参数

    • modelPath: 模型计算图文件。

    • modelType: 模型计算图类型,可选MindIR、ONNX。

    • context: 运行时Context上下文。

  • 返回值

    是否编译成功。

predict

public boolean predict()

执行推理。

  • 返回值

    是否推理成功。

runStep

public boolean runStep()

执行单步训练。

  • 返回值

    是否单步训练成功。

resize

public boolean resize(List<MSTensor> inputs, int[][] dims)

调整输入的形状。

  • 参数

    • inputs: 模型对应的所有输入。

    • dims: 输入对应的新的shape,顺序注意要与inputs一致。

  • 返回值

    调整输入形状是否成功。

getInputs

public List<MSTensor> getInputs()

获取MindSpore模型的输入tensor列表。

  • 返回值

    所有输入MSTensor组成的List。

getOutputs

public List<MSTensor> getOutputs()

获取MindSpore模型的输出tensor列表。

  • 返回值

    所有输出MSTensor组成的List。

getInputsByTensorName

public MSTensor getInputsByTensorName(String tensorName)

通过张量名获取MindSpore模型的输入张量。

  • 参数

    • tensorName: 张量名。

  • 返回值

    tensorName所对应的输入MSTensor。

getOutputByTensorName

public MSTensor getOutputByTensorName(String tensorName)

通过张量名获取MindSpore模型的输出张量。

  • 参数

    • tensorName: 张量名。

  • 返回值

    该张量所对应的MSTensor。

getOutputsByNodeName

public List<MSTensor> getOutputsByNodeName(String nodeName)

通过节点名获取MindSpore模型的MSTensors输出。

  • 参数

    • nodeName: 节点名。

  • 返回值

    该节点所有输出MSTensor组成的List。

getOutputTensorNames

public List<String> getOutputTensorNames()

获取由当前会话所编译的模型的输出张量名。

  • 返回值

    按顺序排列的输出张量名组成的List。

export

public boolean export(String fileName, int quantizationType, boolean isOnlyExportInfer,List<String> outputTensorNames)

导出模型。

  • 参数

    • fileName: 模型文件名称。

    • quantizationType: 量化类型。可选不量化,权重量化。

    • isOnlyExportInfer: 是否只导推理图。

    • outputTensorNames: 指定导出图结尾的tensor名称。

  • 返回值

    导出模型是否成功。

getFeatureMaps

public List<MSTensor> getFeatureMaps()

获取权重参数。

  • 返回值

    权重参数列表。

updateFeatureMaps

public boolean updateFeatureMaps(List<MSTensor> features)

更新权重参数。

  • 参数

    • features: 新的权重参数列表。

  • 返回值

    权重是否更新成功。

setTrainMode

public boolean setTrainMode(boolean isTrain)

设置训练或推理模式。

  • 参数

    • isTrain: 是否训练。

  • 返回值

    运行模式是否设置成功。

getTrainMode

public boolean getTrainMode()

获取训练模式。

  • 返回值

    是否是训练模式。

setLearningRate

public boolean setLearningRate(float learning_rate)

设置学习率。

  • 参数

    • learning_rate: 学习率。

  • 返回值

    学习率设置是否成功。

setupVirtualBatch

public boolean setupVirtualBatch(int virtualBatchMultiplier, float learningRate, float momentum)

设置虚批次系数。

  • 参数

    • virtualBatchMultiplier: 虚批次系数,实际批次数需要乘以此系数。

    • learningRate: 学习率。

    • momentum: 动量系数。

  • 返回值

    虚批次系数设置是否成功。

free

public void free()

释放Model内存。

ModelType

import com.mindspore.config.ModelType;

模型文件类型。

public static final int MT_MINDIR = 0;
public static final int MT_AIR = 1;
public static final int MT_OM = 2;
public static final int MT_ONNX = 3;
public static final int MT_MINDIR_OPT = 4;