Implemented logparam

Author: pebeto

src/MLFlowClient.jl

@@ -76,6 +76,7 @@ include("services/loggers.jl")
 export
     logbatch,
     loginputs,
-    logmetric
+    logmetric,
+    logparam
 
 end

src/services/loggers.jl

@@ -33,6 +33,12 @@ logmetric(instance::MLFlow, run::Run, key::String, value::Float64;
     step::Union{Int64, Missing}=missing)::Bool =
     logmetric(instance, run.info.run_id, key, value; timestamp=timestamp,
         step=step)
+logmetric(instance::MLFlow, run_id::String, metric::Metric)::Bool =
+    logmetric(instance, run_id, metric.key, metric.value, timestamp=metric.timestamp,
+        step=metric.step)
+logmetric(instance::MLFlow, run::Run, metric::Metric)::Bool =
+    logmetric(instance, run.info.run_id, metric.key, metric.value,
+        timestamp=metric.timestamp, step=metric.step)
 
 """
     logbatch(instance::MLFlow, run_id::String;
@@ -94,3 +100,32 @@ function loginputs(instance::MLFlow, run_id::String,
 end
 loginputs(instance::MLFlow, run::Run, datasets::Array{DatasetInput})::Bool =
     loginputs(instance, run.info.run_id, datasets)
+
+"""
+    logparam(instance::MLFlow, run_id::String, key::String, value::String)
+    logparam(instance::MLFlow, run::Run, key::String, value::String)
+    logparam(instance::MLFlow, run_id::String, param::Param)
+    logparam(instance::MLFlow, run::Run, param::Param)
+
+Log a param used for a run. A param is a key-value pair (string key, string
+value). Examples include hyperparameters used for ML model training and
+constant dates and values used in an ETL pipeline. A param can be logged only
+once for a run.
+
+# Arguments
+- `instance`: [`MLFlow`](@ref) configuration.
+- `run_id`: ID of the run under which to log the param.
+- `key`: Name of the param.
+- `value`: String value of the param being logged.
+"""
+function logparam(instance::MLFlow, run_id::String, key::String,
+    value::String)::Bool
+    mlfpost(instance, "runs/log-parameter"; run_id=run_id, key=key, value=value)
+    return true
+end
+logparam(instance::MLFlow, run::Run, key::String, value::String)::Bool =
+    logparam(instance, run.info.run_id, key, value)
+logparam(instance::MLFlow, run_id::String, param::Param)::Bool =
+    logparam(instance, run_id, param.key, param.value)
+logparam(instance::MLFlow, run::Run, param::Param)::Bool =
+    logparam(instance, run.info.run_id, param.key, param.value)

test/services/loggers.jl

@@ -2,9 +2,9 @@
     @ensuremlf
 
     experiment_id = createexperiment(mlf, UUIDs.uuid4() |> string)
-    run = createrun(mlf, experiment_id)
 
     @testset "with run id as string" begin
+        run = createrun(mlf, experiment_id)
         logmetric(mlf, run.info.run_id, "missy", 0.9)
 
         run = refresh(mlf, run)
@@ -13,9 +13,11 @@
         @test last_metric isa Metric
         @test last_metric.key == "missy"
         @test last_metric.value == 0.9
+        deleterun(mlf, run)
     end
 
     @testset "with run" begin
+        run = createrun(mlf, experiment_id)
         logmetric(mlf, run, "gala", 0.1)
 
         run = refresh(mlf, run)
@@ -24,6 +26,37 @@
         @test last_metric isa Metric
         @test last_metric.key == "gala"
         @test last_metric.value == 0.1
+        deleterun(mlf, run)
+    end
+
+    @testset "with run id as string and metric" begin
+        run = createrun(mlf, experiment_id)
+        logmetric(mlf, run.info.run_id, Metric("missy", 0.9, 123, 1))
+        
+        run = refresh(mlf, run)
+        last_metric = run.data.metrics |> last
+
+        @test last_metric isa Metric
+        @test last_metric.key == "missy"
+        @test last_metric.value == 0.9
+        @test last_metric.timestamp == 123
+        @test last_metric.step == 1
+        deleterun(mlf, run)
+    end
+
+    @testset "with run and metric" begin
+        run = createrun(mlf, experiment_id)
+        logmetric(mlf, run, Metric("gala", 0.1, 123, 1))
+        
+        run = refresh(mlf, run)
+        last_metric = run.data.metrics |> last
+
+        @test last_metric isa Metric
+        @test last_metric.key == "gala"
+        @test last_metric.value == 0.1
+        @test last_metric.timestamp == 123
+        @test last_metric.step == 1
+        deleterun(mlf, run)
     end
 
     deleteexperiment(mlf, experiment_id)
@@ -201,3 +234,63 @@ end
 
     deleteexperiment(mlf, experiment_id)
 end
+
+@testset verbose = true "log param" begin
+    @ensuremlf
+
+    experiment_id = createexperiment(mlf, UUIDs.uuid4() |> string)
+
+    @testset "with run id as string" begin
+        run = createrun(mlf, experiment_id)
+        logparam(mlf, run.info.run_id, "missy", "0.9")
+        
+        run = refresh(mlf, run)
+        last_param = run.data.params |> last
+
+        @test last_param isa Param
+        @test last_param.key == "missy"
+        @test last_param.value == "0.9"
+        deleterun(mlf, run)
+    end
+
+    @testset "with run" begin
+        run = createrun(mlf, experiment_id)
+        logparam(mlf, run, "gala", "0.1")
+        
+        run = refresh(mlf, run)
+        last_param = run.data.params |> last
+
+        @test last_param isa Param
+        @test last_param.key == "gala"
+        @test last_param.value == "0.1"
+        deleterun(mlf, run)
+    end
+
+    @testset "with run id as string and param" begin
+        run = createrun(mlf, experiment_id)
+        logparam(mlf, run.info.run_id, Param("missy", "0.9"))
+        
+        run = refresh(mlf, run)
+        last_param = run.data.params |> last
+
+        @test last_param isa Param
+        @test last_param.key == "missy"
+        @test last_param.value == "0.9"
+        deleterun(mlf, run)
+    end
+
+    @testset "with run and param" begin
+        run = createrun(mlf, experiment_id)
+        logparam(mlf, run, Param("gala", "0.1"))
+        
+        run = refresh(mlf, run)
+        last_param = run.data.params |> last
+
+        @test last_param isa Param
+        @test last_param.key == "gala"
+        @test last_param.value == "0.1"
+        deleterun(mlf, run)
+    end
+
+    deleteexperiment(mlf, experiment_id)
+end