Skip to content

Commit 50004ce

Browse files
pebetopebeto
committed
Fixing documentation
1 parent 78ccb90 commit 50004ce

29 files changed

+239
-239
lines changed

‎Project.toml

-2
Original file line numberDiff line numberDiff line change
@@ -5,15 +5,13 @@ version = "0.5.1"
55

66
[deps]
77
Dates = "ade2ca70-3891-5945-98fb-dc099432e06a"
8-
FilePathsBase = "48062228-2e41-5def-b9a4-89aafe57970f"
98
HTTP = "cd3eb016-35fb-5094-929b-558a96fad6f3"
109
JSON = "682c06a0-de6a-54ab-a142-c8b1cf79cde6"
1110
ShowCases = "605ecd9f-84a6-4c9e-81e2-4798472b76a3"
1211
URIs = "5c2747f8-b7ea-4ff2-ba2e-563bfd36b1d4"
1312
UUIDs = "cf7118a7-6976-5b1a-9a39-7adc72f591a4"
1413

1514
[compat]
16-
FilePathsBase = "0.9"
1715
HTTP = "1.9"
1816
JSON = "0.21"
1917
ShowCases = "0.1"

‎README.md

-4
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,3 @@
77

88

99
Julia client for [MLFlow](https://www.mlflow.org/)
10-
11-
This package is still under development and interfaces may change. See the documentation for current features and limitations.
12-
13-
Tested against `mlflow==1.21.0` and `mlflow==1.22.0`.

‎docs/Project.toml

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

‎docs/make.jl

+10-22
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,15 @@
1-
using MLFlowClient
1+
push!(LOAD_PATH,"../src/")
22
using Documenter
3-
4-
DocMeta.setdocmeta!(MLFlowClient, :DocTestSetup, :(using MLFlowClient); recursive=true)
3+
using MLFlowClient
54

65
makedocs(;
7-
modules=[MLFlowClient],
8-
authors="@deyandyankov and contributors",
9-
repo="https://github.com/JuliaAI.jl/blob/{commit}{path}#{line}",
106
sitename="MLFlowClient.jl",
11-
format=Documenter.HTML(;
12-
prettyurls=get(ENV, "CI", "false") == "true",
13-
canonical="https://juliaai.github.io/MLFlowClient.jl",
14-
assets=String[]
15-
),
16-
pages=[
17-
"Home" => "index.md",
18-
"Tutorial" => "tutorial.md",
19-
"Reference" => "reference.md"
20-
],
21-
checkdocs=:exports
22-
)
7+
authors="@deyandyankov and contributors",
8+
pages=["Home" => "index.md", "Tutorial" => "tutorial.md", "Reference" => [
9+
"Types" => "reference/types.md", "Artifact operations" => "reference/artifact.md",
10+
"Experiment operations" => "reference/experiment.md",
11+
"Logging operations" => "reference/loggers.md",
12+
"Miscellaneous operations" => "reference/misc.md",
13+
"Run operations" => "reference/run.md"]])
2314

24-
deploydocs(;
25-
repo="github.com/JuliaAI/MLFlowClient.jl",
26-
devbranch="main"
27-
)
15+
deploydocs(; repo="github.com/JuliaAI/MLFlowClient.jl", devbranch="main")

‎docs/src/mlflowexp.png renamed to ‎docs/src/images/mlflowexp.png

File renamed without changes.

‎docs/src/mlflowexpmetric1.png renamed to ‎docs/src/images/mlflowexpmetric1.png

File renamed without changes.

‎docs/src/withoutmlflow.png renamed to ‎docs/src/images/withoutmlflow.png

File renamed without changes.

‎docs/src/reference.md

-59
This file was deleted.

‎docs/src/reference/artifact.md

+4
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
# Artifact operations
2+
```@docs
3+
listartifacts
4+
```

‎docs/src/reference/experiment.md

+11
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# Experiment operations
2+
```@docs
3+
createexperiment
4+
getexperiment
5+
getexperimentbyname
6+
deleteexperiment
7+
restoreexperiment
8+
updateexperiment
9+
searchexperiments
10+
setexperimenttag
11+
```

‎docs/src/reference/loggers.md

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# Logging operations
2+
```@docs
3+
logmetric
4+
logbatch
5+
loginputs
6+
logparam
7+
```

‎docs/src/reference/misc.md

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# Miscellaneous operations
2+
```@docs
3+
getmetrichistory
4+
refresh
5+
```

‎docs/src/reference/run.md

+11
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# Run operations
2+
```@docs
3+
createrun
4+
deleterun
5+
restorerun
6+
getrun
7+
setruntag
8+
deleteruntag
9+
searchruns
10+
updaterun
11+
```

‎docs/src/reference/types.md

+21
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
# Types
2+
```@docs
3+
MLFlow
4+
Tag
5+
ViewType
6+
RunStatus
7+
ModelVersionStatus
8+
Dataset
9+
DatasetInput
10+
FileInfo
11+
ModelVersion
12+
RegisteredModel
13+
RegisteredModelAlias
14+
Experiment
15+
Run
16+
Param
17+
Metric
18+
RunData
19+
RunInfo
20+
RunInputs
21+
```

‎docs/src/tutorial.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ p
4040

4141
This could result in the following plot:
4242

43-
![](withoutmlflow.png)
43+
![](images/withoutmlflow.png)
4444

4545
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:
4646

@@ -114,8 +114,8 @@ updaterun(mlf, exprun, "FINISHED")
114114

115115
This will result in the folowing experiment created in your `MLFlow` which is running on `http://localhost/`:
116116

117-
![](mlflowexp.png)
117+
![](images/mlflowexp.png)
118118

119119
You can also observe series logged against individual metrics, i.e. `pricepath1` looks like this in `MLFlow`:
120120

121-
![](mlflowexpmetric1.png)
121+
![](images/mlflowexpmetric1.png)

‎src/MLFlowClient.jl

+14-5
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,14 @@
1+
"""
2+
MLFlowClient
3+
4+
[MLFlowClient](https://github.com/JuliaAI.jl) is a [Julia](https://julialang.org/) package
5+
for working with [MLFlow](https://mlflow.org/) using the REST
6+
[API v2.0](https://www.mlflow.org/docs/latest/rest-api.html).
7+
8+
`MLFlowClient` allows you to create and manage `MLFlow` experiments, runs, and log metrics
9+
and artifacts. If you are not familiar with `MLFlow` and its concepts, please refer to
10+
[MLFlow documentation](https://mlflow.org/docs/latest/index.html).
11+
"""
112
module MLFlowClient
213

314
using Dates
@@ -6,7 +17,6 @@ using HTTP
617
using URIs
718
using JSON
819
using ShowCases
9-
using FilePathsBase: AbstractPath
1020

1121
include("types/mlflow.jl")
1222
export MLFlow
@@ -35,11 +45,10 @@ export Experiment
3545
include("types/run.jl")
3646
export Run, Param, Metric, RunData, RunInfo, RunInputs
3747

38-
include("utils.jl")
39-
export refresh
40-
4148
include("api.jl")
4249

50+
include("utils.jl")
51+
4352
include("services/experiment.jl")
4453
export getexperiment, createexperiment, deleteexperiment, setexperimenttag,
4554
updateexperiment, restoreexperiment, searchexperiments, getexperimentbyname
@@ -55,6 +64,6 @@ include("services/artifact.jl")
5564
export listartifacts
5665

5766
include("services/misc.jl")
58-
export getmetrichistory
67+
export refresh, getmetrichistory
5968

6069
end

‎src/services/artifact.jl

+4-4
Original file line numberDiff line numberDiff line change
@@ -2,17 +2,17 @@
22
listartifacts(instance::MLFlow, run_id::String; path::String="", page_token::String="")
33
listartifacts(instance::MLFlow, run::Run; path::String="", page_token::String="")
44
5-
List artifacts for a run.
5+
List artifacts for a [`Run`](@ref).
66
77
# Arguments
88
- `instance`: [`MLFlow`](@ref) configuration.
9-
- `run_id`: ID of the run whose artifacts to list.
9+
- `run_id`: ID of the [`Run`](@ref) whose artifacts to list.
1010
- `path`: Filter artifacts matching this path (a relative path from the root artifact
11-
directory).
11+
directory).
1212
- `page_token`: Token indicating the page of artifact results to fetch
1313
1414
# Returns
15-
- Root artifact directory for the run.
15+
- Root artifact directory for the [`Run`](@ref).
1616
- List of file location and metadata for artifacts.
1717
- Token that can be used to retrieve the next page of artifact results.
1818
"""

0 commit comments

Comments
 (0)