Merge pull request #9 from JuliaAI/v0.2-dev

v0.2
JuliaAI · Nov 20, 2021 · 14b974d · 14b974d
2 parents 677dddf + 85aa6fa
commit 14b974d
Show file tree

Hide file tree

Showing 12 changed files with 358 additions and 1,006 deletions.
diff --git a/.gitignore b/.gitignore
@@ -1,6 +1,6 @@
 *.jl.*.cov
 *.jl.cov
 *.jl.mem
-/Manifest.toml
+Manifest.toml
 /docs/build/
 mlruns
diff --git a/Project.toml b/Project.toml
@@ -1,16 +1,18 @@
 name = "MLFlowClient"
 uuid = "64a0f543-368b-4a9a-827a-e71edb2a0b83"
 authors = ["@deyandyankov and contributors"]
-version = "0.1.0"
+version = "0.2.0"
 
 [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"
 URIs = "5c2747f8-b7ea-4ff2-ba2e-563bfd36b1d4"
 UUIDs = "cf7118a7-6976-5b1a-9a39-7adc72f591a4"
 
 [compat]
+FilePathsBase = "0.9"
 HTTP = "0.9"
 JSON = "0.21"
 URIs = "1"

diff --git a/docs/src/index.md b/docs/src/index.md
@@ -4,13 +4,9 @@ CurrentModule = MLFlowClient
 
 # MLFlowClient
 
-[MLFlowClient](https://github.com/JuliaAI/MLFlowClient.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).
-
-## Limitations
-- no authentication support.
-- when storing artifacts, the assumption is that MLFlow and this library run on the same server. Artifacts are stored using plain filesystem operations. Therefore, `/mlruns` or the specified `artifact_location` must be accessible to both the MLFlow server (read), and this library (write).
+```@docs
+MLFlowClient
+```
 
 ## Installation
 

diff --git a/docs/src/reference.md b/docs/src/reference.md
@@ -6,6 +6,8 @@ CurrentModule = MLFlowClient
 
 # Types
 
+TODO: Document accessors.
+
 ```@docs
 MLFlow
 MLFlowExperiment
@@ -21,6 +23,7 @@ MLFlowRunStatus
 ```@docs
 createexperiment
 getexperiment
+getorcreateexperiment
 listexperiments
 deleteexperiment
 ```
@@ -42,3 +45,12 @@ logparam
 logmetric
 logartifact
 ```
+
+# Utilities
+
+```@docs
+mlfget
+mlfpost
+uri
+generatefilterfromparams
+```