start_run: Start Run

In collegevine/lightMLFlow: A Lightweight, Opinionated R Wrapper for the 'MLFlow' REST API

Start Run

Description

Starts a new run. If client is not provided, this function infers contextual information such as source name and version, and also registers the created run as the active run. If client is provided, no inference is done.

Usage

start_run(
  run_id = Sys.getenv("MLFLOW_RUN_ID"),
  experiment_id = get_active_experiment_id(),
  client = mlflow_client(),
  nested = FALSE
)

Arguments

run_id	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_id 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.
client	An MLFlow client. Defaults to NULL and will be auto-generated.
nested	Controls whether the run to be started is nested in a parent run. TRUE creates a nest run.

Value

Metadata on the newly-started run.

collegevine/lightMLFlow documentation built on Jan. 16, 2024, 5:52 a.m.