diff --git a/src/experiments.jl b/src/experiments.jl index 520b05f..7b34efd 100644 --- a/src/experiments.jl +++ b/src/experiments.jl @@ -7,7 +7,8 @@ Creates an MLFlow experiment. - `mlf`: [`MLFlow`](@ref) configuration. - `name`: experiment name. If not specified, MLFlow sets it. - `artifact_location`: directory where artifacts of this experiment will be stored. If not specified, MLFlow uses its default configuration. -- `tags`: a Dictionary of key-values which tag the experiment. +- `tags`: a Vector of Dictionaries which tag the experiment. + - example tags: [Dict("key" => "foo", "value" => "bar"), Dict("key" => "missy", "value" => "gala")] # Returns An object of type [`MLFlowExperiment`](@ref). @@ -97,7 +98,8 @@ Gets an experiment if one alrady exists, or creates a new one. - `mlf`: [`MLFlow`](@ref) configuration. - `experiment_name`: Experiment name. - `artifact_location`: directory where artifacts of this experiment will be stored. If not specified, MLFlow uses its default configuration. -- `tags`: a Dictionary of key-values which tag the experiment. +- `tags`: a Vector of Dictionaries which tag the experiment. + - example tags: [Dict("key" => "foo", "value" => "bar"), Dict("key" => "missy", "value" => "gala")] # Returns An instance of type [`MLFlowExperiment`](@ref) diff --git a/src/runs.jl b/src/runs.jl index 9115680..1caa140 100644 --- a/src/runs.jl +++ b/src/runs.jl @@ -10,7 +10,8 @@ Creates a run associated to an experiment. # Keywords - `run_name`: run name. If not specified, MLFlow sets it. - `start_time`: if provided, must be a UNIX timestamp in milliseconds. By default, set to current time. -- `tags`: if provided, must be a key-value structure such as a dictionary. +- `tags`: if provided, must be a key-value structure such as for example: + - [Dict("key" => "foo", "value" => "bar"), Dict("key" => "missy", "value" => "gala")] # Returns - an instance of type [`MLFlowRun`](@ref)