Documentation updates.

Author: deyandyankov

docs/src/reference.md

@@ -12,6 +12,7 @@ MLFlowExperiment
 MLFlowRun
 MLFlowRunInfo
 MLFlowRunData
+MLFlowRunDataMetric
 MLFlowRunStatus
 ```
 
@@ -31,6 +32,7 @@ createrun
 getrun
 updaterun
 deleterun
+searchruns
 ```
 
 # Logging

src/runs.jl

@@ -96,19 +96,19 @@ deleterun(mlf::MLFlow, run_info::MLFlowRunInfo) = deleterun(mlf, run_info.run_id
 deleterun(mlf::MLFlow, run::MLFlowRun) = deleterun(mlf, run.info)
 
 """
-    searchruns(mlf::MLFlow, experiment_ids, filter)
+    searchruns(mlf::MLFlow, experiment_ids)
 
-Searches for runs in an experiment based on filter.
+Searches for runs in an experiment.
 
 # Arguments
 - `mlf`: [`MLFlow`](@ref) configuration.
-- `experiment_ids::AbstractVector{Integer}`: `experiment_id`s in which to search for runs.
+- `experiment_ids::AbstractVector{Integer}`: `experiment_id`s in which to search for runs. Can also be a single `Integer`.
 
 # Keywords
 - `filter::String`: filter as defined in [MLFlow documentation](https://mlflow.org/docs/latest/rest-api.html#search-runs)
-- `run_view_type::String`: ...
-- `max_results::Integer`: ...
-- `order_by::String`: ...
+- `run_view_type::String`: one of `ACTIVE_ONLY`, `DELETED_ONLY`, or `ALL`.
+- `max_results::Integer`: 50,000 by default.
+- `order_by::String`: as defined in [MLFlow documentation](https://mlflow.org/docs/latest/rest-api.html#search-runs)
 - `page_token::String`: paging functionality, handled automatically. Not meant to be passed by the user.
 
 # Returns
@@ -155,6 +155,5 @@ function searchruns(mlf::MLFlow, experiment_ids::AbstractVector{<:Integer};
 
     runs
 end
-function searchruns(mlf::MLFlow, experiment_id::Integer; kwargs...)
+searchruns(mlf::MLFlow, experiment_id::Integer; kwargs...) =
     searchruns(mlf, [experiment_id]; kwargs...)
-end

src/types.jl

@@ -77,13 +77,13 @@ end
 Represents run metadata.
 
 # Fields
-- `run_id::String`
-- `experiment_id::Integer`
-- `status::MLFlowRunStatus` 
-- `start_time::Union{Int64,Missing}`
-- `end_time::Union{Int64,Missing}`
-- `artifact_uri::String`
-- `lifecycle_stage::String`
+- `run_id::String`: run identifier.
+- `experiment_id::Integer`: experiment identifier.
+- `status::MLFlowRunStatus`: run status.
+- `start_time::Union{Int64,Missing}`: when was the run started, UNIX time in milliseconds.
+- `end_time::Union{Int64,Missing}`: when did the run end, UNIX time in milliseconds.
+- `artifact_uri::String`: where are artifacts from this run stored.
+- `lifecycle_stage::String`: one of `active` or `deleted`.
 """
 struct MLFlowRunInfo
     run_id::String
@@ -133,10 +133,10 @@ end
 Represents a metric.
 
 # Fields
-- `key::String`: ...
-- `value`: ...
-- `step::Int64`: ...
-- `timestamp::Int64`: ...
+- `key::String`: metric identifier.
+- `value::Float64`: metric value.
+- `step::Int64`: step.
+- `timestamp::Int64`: timestamp in UNIX time in milliseconds.
 """
 struct MLFlowRunDataMetric
     key::String
@@ -161,7 +161,7 @@ Represents run data.
 # Fields
 - `metrics::Vector{MLFlowRunDataMetric}`: run metrics.
 - `params::Dict{String,String}`: run parameters.
-- `tags`
+- `tags`: list of run tags.
 
 """
 struct MLFlowRunData

test/runtests.jl

@@ -75,21 +75,20 @@ end
     logmetric(mlf, exprun2, "metric2", [1.0, 2.0])
     updaterun(mlf, exprun2, "FINISHED")
 
-    @show experiment_id
     runs = searchruns(mlf, experiment_id)
     @test length(runs) == 2
     runs = searchruns(mlf, experiment_id; filter="param.param2 = \"key2\"")
     @test length(runs) == 1
-    @test_throws ErrorException searchruns(mlf, experiment_id; run_view_type="MEH")
+    @test_throws ErrorException searchruns(mlf, experiment_id; run_view_type="ERR")
     runs = searchruns(mlf, experiment_id; filter="param.param2 = \"key3\"")
     @test length(runs) == 0
     runs = searchruns(mlf, experiment_id; max_results=1) # test paging functionality
     @test length(runs) == 2
-   # , "params.\"paramkey\" == \"paramval\"")
-    # deleterun(mlf, exprunid)
+    deleterun(mlf, exprunid)
+    deleterun(mlf, exprun2)
 
-    # deleteexperiment(mlf, experiment_id)
-    # experiment = getexperiment(mlf, experiment_id)
-    # @test experiment.experiment_id == experiment_id
-    # @test experiment.lifecycle_stage == "deleted"
+    deleteexperiment(mlf, experiment_id)
+    experiment = getexperiment(mlf, experiment_id)
+    @test experiment.experiment_id == experiment_id
+    @test experiment.lifecycle_stage == "deleted"
 end