set_experiment_run: set_experiment_run

Description Usage Arguments Details name desc tags attrs id

View source: R/client_api_scaffold.R

Description

Attaches an Experiment Run under the currently active Experiment to this Client.

Usage

1
2
3
4
5
6
7
8
set_experiment_run(
  name = NULL,
  desc = NULL,
  tags = NULL,
  attrs = NULL,
  id = NULL,
  date_created = NULL
)

Arguments

name

name

desc

desc

tags

tags

attrs

attrs

id

id

date_created

date_created

Details

If an accessible Experiment Run with name 'name' does not already exist under the currently active Experiment, it will be created and initialized with specified metadata parameters. If such a Experiment Run does already exist, it will be retrieved; specifying metadata parameters in this case will raise a warning. Parameters ———- name : str, optional Name of the Experiment Run. If no name is provided, one will be generated. desc : str, optional Description of the Experiment Run. tags : list of str, optional Tags of the Experiment Run. attrs : dict of str to NULL, bool, float, int, str, optional Attributes of the Experiment Run. id : str, optional ID of the Experiment Run. This parameter cannot be provided alongside 'name', and other parameters will be ignored. Returns ——- :class:'verta.tracking.entities.ExperimentRun' Raises —— ValueError If an Experiment Run with 'name' already exists, but metadata parameters are passed in. AttributeError If an Experiment is not yet in progress.

name

str, optional: Name of the Experiment Run. If no name is provided, one will be generated. desc : str, optional Description of the Experiment Run. tags : list of str, optional Tags of the Experiment Run. attrs : dict of str to NULL, bool, float, int, str, optional Attributes of the Experiment Run. id : str, optional ID of the Experiment Run. This parameter cannot be provided alongside 'name', and other parameters will be ignored.

desc

str, optional: Description of the Experiment Run. tags : list of str, optional Tags of the Experiment Run. attrs : dict of str to NULL, bool, float, int, str, optional Attributes of the Experiment Run. id : str, optional ID of the Experiment Run. This parameter cannot be provided alongside 'name', and other parameters will be ignored.

tags

list of str, optional: Tags of the Experiment Run. attrs : dict of str to NULL, bool, float, int, str, optional Attributes of the Experiment Run. id : str, optional ID of the Experiment Run. This parameter cannot be provided alongside 'name', and other parameters will be ignored.

attrs

dict of str to None, bool, float, int, str, optional: Attributes of the Experiment Run. id : str, optional ID of the Experiment Run. This parameter cannot be provided alongside 'name', and other parameters will be ignored.

id

str, optional: ID of the Experiment Run. This parameter cannot be provided alongside 'name', and other parameters will be ignored.


botchkoAI/vertaReticulateClient documentation built on Dec. 19, 2021, 10:50 a.m.