Merge pull request #2 from JuliaAI/docfixes

Minor updates to documentation

Author: deyandyankov

Project.toml

@@ -5,14 +5,12 @@ version = "0.1.0"
 
 [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"
 URIs = "5c2747f8-b7ea-4ff2-ba2e-563bfd36b1d4"
 UUIDs = "cf7118a7-6976-5b1a-9a39-7adc72f591a4"
 
 [compat]
-Documenter = "0.27"
 HTTP = "0.9"
 JSON = "0.21"
 URIs = "1"

docs/src/tutorial.md

@@ -10,7 +10,6 @@ Suppose that you are developing a method `getpricepath(α, n)` which generates a
 
 ```julia
 using Plots
-using MLFlowClient
 using Random
 
 αs = [0.0, 0.9, 0.98]
@@ -58,7 +57,7 @@ using Random
 αs = [0.0, 0.9, 0.98]
 n = 100
 
-"""Method that generates price paths of length `n` based on `α`"""
+"Method that generates price paths of length `n` based on `α`"
 function getpricepath(α, n)
     x = zeros(n + 1)
     x[1] = 0.0
@@ -70,7 +69,7 @@ end
 p = plot()
 
 # Create MLFlow instance
-mlf = MLFlow("http://localhost")
+mlf = MLFlow("http://localhost:5000")
 
 # Initiate new experiment
 experiment_id = createexperiment(mlf; name="price-paths")

examples/simple-with-mlflow.jl

@@ -18,7 +18,7 @@ end
 p = plot()
 
 # Create MLFlow instance
-mlf = MLFlow("http://localhost")
+mlf = MLFlow("http://localhost:5000")
 
 # Initiate new experiment
 experiment_id = createexperiment(mlf; name="price-paths")

examples/simple-without-mlflow.jl

@@ -1,5 +1,4 @@
 using Plots
-using MLFlowClient
 using Random
 
 αs = [0.0, 0.9, 0.98]

src/types.jl

@@ -4,13 +4,13 @@
 Base type which defines location and version for MLFlow API service.
 
 # Fields
-- `baseuri::String`: base MLFlow tracking URI, e.g. `http://localhost`
+- `baseuri::String`: base MLFlow tracking URI, e.g. `http://localhost:5000`
 - `apiversion`: used API version, e.g. `2.0`
 
 # Examples
 ``` julia-repl
-julia> mlf = MLFlow("http://localhost")
-MLFlow("http://localhost", 2.0)
+julia> mlf = MLFlow("http://localhost:5000")
+MLFlow("http://localhost:5000", 2.0)
 ```
 """
 struct MLFlow