aclmdlLoadFromFileWithMem

Applicability

Product	Supported
Atlas A3 training products / Atlas A3 inference products	√
Atlas A2 training products / Atlas A2 inference products	√
Atlas 200I/500 A2 inference products	√
Atlas inference products	√
Atlas training products	√

Description

Loads offline model data from a file. The model workspace is managed by the user.

The file specified by modelPath is an offline model (offline model adapted to the Ascend AI Processor) in the format of *.om. For details about how to obtain the .om file, see "Command-Line Options" > "Basic Options" > "General Options" > "--mode" in ATC Instructions.

Prototype

aclError aclmdlLoadFromFileWithMem(const char *modelPath, uint32_t *modelId, void *workPtr, size_t workSize, void *weightPtr, size_t weightSize)

Parameters

Parameter	Input/Output	Description
modelPath	Input	Pointer to the model file path, which contains the file name. The user who runs the app must have enough permission to access the directory.
modelId	Output	Pointer to the model ID. Returns the model ID after the model is successfully loaded. The model ID is used for model identification in subsequent operations.
workPtr	Input	Pointer to the address of the workspace (for storing temporary data during model execution) required by the model on the device. The workspace is managed by the user and cannot be freed during model execution. If a null pointer is passed to workPtr, the workspace is managed by the system. In the event where the memory is managed by the user, if multiple models are executed in serial, the models can share a workspace. However, you need to guarantee the serial execution sequence of the models and the workspace size (the same as the total size of the workspaces needed by all the models). Refer to the following description to ensure serial execution: For synchronous model execution, add a lock to ensure that tasks are executed in serial. For asynchronous model execution, use a single stream to ensure that tasks are executed in serial.
workSize	Input	Workspace size required for model execution, in bytes. Invalid when workPtr is a null pointer.
weightPtr	Input	Pointer to the address of the model weight memory (for storing weight data) on the device. The memory is managed by the user and cannot be freed during model execution. If a null pointer is passed, the memory is managed by the system. In the multithreaded scenario where the weight memory is managed by the user, if a model is loaded once in each thread, weightPtr can be shared because the weight memory is read-only at inference time. Note that weightPtr cannot be freed when the sharing is in progress.
weightSize	Input	Weight memory size required for model execution, in bytes. Invalid when weightPtr is a null pointer.

Returns

0 on success; else, failure. For details, see aclError.