--[[
- 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/>.
]]--
profiler = {}
-function profiler.decor(model, functionsToDecorate)
+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
{
for _, name in pairs(functionsToDecorate) do
model.accTime = {}
- local functionTable = model
+ -- We decorate the class and not the object, otherwise we cannot
+ -- save models anymore.
- -- We decorate the function where it is defined in the class
- -- hierarchy, so we have to go up the metatables until we find
- -- it with rawget
+ if rawget(model, name) then
+ error('We decorate the classes, not the objects, and there is a `'
+ .. name
+ .. '\' function in '
+ .. tostring(model))
+ end
+
+ local toDecorate = getmetatable(model)
- while functionTable and not rawget(functionTable, name) do
- functionTable = getmetatable(functionTable)
+ while not rawget(toDecorate, name) do
+ toDecorate = getmetatable(toDecorate)
end
local nameOrig = name .. '__orig'
- if functionTable[name] and not functionTable[nameOrig] then
- print('Profiler decoring ' .. functionTable.__typename .. '.' .. name)
- functionTable[nameOrig] = functionTable[name]
- functionTable[name] = function(self, ...)
+ if not toDecorate[nameOrig] then
+ -- print('Decorating ' .. toDecorate.__typename .. '.' .. name)
+ toDecorate[nameOrig] = toDecorate[name]
+ toDecorate[name] = function(self, ...)
local startTime = sys.clock()
local result = { self[nameOrig](self, unpack({...})) }
local endTime = sys.clock()
if torch.isTypeOf(model, nn.Container) then
for _, m in ipairs(model.modules) do
- profiler.decor(m, functionsToDecorate)
+ profiler.decorate(m, functionsToDecorate)
end
end
end
-function profiler.print(model, nbSamples, indent)
- local indent = indent or ''
+function profiler.timingString(l, t, nbSamples, totalTime)
+ local s
- print(string.format('%s* %s', indent, model.__typename))
+ s = string.format('%s %.02fs %s[%.02f%%]',
+ l, t,
+ profiler.colors('blue'),
+ 100 * t / totalTime
+ )
if nbSamples then
- for l, t in pairs(model.accTime) do
- print(string.format('%s %s %.02fs (%.01fmus/sample)',
- indent,
- l,
- t,
- 1e6 * t / nbSamples))
- end
+ 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
- for l, t in pairs(model.accTime) do
- print(string.format('%s %s %.02fs',
- indent,
- l,
- t))
+ if profiler.color then
+ hint = ' ' .. profiler.colors('red')
+ else
+ hint = '* '
end
end
+ print(profiler.timingString(indent .. hint .. model.__typename,
+ localTotal, nbSamples, totalTime))
+
+ for l, t in pairs(model.accTime) do
+ print(profiler.timingString(indent .. ' :' .. l, t, nbSamples, totalTime))
+ end
+
+ print()
+
if torch.isTypeOf(model, nn.Container) then
for _, m in ipairs(model.modules) do
- profiler.print(m, nbSamples, indent .. ' ')
+ profiler.print(m, nbSamples, totalTime, indent .. ' ')
end
end
end