mlflow (version 0.9.0.1)

mlflow_start_run: Start Run

Description

Starts a new run within an experiment, should be used within a with block.

Usage

mlflow_start_run(run_uuid = NULL, experiment_id = NULL,
  source_name = NULL, source_version = NULL, entry_point_name = NULL,
  source_type = "LOCAL")

Arguments

run_uuid

If specified, get the run with the specified UUID and log metrics and params under that run. The run's end time is unset and its status is set to running, but the run's other attributes remain unchanged.

experiment_id

Used only when `run_uuid` is unspecified. ID of the experiment under which to create the current run. If unspecified, the run is created under a new experiment with a randomly generated name.

source_name

Name of the source file or URI of the project to be associated with the run. Defaults to the current file if none provided.

source_version

Optional Git commit hash to associate with the run.

entry_point_name

Optional name of the entry point for to the current run.

source_type

Integer enum value describing the type of the run ("local", "project", etc.).

Details

The fluent API family of functions operate with an implied MLflow client determined by the service set by `mlflow_set_tracking_uri()`. For operations involving a run it adopts the current active run, or, if one does not exist, starts one through the implied service.

Examples

# NOT RUN {
with(mlflow_start_run(), {
  mlflow_log("test", 10)
})
# }
# NOT RUN {
# }