Function: set_dump
Applicability
|
Product |
Supported |
|---|---|
|
Atlas 350 Accelerator Card |
√ |
|
|
√ |
|
|
√ |
|
|
√ |
|
|
√ |
|
|
√ |
Description
Sets dump configuration.
Prototype
- C Prototype
1aclError aclmdlSetDump(const char *dumpCfgPath)
- Python Function
1ret = acl.mdl.set_dump(dump_cfg_path)
Parameters
|
Parameter |
Description |
|---|---|
|
dump_cfg_path |
Currently, the following dump information can be configured: (If the operator input or output contains sensitive user information, information leakage may occur.)
|
Return Value
|
Return Value |
Description |
|---|---|
|
ret |
Int, error code. 0 on success; else, failure. |
Restrictions
- acl.mdl.init_dump must be used in pair with acl.mdl.set_dump and acl.mdl.finalize_dump to dump data to files. These APIs can be called for multiple times in a single process to obtain dump data of different Dump configurations.
- Example scenario:
- To execute two models, you need to set dump information differently. The API call sequence is as follows: acl.init --> acl.mdl.init_dump --> acl.mdl.set_dump --> Model loading --> Model execution --> acl.mdl.finalize_dump --> Model unloading -> acl.mdl.init_dump -> acl.mdl.set_dump -> Model loading -> Model execution -> acl.mdl.finalize_dump -> Model unloading -> Other tasks -> acl.finalize
- To execute the same model twice, you only need to perform the dump operation for the first execution. The API call sequence is as follows: acl.init --> acl.mdl.init_dump --> acl.mdl.set_dump --> Model loading --> Model execution --> acl.mdl.finalize_dump --> Model unloading --> Model loading --> Model execution --> Other tasks --> acl.finalize
- The configured dump information is valid only when the model is loaded after the dump function is enabled by calling this API. The dump configuration does not take effect on models loaded before this API call unless you reload the models after this API call.
For example, in the following API call sequence, the dump configuration is valid only for model 2:
acl.mdl.init_dump --> Model 1 loading --> acl.mdl.set_dump --> Model 2 loading --> --> acl.mdl.finalize_dump
- If this API is called repeatedly to set dump configuration for the same model, the most recent configuration is applied.
For example, in the following API call sequence, the second dump configuration call overwrites the first call:
acl.mdl.init_dump --> acl.mdl.set_dump --> acl.mdl.set_dump --> Model 1 loading --> acl.mdl.finalize_dump
Reference
In addition, the acl.init API is provided. During initialization, the dump configuration information is transferred through the *.json file. After the application is run, the dump data is obtained. In this mode, the acl.init API can be called only once in a process. To modify the dump configuration, modify the configuration in the *.json file.
Dump Watch Configuration for Operators
Set dump_scene to watcher to enable the operator dump watch mode. The following is an example of the configuration file: (1) After operators A and B are executed, the output of operators C and D is dumped. (2) After the C and D operators are executed, the output of the C and D operators is also dumped. Compare the dump files of operators C and D in (1) and (2) to check whether operators A and B overwrite the output memory of operators C and D.
{
"dump":{
"dump_list":[
{
"layer":["A", "B"],
"watcher_nodes":["C", "D"]
}
],
"dump_path":"/home/",
"dump_mode":"output",
"dump_scene":"watcher"
}
}
The details are as follows:
- If the operator dump watch mode is enabled, the overflow/underflow operator dump (by configuring the dump_debug parameter) or the single-operator model dump (by configuring the dump_op_switch parameter) cannot be enabled. Otherwise, an error will be reported. Dump watch cannot be applied in the single-operator API dump scenario.
- In dump_list, the layer parameter is used to configure the names of the operators that may overwrite the memory of other operators, and the watcher_nodes parameter is used to configure the names of the operators with accuracy issues possibly due to output memory being overwritten by other operators.
- If layer is specified, the output of the operators configured for watcher_nodes is dumped after all operators that support dump in the model are executed.
- If any operator in layer and watcher_nodes is not in a static graph or static subgraph, the configuration does not take effect.
- If an operator is in both layer and watcher_nodes or an operator in layer is a collective communication operator (the operator type starts with Hcom, for example, HcomAllReduce), only the dump files of operators in watcher_nodes will be exported.
- For a fused operator, use its name after fusion when you add it to watcher_nodes. Otherwise, dump files cannot be exported.
- Currently, model_name cannot be configured in dump_list.
- If the operator dump watch mode is enabled, dump_path, which is the path for storing the exported dump file, must be configured.
The exported dump files cannot be viewed using a text tool. To view the content of a dump file, convert the dump file to a NumPy file and then view the NumPy file using Python. For details about the conversion procedure, see Viewing Dump Data Files in Accuracy Analyzer.
dump_path can be set to an absolute path or a relative path.- An absolute path starts with a slash (/), for example, /home.
- A relative path starts with a directory name, for example, output.
- dump_mode is used to specify the data of the operators configured for watcher_nodes to be exported. Currently, only output can be configured.
