Fixing documentation

Project.toml

@@ -5,15 +5,13 @@ version = "0.5.1"
 
 [deps]
 Dates = "ade2ca70-3891-5945-98fb-dc099432e06a"
-FilePathsBase = "48062228-2e41-5def-b9a4-89aafe57970f"
 HTTP = "cd3eb016-35fb-5094-929b-558a96fad6f3"
 JSON = "682c06a0-de6a-54ab-a142-c8b1cf79cde6"
 ShowCases = "605ecd9f-84a6-4c9e-81e2-4798472b76a3"
 URIs = "5c2747f8-b7ea-4ff2-ba2e-563bfd36b1d4"
 UUIDs = "cf7118a7-6976-5b1a-9a39-7adc72f591a4"
 
 [compat]
-FilePathsBase = "0.9"
 HTTP = "1.9"
 JSON = "0.21"
 ShowCases = "0.1"

README.md

@@ -7,7 +7,3 @@
 
 
 Julia client for [MLFlow](https://www.mlflow.org/)
-
-This package is still under development and interfaces may change. See the documentation for current features and limitations.
-
-Tested against `mlflow==1.21.0` and `mlflow==1.22.0`.

docs/Project.toml

@@ -1,8 +1,6 @@
 [deps]
-Dates = "ade2ca70-3891-5945-98fb-dc099432e06a"
 Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
 HTTP = "cd3eb016-35fb-5094-929b-558a96fad6f3"
 JSON = "682c06a0-de6a-54ab-a142-c8b1cf79cde6"
-MLFlowClient = "64a0f543-368b-4a9a-827a-e71edb2a0b83"
+ShowCases = "605ecd9f-84a6-4c9e-81e2-4798472b76a3"
 URIs = "5c2747f8-b7ea-4ff2-ba2e-563bfd36b1d4"
-UUIDs = "cf7118a7-6976-5b1a-9a39-7adc72f591a4"

docs/make.jl

@@ -1,27 +1,15 @@
-using MLFlowClient
+push!(LOAD_PATH,"../src/")
 using Documenter
-
-DocMeta.setdocmeta!(MLFlowClient, :DocTestSetup, :(using MLFlowClient); recursive=true)
+using MLFlowClient
 
 makedocs(;
-    modules=[MLFlowClient],
-    authors="@deyandyankov and contributors",
-    repo="https://github.com/JuliaAI.jl/blob/{commit}{path}#{line}",
     sitename="MLFlowClient.jl",
-    format=Documenter.HTML(;
-        prettyurls=get(ENV, "CI", "false") == "true",
-        canonical="https://juliaai.github.io/MLFlowClient.jl",
-        assets=String[]
-    ),
-    pages=[
-        "Home" => "index.md",
-        "Tutorial" => "tutorial.md",
-        "Reference" => "reference.md"
-    ],
-    checkdocs=:exports
-)
+    authors="@deyandyankov and contributors",
+    pages=["Home" => "index.md", "Tutorial" => "tutorial.md", "Reference" => [
+        "Types" => "reference/types.md", "Artifact operations" => "reference/artifact.md",
+        "Experiment operations" => "reference/experiment.md",
+        "Logging operations" => "reference/loggers.md",
+        "Miscellaneous operations" => "reference/misc.md",
+        "Run operations" => "reference/run.md"]])
 
-deploydocs(;
-    repo="github.com/JuliaAI/MLFlowClient.jl",
-    devbranch="main"
-)
+deploydocs(; repo="github.com/JuliaAI/MLFlowClient.jl", devbranch="main")

docs/src/reference/artifact.md

@@ -0,0 +1,4 @@
+# Artifact operations
+```@docs
+listartifacts
+```

docs/src/reference/experiment.md

@@ -0,0 +1,11 @@
+# Experiment operations
+```@docs
+createexperiment
+getexperiment
+getexperimentbyname
+deleteexperiment
+restoreexperiment
+updateexperiment
+searchexperiments
+setexperimenttag
+```

docs/src/reference/loggers.md

@@ -0,0 +1,7 @@
+# Logging operations
+```@docs
+logmetric
+logbatch
+loginputs
+logparam
+```

docs/src/reference/misc.md

@@ -0,0 +1,5 @@
+# Miscellaneous operations
+```@docs
+getmetrichistory
+refresh
+```

docs/src/reference/run.md

@@ -0,0 +1,11 @@
+# Run operations
+```@docs
+createrun
+deleterun
+restorerun
+getrun
+setruntag
+deleteruntag
+searchruns
+updaterun
+```

docs/src/reference/types.md

@@ -0,0 +1,21 @@
+# Types
+```@docs
+MLFlow
+Tag
+ViewType
+RunStatus
+ModelVersionStatus
+Dataset
+DatasetInput
+FileInfo
+ModelVersion
+RegisteredModel
+RegisteredModelAlias
+Experiment
+Run
+Param
+Metric
+RunData
+RunInfo
+RunInputs
+```

docs/src/tutorial.md

@@ -40,7 +40,7 @@ p
 
 This could result in the following plot:
 
-![](withoutmlflow.png)
+![](images/withoutmlflow.png)
 
 Now, suppose that you are interested in turning this into an experiment which stores its metadata and results in MLFlow using `MLFlowClient`. You could amend the code like this:
 
@@ -114,8 +114,8 @@ updaterun(mlf, exprun, "FINISHED")
 
 This will result in the folowing experiment created in your `MLFlow` which is running on `http://localhost/`:
 
-![](mlflowexp.png)
+![](images/mlflowexp.png)
 
 You can also observe series logged against individual metrics, i.e. `pricepath1` looks like this in `MLFlow`:
 
-![](mlflowexpmetric1.png)
+![](images/mlflowexpmetric1.png)

src/MLFlowClient.jl

@@ -1,3 +1,14 @@
+"""
+    MLFlowClient
+
+[MLFlowClient](https://github.com/JuliaAI.jl) is a [Julia](https://julialang.org/) package
+for working with [MLFlow](https://mlflow.org/) using the REST
+[API v2.0](https://www.mlflow.org/docs/latest/rest-api.html).
+
+`MLFlowClient` allows you to create and manage `MLFlow` experiments, runs, and log metrics
+and artifacts. If you are not familiar with `MLFlow` and its concepts, please refer to
+[MLFlow documentation](https://mlflow.org/docs/latest/index.html).
+"""
 module MLFlowClient
 
 using Dates
@@ -6,7 +17,6 @@ using HTTP
 using URIs
 using JSON
 using ShowCases
-using FilePathsBase: AbstractPath
 
 include("types/mlflow.jl")
 export MLFlow
@@ -35,11 +45,10 @@ export Experiment
 include("types/run.jl")
 export Run, Param, Metric, RunData, RunInfo, RunInputs
 
-include("utils.jl")
-export refresh
-
 include("api.jl")
 
+include("utils.jl")
+
 include("services/experiment.jl")
 export getexperiment, createexperiment, deleteexperiment, setexperimenttag,
     updateexperiment, restoreexperiment, searchexperiments, getexperimentbyname
@@ -55,6 +64,6 @@ include("services/artifact.jl")
 export listartifacts
 
 include("services/misc.jl")
-export getmetrichistory
+export refresh, getmetrichistory
 
 end

src/services/artifact.jl

@@ -2,17 +2,17 @@
     listartifacts(instance::MLFlow, run_id::String; path::String="", page_token::String="")
     listartifacts(instance::MLFlow, run::Run; path::String="", page_token::String="")
 
-List artifacts for a run.
+List artifacts for a [`Run`](@ref).
 
 # Arguments
 - `instance`: [`MLFlow`](@ref) configuration.
-- `run_id`: ID of the run whose artifacts to list.
+- `run_id`: ID of the [`Run`](@ref) whose artifacts to list.
 - `path`: Filter artifacts matching this path (a relative path from the root artifact
-directory).
+    directory).
 - `page_token`: Token indicating the page of artifact results to fetch
 
 # Returns
-- Root artifact directory for the run.
+- Root artifact directory for the [`Run`](@ref).
 - List of file location and metadata for artifacts.
 - Token that can be used to retrieve the next page of artifact results.
 """