Removed the signature.

[profiler-torch.git] / profiler.lua

diff --git a/profiler.lua b/profiler.lua
index 3bbccaf..b363a60 100644 (file)
--- a/profiler.lua
+++ b/profiler.lua
@@ -1,33 +1,20 @@
 
 --[[
 
-   Written by Francois Fleuret (francois@fleuret.org)
-
-   This is free and unencumbered software released into the public
-   domain.
-
-   Anyone is free to copy, modify, publish, use, compile, sell, or
-   distribute this software, either in source code form or as a
-   compiled binary, for any purpose, commercial or non-commercial, and
-   by any means.
-
-   In jurisdictions that recognize copyright laws, the author or
-   authors of this software dedicate any and all copyright interest in
-   the software to the public domain. We make this dedication for the
-   benefit of the public at large and to the detriment of our heirs
-   and successors. We intend this dedication to be an overt act of
-   relinquishment in perpetuity of all present and future rights to
-   this software under copyright law.
-
-   THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
-   EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-   MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
-   NONINFRINGEMENT.  IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY
-   CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF
-   CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
-   WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
-
-   For more information, please refer to <http://unlicense.org/>
+   Copyright (c) 2016 Idiap Research Institute, http://www.idiap.ch/
+   Written by Francois Fleuret <francois.fleuret@idiap.ch>
+
+   This file is free software: you can redistribute it and/or modify
+   it under the terms of the GNU General Public License version 3 as
+   published by the Free Software Foundation.
+
+   It is distributed in the hope that it will be useful, but WITHOUT
+   ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
+   or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public
+   License for more details.
+
+   You should have received a copy of the GNU General Public License
+   along with this file.  If not, see <http://www.gnu.org/licenses/>.
 
 ]]--
 
@@ -37,6 +24,16 @@ require 'sys'
 
 profiler = {}
 
+profiler.color = true
+
+profiler.colors = function(name)
+   if profiler.color then
+      return sys.COLORS[name]
+   else
+      return ''
+   end
+end
+
 function profiler.decorate(model, functionsToDecorate)
 
    local functionsToDecorate = functionsToDecorate or
@@ -48,18 +45,26 @@ function profiler.decorate(model, functionsToDecorate)
    for _, name in pairs(functionsToDecorate) do
       model.accTime = {}
 
-      local nameOrig = name .. '__orig'
-
       -- We decorate the class and not the object, otherwise we cannot
       -- save models anymore.
 
       if rawget(model, name) then
-         error('We decorate the class, not the objects, and there is a ' .. name .. ' in ' .. model)
+         error('We decorate the classes, not the objects, and there is a `'
+                  .. name
+                  .. '\' function in '
+                  .. tostring(model))
       end
 
       local toDecorate = getmetatable(model)
 
-      if toDecorate[name] and not toDecorate[nameOrig] then
+      while not rawget(toDecorate, name) do
+         toDecorate = getmetatable(toDecorate)
+      end
+
+      local nameOrig = name .. '__orig'
+
+      if not toDecorate[nameOrig] then
+         -- print('Decorating ' .. toDecorate.__typename .. '.' .. name)
          toDecorate[nameOrig] = toDecorate[name]
          toDecorate[name] = function(self, ...)
             local startTime = sys.clock()
@@ -80,27 +85,55 @@ function profiler.decorate(model, functionsToDecorate)
 
 end
 
+function profiler.timingString(l, t, nbSamples, totalTime)
+   local s
+
+   s = string.format('%s %.02fs %s[%.02f%%]',
+                     l, t,
+                     profiler.colors('blue'),
+                     100 * t / totalTime
+   )
+
+   if nbSamples then
+      s = s .. string.format(profiler.colors('green') .. ' (%.01fmus/sample)',
+                             1e6 * t / nbSamples)
+   end
+
+   s = s .. profiler.colors('black')
+
+   return s
+end
+
 function profiler.print(model, nbSamples, totalTime, indent)
    local indent = indent or ''
    local hint
 
+   if not model.accTime then
+      error('The model does not seem decorated for profiling.')
+   end
+
+   local localTotal = 0
+   for _, t in pairs(model.accTime) do
+      localTotal = localTotal + t
+   end
+
+   totalTime = totalTime or localTotal
+
    if torch.isTypeOf(model, nn.Container) then
       hint = ' '
    else
-      hint = '*'
+      if profiler.color then
+         hint = '  ' .. profiler.colors('red')
+      else
+         hint = '* '
+      end
    end
 
-   print(string.format('%s%s %s', indent, hint, model.__typename))
+   print(profiler.timingString(indent .. hint .. model.__typename,
+                               localTotal, nbSamples, totalTime))
 
    for l, t in pairs(model.accTime) do
-      local s = string.format('%s  %s %.02fs', indent, l, t)
-      if totalTime then
-         s = s .. string.format(' [%.02f%%]', 100 * t / totalTime)
-      end
-      if nbSamples then
-         s = s .. string.format(' (%.01fmus/sample)', 1e6 * t / nbSamples)
-      end
-      print(s)
+      print(profiler.timingString(indent .. '  :' .. l, t, nbSamples, totalTime))
    end
 
    print()