Merge pull request #38 from stemann/feature/devcontainer

- Added dev. container
- Using `MLFLOW_TRACKING_URI` env variable to define the default URI

Author: pebeto

.devcontainer/compose.yaml

@@ -0,0 +1,14 @@
+version: '3'
+
+services:
+  project:
+    image: mcr.microsoft.com/devcontainers/base:debian
+    volumes:
+      - ../..:/workspaces:cached
+    command: sleep infinity # Overrides default command so things don't shut down after the process ends.
+
+  mlflow:
+    image: ghcr.io/mlflow/mlflow:v2.10.0
+    entrypoint: ["mlflow", "server", "--host", "0.0.0.0"]
+    ports:
+      - "5000"

.devcontainer/devcontainer.json

@@ -0,0 +1,14 @@
+{
+    "dockerComposeFile": "compose.yaml",
+    "service": "project",
+    "workspaceFolder": "/workspaces/${localWorkspaceFolderBasename}",
+    "features": {
+        "ghcr.io/julialang/devcontainer-features/julia:1": {
+            "channel": "release"
+        }
+    },
+    "containerEnv": {
+        "JULIA_PROJECT": "/workspaces/${localWorkspaceFolderBasename}",
+        "MLFLOW_TRACKING_URI": "http://mlflow:5000",
+    }
+}

.github/workflows/CI.yml

@@ -49,6 +49,8 @@ jobs:
             ${{ runner.os }}-
       - uses: julia-actions/julia-buildpkg@v1
       - uses: julia-actions/julia-runtest@v1
+        env:
+          MLFLOW_TRACKING_URI: "http://localhost:5000"
       - uses: julia-actions/julia-processcoverage@v1
       - uses: codecov/codecov-action@v2
         with:

src/types/mlflow.jl

@@ -11,7 +11,7 @@ Base type which defines location and version for MLFlow API service.
 # Constructors
 
 - `MLFlow(baseuri; apiversion=2.0,headers=Dict())`
-- `MLFlow()` - defaults to `MLFlow("http://localhost:5000")`
+- `MLFlow()` - defaults to `MLFlow(ENV["MLFLOW_TRACKING_URI"])` or `MLFlow("http://localhost:5000")`
 
 # Examples
 
@@ -31,5 +31,12 @@ struct MLFlow
     headers::Dict
 end
 MLFlow(baseuri; apiversion=2.0,headers=Dict()) = MLFlow(baseuri, apiversion,headers)
-MLFlow() = MLFlow("http://localhost:5000", 2.0, Dict())
+function MLFlow()
+    baseuri = "http://localhost:5000"
+    if haskey(ENV, "MLFLOW_TRACKING_URI")
+        baseuri = ENV["MLFLOW_TRACKING_URI"]
+    end
+    return MLFlow(baseuri)
+end
+
 Base.show(io::IO, t::MLFlow) = show(io, ShowCase(t, [:baseuri,:apiversion], new_lines=true))

test/base.jl

@@ -13,7 +13,7 @@ function mlflow_server_is_running(mlf::MLFlow)
 end
 
 # creates an instance of mlf
-# skips test if mlflow is not available on default location, http://localhost:5000
+# skips test if mlflow is not available on default location, ENV["MLFLOW_TRACKING_URI"]
 macro ensuremlf()
     e = quote
         mlf = MLFlow()

test/test_functional.jl

@@ -1,6 +1,6 @@
 @testset "MLFlow" begin
     mlf = MLFlow()
-    @test mlf.baseuri == "http://localhost:5000"
+    @test mlf.baseuri == ENV["MLFLOW_TRACKING_URI"]
     @test mlf.apiversion == 2.0
     @test mlf.headers == Dict()
     mlf = MLFlow("https://localhost:5001", apiversion=3.0)