start_run: Start Run

Description Usage Arguments

View source: R/runs.R

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, and additional arguments such as start_time can be provided.

Usage

1
2
3
4
5
6
7
8
start_run(
  run_id = NULL,
  experiment_id = NULL,
  start_time = NULL,
  tags = NULL,
  client = NULL,
  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.

start_time

Unix timestamp of when the run started in milliseconds. Only used when client is specified.

tags

Additional metadata for run in key-value pairs. Only used when client is specified.

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.


mrkaye97/lightMLFlow documentation built on Dec. 28, 2021, 12:15 a.m.