Fixing documentation

pebeto · pebeto · commit e033c9a7ad62 · 2024-11-03T03:26:22.000-05:00
diff --git a/docs/Project.toml b/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"
diff --git a/docs/make.jl b/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")
diff --git a/docs/src/images/mlflowexp.png b/docs/src/images/mlflowexp.png
diff --git a/docs/src/images/mlflowexpmetric1.png b/docs/src/images/mlflowexpmetric1.png
diff --git a/docs/src/images/withoutmlflow.png b/docs/src/images/withoutmlflow.png
diff --git a/docs/src/reference.md b/docs/src/reference.md
diff --git a/docs/src/reference/artifact.md b/docs/src/reference/artifact.md
@@ -0,0 +1,4 @@
+# Artifact operations
+```@docs
+listartifacts
+```
diff --git a/docs/src/reference/experiment.md b/docs/src/reference/experiment.md
@@ -0,0 +1,11 @@
+# Experiment operations
+```@docs
+createexperiment
+getexperiment
+getexperimentbyname
+deleteexperiment
+restoreexperiment
+updateexperiment
+searchexperiments
+setexperimenttag
+```
diff --git a/docs/src/reference/loggers.md b/docs/src/reference/loggers.md
@@ -0,0 +1,7 @@
+# Logging operations
+```@docs
+logmetric
+logbatch
+loginputs
+logparam
+```
diff --git a/docs/src/reference/misc.md b/docs/src/reference/misc.md
@@ -0,0 +1,5 @@
+# Miscellaneous operations
+```@docs
+getmetrichistory
+refresh
+```
diff --git a/docs/src/reference/run.md b/docs/src/reference/run.md
@@ -0,0 +1,11 @@
+# Run operations
+```@docs
+createrun
+deleterun
+restorerun
+getrun
+setruntag
+deleteruntag
+searchruns
+updaterun
+```
diff --git a/docs/src/reference/types.md b/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
+```
diff --git a/docs/src/tutorial.md b/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)
