Function: mark

Applicability

Product

Supported (√/x)

Atlas A3 training products / Atlas A3 inference products

Atlas A2 training products / Atlas A2 inference products

Atlas training products

Atlas inference products

Atlas 200I/500 A2 inference products

Function Usage

Marks an instantaneous event by msproftx.

After this API is called, the Profiling tool automatically adds the current timestamp to stamp and sets the event type to Mark, indicating that a msproftx profiling process starts.

Prototype

  • C Prototype
    1
    aclError aclprofMark(void *stamp)
    
  • Python Function
    1
    ret = acl.prof.mark(stamp)
    

Parameter Description

Parameter

Description

stamp

Int, stamp pointer address, indicating the msproftx event stamp. Specifies the pointer address of the Function: create_stamp API.

Return Value Description

Return Value

Description

ret

Int, error code.

  • 0 indicates success.
  • Other values indicate failure.

Restrictions

This API must be called between the create_stamp and destroy_stamp calls.

Reference

For the API call example, see Profile Data Collection.