X-Git-Url: https://fleuret.org/cgi-bin/gitweb/gitweb.cgi?a=blobdiff_plain;f=README.md;h=0e8bd5f0f339504a11ae02a0d902e0c549bc4474;hb=b758f38fa8142256d754a5ba18d6a7932d6e203c;hp=2adb72c321a7a7a3b6199bbf26643a91cc8b930c;hpb=e927faab65fb190dc01959236c07df46f3d28946;p=profiler-torch.git

diff --git a/README.md b/README.md
index 2adb72c..0e8bd5f 100644
--- a/README.md
+++ b/README.md
@@ -3,6 +3,10 @@ This is a simple profiler to estimate processing time per module per function.
 
 It seems to work okay, but there was no heavy testing so far. See test-profiler.lua for a short example.
 
+### profiler.color ###
+
+This is a Boolean flag to state if the printing should be done in color. It is true by default.
+
 ### profiler.decorate(model, [functionsToDecorate]) ###
 
 This function should be called before starting the computation.
@@ -13,4 +17,6 @@ It also resets the accumulated timings to zero.
 
 ### profiler.print(model, [nbSamples], [totalTime]) ###
 
-Prints the measured processing times. If nbSamples is provided, the time per samples will also be printed. If totalTime is provided, the percentages will also be printed.
+Prints the measured processing times. If nbSamples is provided, the time per samples will also be printed. If totalTime is not provided, the total at the top is used.
+
+Non-Containers are hilighted with a '*' or in red.