[GitHub] indhub commented on a change in pull request #11274: [MXNET-547] Tutorial explaining how to use the profiler

[GitBox <gi...@apache.org>]

indhub commented on a change in pull request #11274: [MXNET-547] Tutorial explaining how to use the profiler	
URL: https://github.com/apache/incubator-mxnet/pull/11274#discussion_r195522894
 
 

 ##########
 File path: docs/tutorials/python/profiler.md
 ##########
 @@ -0,0 +1,196 @@
+# Profiling MXNet Models
+
+It is often helpful to understand what operations take how much time while running a model. This helps optimize the model to run faster. In this tutorial, we will learn how to profile MXNet models to measure their running time and memory consumption using the MXNet profiler.
+
+## The incorrect way to profile
 
 Review comment:
   Agree. But I don't want to suggest wait_to_read as the recommended way to measure time taken by operations. While it might work for toy problems like this, 
   - it is harder to use to measure execution time of multiple operations (requires wait_to_read both before and after the measured operation in multiple places). 
   - It is hard to use to measure running time of a block inside a sequence (which is common)
   - it won't work for hybrid networks.
   
   The goal of this tutorial is to point people to a recommended way of profiling that works for almost all cases.
   
   However I can add a note along the lines of "While it is possible to use `wait_to_read()` before and after an operation to get running time of an operation, it is not a scalable method to measure running time of multiple operations, especially in a Sequential or Hybrid network"

----------------------------------------------------------------
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