profiler.lua

   1
   2 --[[
   3
   4    Written by Francois Fleuret (francois@fleuret.org)
   5
   6    This is free and unencumbered software released into the public
   7    domain.
   8
   9    Anyone is free to copy, modify, publish, use, compile, sell, or
  10    distribute this software, either in source code form or as a
  11    compiled binary, for any purpose, commercial or non-commercial, and
  12    by any means.
  13
  14    In jurisdictions that recognize copyright laws, the author or
  15    authors of this software dedicate any and all copyright interest in
  16    the software to the public domain. We make this dedication for the
  17    benefit of the public at large and to the detriment of our heirs
  18    and successors. We intend this dedication to be an overt act of
  19    relinquishment in perpetuity of all present and future rights to
  20    this software under copyright law.
  21
  22    THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
  23    EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  24    MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
  25    NONINFRINGEMENT.  IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY
  26    CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF
  27    CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
  28    WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  29
  30    For more information, please refer to <http://unlicense.org/>
  31
  32 ]]--
  33
  34 require 'torch'
  35 require 'nn'
  36 require 'sys'
  37
  38 profiler = {}
  39
  40 function profiler.decorate(model, functionsToDecorate)
  41
  42    local functionsToDecorate = functionsToDecorate or
  43       {
  44          'updateOutput',
  45          'backward'
  46       }
  47
  48    for _, name in pairs(functionsToDecorate) do
  49       model.accTime = {}
  50
  51       local nameOrig = name .. '__orig'
  52
  53       if model[name] and not model[nameOrig] then
  54          model[nameOrig] = model[name]
  55          model[name] = function(self, ...)
  56             local startTime = sys.clock()
  57             local result = { self[nameOrig](self, unpack({...})) }
  58             local endTime = sys.clock()
  59             self.accTime[name] = (self.accTime[name] or 0) + endTime - startTime
  60             return unpack(result)
  61          end
  62       end
  63
  64    end
  65
  66    if torch.isTypeOf(model, nn.Container) then
  67       for _, m in ipairs(model.modules) do
  68          profiler.decorate(m, functionsToDecorate)
  69       end
  70    end
  71
  72 end
  73
  74 function profiler.print(model, nbSamples, indent)
  75    local indent = indent or ''
  76
  77    print(string.format('%s* %s', indent, model.__typename))
  78
  79    for l, t in pairs(model.accTime) do
  80       local s
  81       if nbSamples then
  82          s = string.format(' (%.01fmus/sample)', 1e6 * t / nbSamples)
  83       else
  84          s = ''
  85       end
  86       print(string.format('%s  %s %.02fs%s', indent, l, t, s))
  87    end
  88
  89    if torch.isTypeOf(model, nn.Container) then
  90       for _, m in ipairs(model.modules) do
  91          profiler.print(m, nbSamples, indent .. '  ')
  92       end
  93    end
  94 end
  95
  96 return profiler