Merge pull request #8 from JuliaAI/getorcreateexperiment

#7 - getorcreateexperiment method.

docs/src/reference.md

@@ -21,6 +21,7 @@ MLFlowRunStatus
 ```@docs
 createexperiment
 getexperiment
+getorcreateexperiment
 listexperiments
 deleteexperiment
 ```

src/MLFlowClient.jl

@@ -34,6 +34,7 @@ include("experiments.jl")
 export
     createexperiment,
     getexperiment,
+    getorcreateexperiment,
     deleteexperiment,
     listexperiments
 

src/experiments.jl

@@ -10,7 +10,7 @@ Creates an MLFlow experiment.
 - `tags`: a Dictionary of key-values which tag the experiment.
 
 # Returns
-Experiment identifier (integer).
+An object of type [`MLFlowExperiment`](@ref).
 
 """
 function createexperiment(mlf::MLFlow; name=missing, artifact_location=missing, tags=missing)
@@ -19,7 +19,8 @@ function createexperiment(mlf::MLFlow; name=missing, artifact_location=missing,
         name = string(UUIDs.uuid4())
     end
     result = mlfpost(mlf, endpoint; name=name, artifact_location=artifact_location, tags=tags)
-    parse(Int, result["experiment_id"])
+    experiment_id = parse(Int, result["experiment_id"])
+    getexperiment(mlf, experiment_id)
 end
 
 """
@@ -82,18 +83,66 @@ function _getexperimentbyname(mlf::MLFlow, experiment_name::String)
 end
 
 """
-    deleteexperiment(mlf::MLFlow, experiment_id)
+    getorcreateexperiment(mlf::MLFlow, experiment_name::String)
+
+Gets an experiment if one alrady exists, or creates a new one.
+
+# Arguments
+- `mlf`: [`MLFlow`](@ref) configuration.
+- `experiment_name`: Experiment name.
+
+# Returns
+An instance of type [`MLFlowExperiment`](@ref)
+
+"""
+function getorcreateexperiment(mlf::MLFlow, experiment_name::String)
+    exp = getexperiment(mlf, experiment_name)
+    if ismissing(exp)
+        exp = createexperiment(mlf, name=experiment_name)
+    end
+    exp
+end
+
+"""
+    deleteexperiment(mlf::MLFlow, experiment_id::Integer)
 
 Deletes an MLFlow experiment.
 
 # Arguments
 - `mlf`: [`MLFlow`](@ref) configuration.
 - `experiment_id`: experiment identifier.
+
+# Returns
+
+`true` if successful. Otherwise, raises exception.
 """
-function deleteexperiment(mlf::MLFlow, experiment_id)
+function deleteexperiment(mlf::MLFlow, experiment_id::Integer)
     endpoint = "experiments/delete"
-    mlfpost(mlf, endpoint; experiment_id=experiment_id)
+    try
+        result = mlfpost(mlf, endpoint; experiment_id=experiment_id)
+    catch e
+        if isa(e, HTTP.ExceptionRequest.StatusError) && e.status == 404
+            # experiment already deleted
+            return true
+        end
+        throw(e)
+    end
+    true
 end
+"""
+    deleteexperiment(mlf::MLFlow, experiment::MLFlowExperiment)
+
+Deletes an MLFlow experiment.
+
+# Arguments
+- `mlf`: [`MLFlow`](@ref) configuration.
+- `experiment`: an object of type [`MLFlowExperiment`](@ref)
+
+Dispatches to `deleteexperiment(mlf::MLFlow, experiment_id::Integer)`.
+
+"""
+deleteexperiment(mlf::MLFlow, experiment::MLFlowExperiment) =
+    deleteexperiment(mlf, experiment.experiment_id)
 
 """
     listexperiments(mlf::MLFlow)

src/runs.jl

@@ -22,6 +22,13 @@ function createrun(mlf::MLFlow, experiment_id; start_time=missing, tags=missing)
     result = mlfpost(mlf, endpoint; experiment_id=experiment_id, start_time=string(start_time), tags=tags)
     MLFlowRun(result["run"]["info"], result["run"]["data"])
 end
+"""
+    createrun(mlf::MLFlow, experiment::MLFlowExperiment; start_time=missing, tags=missing)
+
+Dispatches to `createrun(mlf::MLFlow, experiment_id; start_time=start_time, tags=tags)`
+"""
+createrun(mlf::MLFlow, experiment::MLFlowExperiment; start_time=missing, tags=missing) =
+    createrun(mlf, experiment.experiment_id; start_time=start_time, tags=tags)
 
 """
     getrun(mlf::MLFlow, run_id)

src/types.jl

@@ -10,9 +10,11 @@ Base type which defines location and version for MLFlow API service.
 # Constructors
 
 - `MLFlow(baseuri; apiversion=2.0)`
+- `MLFlow()` - defaults to `MLFlow("http://localhost:5000")`
+
 # Examples
 ``` julia-repl
-julia> mlf = MLFlow("http://localhost:5000")
+julia> mlf = MLFlow()
 MLFlow("http://localhost:5000", 2.0)
 ```
 
@@ -22,6 +24,7 @@ struct MLFlow
     apiversion
     MLFlow(baseuri; apiversion=2.0) = new(baseuri, apiversion)
 end
+MLFlow() = MLFlow("http://localhost:5000")
 
 """
     MLFlowExperiment

test/runtests.jl

@@ -12,24 +12,23 @@ function mlflow_server_is_running(mlf::MLFlow)
     end
 end
 
-@testset "MLFlowClient.jl" begin
-    mlflowbaseuri = "http://localhost:5000"
-    mlf = MLFlow(mlflowbaseuri)
-    @test mlf.baseuri == mlflowbaseuri
+@testset "MLFlow" begin
+    mlf = MLFlow()
+    @test mlf.baseuri == "http://localhost:5000"
     @test mlf.apiversion == 2.0
+end
 
-    if !mlflow_server_is_running(mlf)
-        return nothing
-    end
+@testset "MLFlowClient.jl" begin
+    mlf = MLFlow()
+    mlflow_server_is_running(mlf) || return nothing
 
     exptags = [:key => "val"]
     expname = "expname-$(UUIDs.uuid4())"
 
     @test ismissing(getexperiment(mlf, "$(UUIDs.uuid4()) - $(UUIDs.uuid4())"))
 
-    experiment_id = createexperiment(mlf; name=expname, tags=exptags)
-    experiment = getexperiment(mlf, experiment_id)
-    @test experiment.experiment_id == experiment_id
+    experiment = createexperiment(mlf; name=expname, tags=exptags)
+    experiment_id = experiment.experiment_id
     experimentbyname = getexperiment(mlf, expname)
     @test experimentbyname.name == experiment.name
 
@@ -92,3 +91,28 @@ end
     @test experiment.experiment_id == experiment_id
     @test experiment.lifecycle_stage == "deleted"
 end
+
+@testset "createrun" begin
+    mlf = MLFlow()
+    mlflow_server_is_running(mlf) || return nothing
+
+    expname = "getorcreate-$(UUIDs.uuid4())"
+    e = getorcreateexperiment(mlf, expname)
+    r = createrun(mlf, e.experiment_id)
+    @test isa(r, MLFlowRun)
+    rr = createrun(mlf, e)
+    @test isa(rr, MLFlowRun)
+end
+@testset "getorcreateexperiment" begin
+    mlf = MLFlow()
+    mlflow_server_is_running(mlf) || return nothing
+
+    expname = "getorcreate"
+    e = getorcreateexperiment(mlf, expname)
+    @test isa(e, MLFlowExperiment)
+    ee = getorcreateexperiment(mlf, expname)
+    @test isa(ee, MLFlowExperiment)
+    @test e === ee
+    @test deleteexperiment(mlf, ee)
+    @test deleteexperiment(mlf, ee)
+end