Implementing getmetrichistory

Author: pebeto

src/MLFlowClient.jl

@@ -79,4 +79,8 @@ export
     logmetric,
     logparam
 
+include("services/misc.jl")
+export
+    getmetrichistory
+
 end

src/api.jl

@@ -31,7 +31,8 @@ headers(mlf::MLFlow, custom_headers::AbstractDict) = merge(mlf.headers, custom_h
 Performs a HTTP GET to a specified endpoint. kwargs are turned into GET params.
 """
 function mlfget(mlf, endpoint; kwargs...)
-    apiuri = uri(mlf, endpoint; parameters=kwargs |> Dict)
+    apiuri = uri(mlf, endpoint;
+        parameters=Dict(k => v for (k, v) in kwargs if v !== missing))
     apiheaders = headers(mlf, ("Content-Type" => "application/json") |> Dict)
 
     try

src/services/misc.jl

@@ -0,0 +1,28 @@
+"""
+    getmetrichistory(instance::MLFlow, run_id::String, metric_key::String;
+        page_token::String="", max_results::Int32=1)
+
+Get a list of all values for the specified metric for a given run.
+
+# Arguments
+- `instance`: [`MLFlow`](@ref) configuration.
+- `run_id`: ID of the run from which to fetch metric values.
+- `metric_key`: Name of the metric.
+- `page_token`: Token indicating the page of metric history to fetch.
+- `max_results`: Maximum number of logged instances of a metric for a run to 
+return per call.
+"""
+function getmetrichistory(instance::MLFlow, run_id::String, metric_key::String;
+    page_token::String="",
+    max_results::Union{Int64, Missing}=missing
+)::Tuple{Array{Metric}, Union{String, Nothing}}
+    result = mlfget(instance, "metrics/get-history"; run_id=run_id,
+        metric_key=metric_key, page_token=page_token,
+        max_results=
+            (ismissing(max_results) ? max_results : (max_results |> Int32)))
+
+    metrics = result["metrics"] |> (x -> [Metric(y) for y in x])
+    next_page_token = get(result, "next_page_token", nothing)
+
+    return metrics, next_page_token
+end

test/runtests.jl

@@ -7,3 +7,4 @@ include("base.jl")
 include("services/experiment.jl")
 include("services/run.jl")
 include("services/loggers.jl")
+include("services/misc.jl")

test/services/misc.jl

@@ -0,0 +1,19 @@
+@testset verbose = true "get metric history" begin
+    @ensuremlf
+
+    experiment_id = createexperiment(mlf, UUIDs.uuid4() |> string)
+    run = createrun(mlf, experiment_id)
+    for i in 1:20
+        logmetric(mlf, run, "missy", i |> Float64)
+    end
+
+    @testset "default search" begin
+        metrics, next_page_token = getmetrichistory(mlf, run.info.run_id,
+            "missy")
+
+        @test length(metrics) == 20
+        @test next_page_token |> isnothing
+    end
+
+    deleteexperiment(mlf, experiment_id)
+end