Reimplementing experiment service: createexperiment and getexperiment

Author: pebeto

src/MLFlowClient.jl

@@ -20,68 +20,19 @@ using JSON
 using ShowCases
 using FilePathsBase: AbstractPath
 
-include("types/mlflow.jl")
-export
-    MLFlow
-
+include("types/tag.jl")
+include("types/enums.jl")
+include("types/dataset.jl")
+include("types/artifact.jl")
+include("types/model_version.jl")
+include("types/registered_model.jl")
 include("types/experiment.jl")
-export
-    MLFlowExperiment
-
 include("types/run.jl")
-export
-    MLFlowRunStatus,
-    MLFlowRunInfo,
-    MLFlowRunDataMetric,
-    MLFlowRunDataParam,
-    MLFlowRunData,
-    MLFlowRun,
-    get_info,
-    get_data,
-    get_run_id,
-    get_params
-
-include("types/artifact.jl")
-export
-    MLFlowArtifactFileInfo,
-    MLFlowArtifactDirInfo,
-    get_path,
-    get_size
-
-include("api.jl")
+include("types/mlflow.jl")
 
 include("utils.jl")
-export
-    generatefilterfromparams
-    generatefilterfromattributes
-    generatefilterfromentity_type
-
-include("experiments.jl")
-export
-    createexperiment,
-    getexperiment,
-    getorcreateexperiment,
-    deleteexperiment,
-    restoreexperiment,
-    searchexperiments
-
-include("runs.jl")
-export
-    createrun,
-    getrun,
-    updaterun,
-    deleterun,
-    searchruns
-
-include("loggers.jl")
-export
-    logbatch,
-    logparam,
-    logmetric,
-    logartifact,
-    listartifacts,
-    settag
+include("api.jl")
 
-include("deprecated.jl")
+include("services/experiment.jl")
 
 end

src/services/experiment.jl

@@ -0,0 +1,78 @@
+"""
+    createexperiment(instance::MLFlow; name=missing, artifact_location=missing,
+        tags=[])
+
+Create an experiment with a name. Returns the newly created experiment.
+Validates that another experiment with the same name does not already exist and
+fails if another experiment with the same name already exists.
+
+# Arguments
+- `instance`: [`MLFlow`](@ref) configuration.
+- `name::String`: Experiment name. This field is required.
+- `artifact_location::String`: Location where all artifacts for the experiment
+are stored. If not provided, the remote server will select an appropriate
+default.
+- `tags`: A collection of tags to set on the experiment.
+
+# Returns
+An object of type [`Experiment`](@ref).
+"""
+function createexperiment(instance::MLFlow; name::String=missing,
+    artifact_location::String=missing, tags::Array{Dict{Any, Any}}=[])
+    if ismissing(name)
+        name = string(UUIDs.uuid4())
+    end
+
+    try
+        result = mlfpost(instance, "experiments/create"; name=name,
+            artifact_location=artifact_location, tags=tags)
+        return getexperiment(instance, result["experiment_id"])
+    catch e
+        if isa(e, HTTP.ExceptionRequest.StatusError) && e.status == 400
+            error_code = JSON.parse(String(e.response.body))["error_code"]
+            if error_code == MLFLOW_ERROR_CODES.RESOURCE_ALREADY_EXISTS
+                error("Experiment with name \"$name\" already exists")
+            end
+        end
+        throw(e)
+    end
+end
+createexperiment(instance::MLFlow; name::String=missing,
+    artifact_location::String=missing, tags::Array{Pair{Any, Any}}=[]) =
+    createexperiment(instance, name=name, artifact_location=artifact_location,
+        tags=tags |> transform_pair_array_to_dict_array)
+createexperiment(instance::MLFlow; name::String=missing,
+    artifact_location::String=missing, tags::Dict{Any, Any}=[]) =
+    createexperiment(instance, name=name, artifact_location=artifact_location,
+        tags=tags |> transform_dict_to_dict_array)
+createexperiment(instance::MLFlow; name::String=missing,
+    artifact_location::String=missing, tags::Array{Tag}=[]) =
+    createexperiment(instance, name=name, artifact_location=artifact_location,
+        tags=tags |> transform_tag_array_to_dict_array)
+
+"""
+    getexperiment(instance::MLFlow, experiment_id::String)
+
+Get metadata for an experiment. This method works on deleted experiments.
+
+# Arguments
+- `instance`: [`MLFlow`](@ref) configuration.
+- `experiment_id`: ID of the associated experiment.
+
+# Returns
+An object of type [`Experiment`](@ref).
+"""
+function getexperiment(instance::MLFlow, experiment_id::String)
+    try
+        arguments = (:experiment_id => experiment_id,)
+        result = mlfget(instance, "experiments/get"; arguments...)
+        return Experiment(result["experiment"])
+    catch e
+        if isa(e, HTTP.ExceptionRequest.StatusError) && e.status == 404
+            return missing
+        end
+        throw(e)
+    end
+end
+getexperiment(instance::MLFlow, experiment_id::Integer) =
+    getexperiment(instance, experiment_id)

src/utils.jl

@@ -68,3 +68,68 @@ const MLFLOW_ERROR_CODES = (;
     RESOURCE_ALREADY_EXISTS = "RESOURCE_ALREADY_EXISTS",
     RESOURCE_DOES_NOT_EXIST = "RESOURCE_DOES_NOT_EXIST",
 )
+
+"""
+    transform_pair_array_to_dict_array(pair_array::Array{Pair{Any, Any}})
+
+Transforms an array of `Pair` into an array of `Dict`.
+
+```@example
+# Having an array of pairs
+["foo" => "bar", "missy" => "gala"]
+
+# Will be transformed into an array of dictionaries
+[Dict("key" => "foo", "value" => "bar"), Dict("key" => "missy", "value" => "gala")]
+```
+"""
+function transform_pair_array_to_dict_array(pair_array::Array{Pair{Any, Any}})
+    dict_array = Dict{String, String}[]
+    for pair in pair_array
+        key = string(pair.first)
+        value = string(pair.second)
+        push!(dict_array, Dict(key => value))
+    end
+    return dict_array
+end
+
+"""
+    transform_dict_to_dict_array(dict::Dict{Any, Any})
+
+Transforms a dictionary into an array of `Dict`.
+
+```@example
+# Having a dictionary
+Dict("foo" => "bar", "missy" => "gala")
+
+# Will be transformed into an array of dictionaries
+[Dict("key" => "foo", "value" => "bar"), Dict("key" => "missy", "value" => "gala")]
+```
+"""
+function transform_dict_to_dict_array(dict::Dict{Any, Any})
+    dict_array = Dict{String, String}[]
+    for (key, value) in dict
+        push!(dict_array, Dict(string(key) => string(value)))
+    end
+    return dict_array
+end
+
+"""
+    transform_tag_array_to_dict_array(tag_array::Array{Tag})
+
+Transforms an array of `Tag` into an array of `Dict`.
+
+```@example
+# Having an array of tags
+[Tag("foo", "bar"), Tag("missy", "gala")]
+
+# Will be transformed into an array of dictionaries
+[Dict("key" => "foo", "value" => "bar"), Dict("key" => "missy", "value" => "gala")]
+```
+"""
+function transform_tag_array_to_dict_array(tag_array::Array{Tag})
+    dict_array = Dict{String, String}[]
+    for tag in tag_array
+        push!(dict_array, Dict(tag.key => tag.value))
+    end
+    return dict_array
+end