Skip to content

Commit 869886e

Browse files
committed
Improve documentation clarity for tags variable
- Clarified the expected structure and content of the `tags` variable in the documentation.
1 parent 30946be commit 869886e

File tree

2 files changed

+7
-7
lines changed

2 files changed

+7
-7
lines changed

src/experiments.jl

+4-4
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
"""
2-
createexperiment(mlf::MLFlow; name=missing, artifact_location=missing, tags::Vector{Dict{String, String}}=missing)
2+
createexperiment(mlf::MLFlow; name=missing, artifact_location=missing, tags=missing)
33
44
Creates an MLFlow experiment.
55
@@ -14,7 +14,7 @@ Creates an MLFlow experiment.
1414
An object of type [`MLFlowExperiment`](@ref).
1515
1616
"""
17-
function createexperiment(mlf::MLFlow; name=missing, artifact_location=missing, tags::Vector{Dict{String, String}}=missing)
17+
function createexperiment(mlf::MLFlow; name=missing, artifact_location=missing, tags=missing)
1818
endpoint = "experiments/create"
1919

2020
if ismissing(name)
@@ -90,7 +90,7 @@ function getexperiment(mlf::MLFlow, experiment_name::String)
9090
end
9191

9292
"""
93-
getorcreateexperiment(mlf::MLFlow, experiment_name::String; artifact_location=missing, tags::Vector{Dict{String, String}}=missing)
93+
getorcreateexperiment(mlf::MLFlow, experiment_name::String; artifact_location=missing, tags=missing)
9494
9595
Gets an experiment if one alrady exists, or creates a new one.
9696
@@ -105,7 +105,7 @@ Gets an experiment if one alrady exists, or creates a new one.
105105
An instance of type [`MLFlowExperiment`](@ref)
106106
107107
"""
108-
function getorcreateexperiment(mlf::MLFlow, experiment_name::String; artifact_location=missing, tags::Vector{Dict{String, String}}=missing)
108+
function getorcreateexperiment(mlf::MLFlow, experiment_name::String; artifact_location=missing, tags=missing)
109109
experiment = getexperiment(mlf, experiment_name)
110110

111111
if ismissing(experiment)

src/runs.jl

+3-3
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ Creates a run associated to an experiment.
1616
# Returns
1717
- an instance of type [`MLFlowRun`](@ref)
1818
"""
19-
function createrun(mlf::MLFlow, experiment_id; run_name=missing, start_time=missing, tags::Vector{Dict{String, String}}=missing)
19+
function createrun(mlf::MLFlow, experiment_id; run_name=missing, start_time=missing, tags=missing)
2020
endpoint = "runs/create"
2121
if ismissing(start_time)
2222
start_time = Int(trunc(datetime2unix(now(UTC)) * 1000))
@@ -25,11 +25,11 @@ function createrun(mlf::MLFlow, experiment_id; run_name=missing, start_time=miss
2525
MLFlowRun(result["run"]["info"], result["run"]["data"])
2626
end
2727
"""
28-
createrun(mlf::MLFlow, experiment::MLFlowExperiment; run_name=missing, start_time=missing, tags::Vector{Dict{String, String}}=missing)
28+
createrun(mlf::MLFlow, experiment::MLFlowExperiment; run_name=missing, start_time=missing, tags=missing)
2929
3030
Dispatches to `createrun(mlf::MLFlow, experiment_id; run_name=run_name, start_time=start_time, tags=tags)`
3131
"""
32-
createrun(mlf::MLFlow, experiment::MLFlowExperiment; run_name=missing, start_time=missing, tags::Vector{Dict{String, String}}=missing) =
32+
createrun(mlf::MLFlow, experiment::MLFlowExperiment; run_name=missing, start_time=missing, tags=missing) =
3333
createrun(mlf, experiment.experiment_id; run_name=run_name, start_time=start_time, tags=tags)
3434

3535
"""

0 commit comments

Comments
 (0)