mxnet-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From GitBox <...@apache.org>
Subject [GitHub] anirudh2290 commented on a change in pull request #10732: Profile doc
Date Fri, 27 Apr 2018 23:01:49 GMT
anirudh2290 commented on a change in pull request #10732: Profile doc
URL: https://github.com/apache/incubator-mxnet/pull/10732#discussion_r184824731
 
 

 ##########
 File path: docs/api/python/profiler/profiler.md
 ##########
 @@ -0,0 +1,82 @@
+# Profiler API
+
+## Overview
+
+MXNet has a built-in profiler which is compatible with both Intel® VTune™ Amplifier as
well as Chrome's chrome://tracing visualization engine.  When built with the USE_VTUNE=1 flag,
MXNet makes actual VTune API calls to define Domains, Frames, Tasks, Events Counters, and
Markers.  For a detailed explanation of these, see [Instrumentation and Tracing Technology
API Reference ](https://software.intel.com/en-us/vtune-amplifier-help-instrumentation-and-tracing-technology-api-reference)
+
+```eval_rst
+.. autosummary::
+    :nosignatures:
+
+    mxnet.profiler
+```
+
+## API Reference
+
+```eval_rst
+    .. currentmodule:: mxnet
+```
+
+### Profiling system control
+
+
+```eval_rst
+.. autosummary::
+    :nosignatures:
+
+    profiler.set_config
+    profiler.set_state
+    profiler.pause
+    profiler.resume
+    profiler.dump
+    profiler.dumps
+```
+
+### Profiling Objects
+
+These profiling objects can be created and accessed from python in order to resord performance
information of the python code paths 
 
 Review comment:
   resord ?

----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on GitHub and use the
URL above to go to the specific comment.
 
For queries about this service, please contact Infrastructure at:
users@infra.apache.org


With regards,
Apache Git Services

Mime
View raw message