Moved export and wrote a docstring for the API method

Author: JamieMair

src/TensorBoardLogger.jl

@@ -21,7 +21,7 @@ using  Base.CoreLogging: CoreLogging, AbstractLogger, LogLevel, Info,
 
 export TBLogger, reset!, set_step!, increment_step!, set_step_increment!, with_TBLogger_hold_step
 export log_histogram, log_value, log_vector, log_text, log_image, log_images,
-       log_audio, log_audios, log_graph, log_embeddings, log_custom_scalar
+       log_audio, log_audios, log_graph, log_embeddings, log_custom_scalar, write_hparams!
 export map_summaries, TBReader
 
 export ImageFormat, L, CL, LC, LN, NL, NCL, NLC, CLN, LCN, HW, WH, HWC, WHC,

src/hparams.jl

@@ -79,6 +79,17 @@ function encode_bytes(content::HP.HParamsPluginData)
     return take!(data)
 end
 
+"""
+    write_hparams!(logger::TBLogger, hparams::Dict{String, Any}, metrics::AbstractArray{String})
+
+Writes the supplied hyperparameters to the logger, along with noting all metrics that should be tracked.
+
+The value of `hparams` can be a `String`, `Bool` or a subtype of `Real`. All `Real` values are converted
+to `Float64` when writing the logs.
+
+`metrics` should be a list of tags, which correspond to scalars that have been logged. Tensorboard will
+automatically extract the latest metric logged to use for this value.
+"""
 function write_hparams!(logger::TBLogger, hparams::Dict{String, Any}, metrics::AbstractArray{String})
     PLUGIN_NAME = "hparams"
     PLUGIN_DATA_VERSION = 0
@@ -118,7 +129,4 @@ function write_hparams!(logger::TBLogger, hparams::Dict{String, Any}, metrics::A
         write_event(logger, event)
     end
     nothing
-end
-
-
-export write_hparams!
+end