[R] Fix search runs bug & add test (mlflow#1310)

Fixes bugs in mlflow_search_run and mlflow_list_run_infos within the R API, and adds a test verifying their correctness.

docs/source/R-api.rst

@@ -471,7 +471,7 @@ the supported MLflow models.
 
 .. code:: r
 
-   mlflow_load_flavor(model_path)
+   mlflow_load_flavor(flavor, model_path)
 
 .. _arguments-13:
 
@@ -481,6 +481,8 @@ Arguments
 +----------------+------------------------------------------------------------+
 | Argument       | Description                                                |
 +================+============================================================+
+| ``flavor``     | An MLflow flavor object.                                   |
++----------------+------------------------------------------------------------+
 | ``model_path`` | The path to the MLflow model wrapped in the correct class. |
 +----------------+------------------------------------------------------------+
 
@@ -926,7 +928,7 @@ Serves an RFunc MLflow model as a local web API.
 .. code:: r
 
    mlflow_rfunc_serve(model_uri, host = "127.0.0.1", port = 8090,
-     daemonized = FALSE, browse = !daemonized)
+     daemonized = FALSE, browse = !daemonized, ...)
 
 .. _arguments-25:
 
@@ -956,6 +958,9 @@ Arguments
 | ``browse``                    | Launch browser with serving landing  |
 |                               | page?                                |
 +-------------------------------+--------------------------------------+
+| ``...``                       | Optional arguments passed to         |
+|                               | ``mlflow_predict()``.                |
++-------------------------------+--------------------------------------+
 
 .. _details-20:
 
@@ -1117,8 +1122,9 @@ Arguments
 +-------------------------------+--------------------------------------+
 | ``run_view_type``             | Run view type.                       |
 +-------------------------------+--------------------------------------+
-| ``experiment_ids``            | List of experiment IDs to search     |
-|                               | over. Attempts to use active         |
+| ``experiment_ids``            | List of string experiment IDs (or a  |
+|                               | single string experiment ID) to      |
+|                               | search over. Attempts to use active  |
 |                               | experiment if not specified.         |
 +-------------------------------+--------------------------------------+
 | ``client``                    | (Optional) An ``mlflow_client``      |
@@ -1346,7 +1352,7 @@ Examples
 
 .. code:: r
 
-    list("\n", "with(mlflow_start_run(), {\n", "  mlflow_log(\"test\", 10)\n", "})\n") 
+    list("\n", "with(mlflow_start_run(), {\n", "  mlflow_log_metric(\"test\", 10)\n", "})\n") 
     
 
 Run MLflow User Interface

mlflow/R/mlflow/DESCRIPTION

@@ -24,6 +24,7 @@ Depends:
   R (>= 3.3.0)
 Imports:
   base64enc,
+  dplyr,
   forge,
   fs,
   git2r,

mlflow/R/mlflow/R/tracking-runs.R

@@ -246,7 +246,8 @@ mlflow_get_metric_history <- function(metric_key, run_id = NULL, client = NULL)
 #' Search for runs that satisfy expressions. Search expressions can use Metric and Param keys.
 #'
 #' @template roxlate-client
-#' @param experiment_ids List of experiment IDs to search over. Attempts to use active experiment if not specified.
+#' @param experiment_ids List of string experiment IDs (or a single string experiment ID) to search
+#' over. Attempts to use active experiment if not specified.
 #' @param filter A filter expression over params, metrics, and tags, allowing returning a subset of runs.
 #'   The syntax is a subset of SQL which allows only ANDing together binary operations between a param/metric/tag and a constant.
 #' @param run_view_type Run view type.
@@ -256,10 +257,14 @@ mlflow_search_runs <- function(filter = NULL,
                                run_view_type = c("ACTIVE_ONLY", "DELETED_ONLY", "ALL"), experiment_ids = NULL,
                                client = NULL) {
   experiment_ids <- resolve_experiment_id(experiment_ids)
+  # If we get back a single experiment ID, e.g. the active experiment ID, convert it to a list
+  if (is.atomic(experiment_ids)) {
+    experiment_ids <- list(experiment_ids)
+  }
   client <- resolve_client(client)
 
   run_view_type <- match.arg(run_view_type)
-  experiment_ids <- cast_double_list(experiment_ids)
+  experiment_ids <- cast_string_list(experiment_ids)
   filter <- cast_nullable_string(filter)
 
   response <- mlflow_rest("runs", "search", client = client, verb = "POST", data = list(
@@ -465,7 +470,7 @@ mlflow_log_artifact <- function(path, artifact_path = NULL, run_id = NULL, clien
 #' @examples
 #' \dontrun{
 #' with(mlflow_start_run(), {
-#'   mlflow_log("test", 10)
+#'   mlflow_log_metric("test", 10)
 #' })
 #' }
 #'

mlflow/R/mlflow/tests/testthat/test-tracking-runs.R

@@ -228,6 +228,42 @@ test_that("with() errors when not passed active run", {
   )
 })
 
+test_that("mlflow_search_runs() works", {
+  mlflow_clear_test_dir("mlruns")
+  with(mlflow_start_run(), {
+    mlflow_log_metric("test", 10)
+  })
+  with(mlflow_start_run(), {
+    mlflow_log_metric("test", 20)
+  })
+  expect_equal(nrow(mlflow_search_runs(experiment_ids = list("0"))), 2)
+  expect_equal(nrow(mlflow_search_runs(experiment_ids = "0")), 2)
+  expect_equal(nrow(mlflow_search_runs(filter = "metrics.test > 10", experiment_ids = list("0"))), 1)
+  expect_equal(nrow(mlflow_search_runs(filter = "metrics.test < 20", experiment_ids = list("0"))), 1)
+  expect_equal(nrow(mlflow_search_runs(filter = "metrics.test > 20", experiment_ids = list("0"))), 0)
+  mlflow_set_experiment("new-experiment")
+  expect_equal(nrow(mlflow_search_runs()), 0)
+  with(mlflow_start_run(), {
+    mlflow_log_metric("new_experiment_metric", 30)
+  })
+  expect_equal(nrow(mlflow_search_runs(filter = "metrics.new_experiment_metric = 30")), 1)
+})
+
+test_that("mlflow_list_run_infos() works", {
+  mlflow_clear_test_dir("mlruns")
+  expect_equal(nrow(mlflow_list_run_infos(experiment_id = "0")), 0)
+  with(mlflow_start_run(), {
+    mlflow_log_metric("test", 10)
+  })
+  expect_equal(nrow(mlflow_list_run_infos(experiment_id = "0")), 1)
+  mlflow_set_experiment("new-experiment")
+  expect_equal(nrow(mlflow_list_run_infos()), 0)
+  with(mlflow_start_run(), {
+    mlflow_log_metric("new_experiment_metric", 20)
+  })
+  expect_equal(nrow(mlflow_list_run_infos()), 1)
+})
+
 test_that("mlflow_log_batch() works", {
   mlflow_clear_test_dir("mlruns")
   mlflow_start_run()