Merge pull request #66 from CarloLucibello/master

add set_step_increment!

Author: PhilipVinc

docs/src/index.md

@@ -52,6 +52,7 @@ it will increment the internal counter by 1.
 
 If you want to increase the counter by a different amount, or prevent it from increasing, you can log the additional message
 `log_step_increment=N`. The default behaviour corresponds to `N=1`. If you set `N=0` the internal counter will not be modified.
+The defaul behaviour for logger `lg` can be changed executing `set_step_increment!(lg, N)`.
 
 See the example below:
 ```julia

src/TBLogger.jl

@@ -3,6 +3,7 @@ mutable struct TBLogger <: AbstractLogger
     file::IOStream
     all_files::Dict{String, IOStream}
     global_step::Int
+    step_increment::Int
     min_level::LogLevel
 end
 
@@ -17,21 +18,27 @@ already exists.
 export tb_append, tb_overwrite, tb_increment
 
 """
-    TBLogger(logdir, [tb_increment ; time=time(), purge_step::Int, min_level=Logging.Info])
+    TBLogger(logdir[, tb_increment]; 
+            time=time(), 
+            purge_step=nothing, 
+            step_increment=1, 
+            min_level=Logging.Info)
 
 Creates a TensorBoardLogger in the folder `logdir`. The second (optional)
 argument specifies the behaviour if the `logdir` already exhists: the default
-choice `tb_increment` appends an increasing number 1,2... to logdir. Other
-choices are `tb_overwrite`, which overwrites the previous folder and `tb_append`.
+choice `tb_increment` appends an increasing number 1,2... to `logdir`. Other
+choices are `tb_overwrite`, which overwrites the previous folder, and `tb_append`.
 
-If `purge_step::Int` is passed, every step before `purge_step` will be ignored
+If a `purge_step::Int` is passed, every step before `purge_step` will be ignored
 by tensorboard (usefull in the case of restarting a crashed computation).
 
-`min_level=Logging.Info` specifies the minimum level of messages logged to
-tensorboard
+`min_level` specifies the minimum level of messages logged to
+tensorboard.
 """
 function TBLogger(logdir="tensorboard_logs/run", overwrite=tb_increment;
-                  time=time(), purge_step::Union{Int,Nothing}=nothing,
+                  time=time(), 
+                  purge_step::Union{Int,Nothing}=nothing,
+                  step_increment = 1, 
                   min_level::LogLevel=Info)
 
     logdir = init_logdir(logdir, overwrite)
@@ -40,7 +47,7 @@ function TBLogger(logdir="tensorboard_logs/run", overwrite=tb_increment;
     all_files  = Dict(fpath => evfile)
     start_step = something(purge_step, 0)
 
-    TBLogger(logdir, evfile, all_files, start_step, min_level)
+    TBLogger(logdir, evfile, all_files, start_step, step_increment, min_level)
 end
 
 """
@@ -159,6 +166,16 @@ logger when no value is passed by the user.
 """
 set_step!(lg::TBLogger, step) = lg.global_step = step
 
+"""
+    set_step_increment!(lg, increment) -> Int
+
+Sets the default increment applyed to logger `lg`'s iteration counter
+each time logging is performed.
+
+Can be overidden by passing `log_step_increment=some_increment` when logging.
+"""
+set_step_increment!(lg::TBLogger, step) = lg.global_step = step
+
 """
 	increment_step!(lg, Δ_Step) -> Int
 
@@ -208,7 +225,7 @@ function CoreLogging.handle_message(lg::TBLogger, level, message, _module, group
 									id, file, line; kwargs...)
     # Unpack the message
     summ    = SummaryCollection()
-    i_step = 1 # :log_step_increment default value
+    i_step = lg.step_increment # :log_step_increment default value
 
     if !isempty(kwargs)
         data = Vector{Pair{String,Any}}()

src/TensorBoardLogger.jl

@@ -10,7 +10,7 @@ using StatsBase  #TODO: remove this. Only needed to compute histogram bins.
 using  Base.CoreLogging: CoreLogging, AbstractLogger, LogLevel, Info,
     handle_message, shouldlog, min_enabled_level, catch_exceptions
 
-export TBLogger, reset!, set_step!, increment_step!
+export TBLogger, reset!, set_step!, increment_step!, set_step_increment!
 export log_histogram, log_value, log_vector, log_text, log_image, log_images,
        log_audio, log_audios, log_graph, log_embeddings, log_custom_scalar
 export map_summaries