Implementing logmodel function

Author: pebeto

.github/workflows/CI.yml

@@ -26,7 +26,7 @@ jobs:
         if: hashFiles('**/requirements.txt', '**/pyproject.toml') == ''
         run: |
           touch ./requirements.txt
-          echo "mlflow==3.1.2" > ./requirements.txt
+          echo "mlflow[auth]==3.1.2" > ./requirements.txt
       - uses: actions/setup-python@v4
         with:
           python-version: '3.12.3'

src/MLFlowClient.jl

@@ -65,7 +65,7 @@ export getrun, createrun, deleterun, setruntag, updaterun, restorerun, searchrun
     deleteruntag
 
 include("services/logger.jl")
-export logbatch, loginputs, logmetric, logparam
+export logbatch, loginputs, logmetric, logmodel, logparam
 
 include("services/artifact.jl")
 export listartifacts

src/services/logger.jl

@@ -57,8 +57,9 @@ For more information about this function, check [MLFlow official documentation](
 - `params`: A collection of [`Param`](@ref) to log.
 - `tags`: A collection of [`Tag`](@ref) to log.
 
-**Note**: A single request can contain up to 1000 metrics, and up to 1000 metrics, params,
-and tags in total.
+!!! note
+    A single request can contain up to 1000 metrics, and up to 1000 metrics, params, and
+    tags in total.
 
 # Returns
 `true` if successful. Otherwise, raises exception.
@@ -123,3 +124,18 @@ logparam(instance::MLFlow, run_id::String, param::Param)::Bool =
     logparam(instance, run_id, param.key, param.value)
 logparam(instance::MLFlow, run::Run, param::Param)::Bool =
     logparam(instance, run.info.run_id, param.key, param.value)
+
+"""
+    logmodel(instance::MLFlow, run_id::String, model_json::String)
+
+# Arguments
+- `instance`: [`MLFlow`](@ref) configuration.
+- `run_id`: ID of the [`Run`](@ref) to log under.
+- `model_json`: MLmodel file in json format.
+"""
+function logmodel(instance::MLFlow, run_id::String, model_json::String)::Bool
+    mlfpost(instance, "runs/log-model"; run_id=run_id, model_json=model_json)
+    return true
+end
+logmodel(instance::MLFlow, run::Run, model_json::String)::Bool =
+    logmodel(instance, run.info.run_id, model_json)

test/services/logger.jl

@@ -298,3 +298,40 @@ end
 
     deleteexperiment(mlf, experiment_id)
 end
+
+@testset verbose = true "log model" begin
+    @ensuremlf
+
+    experiment_id = createexperiment(mlf, UUIDs.uuid4() |> string)
+    mlmodel_json_string = """
+    {
+        "time_created": "2018-05-25T17:28:53.35",
+        "flavors": {
+            "sklearn": {
+                "sklearn_version": "0.19.1",
+                "pickled_model": "model.pkl"
+            },
+            "python_function": {
+                "loader_module": "mlflow.sklearn"
+            }
+        },
+        "utc_time_created": "2025-08-16T16:50:00.00Z",
+        "artifact_path": "mlflowclientjl-test",
+        "run_id": "<RUN_ID>"
+    }
+    """
+
+    @testset "with run id as string" begin
+        run = createrun(mlf, experiment_id)
+        @assert logmodel(mlf, run.info.run_id, replace(mlmodel_json_string, "<RUN_ID>" => run.info.run_id))
+        deleterun(mlf, run)
+    end
+
+    @testset "with run" begin
+        run = createrun(mlf, experiment_id)
+        @assert logmodel(mlf, run, replace(mlmodel_json_string, "<RUN_ID>" => run.info.run_id))
+        deleterun(mlf, run)
+    end
+
+    deleteexperiment(mlf, experiment_id)
+end