cometr (version 0.4.0)

create_experiment: Create a new experiment

Description

Create a new experiment on Comet's servers. The return value is an Experiment object that can be used to modify or get information about the experiment. Only one experiment can be active at a time, so make sure to stop an experiment before creating a new one (by calling the stop() method on the Experiment object).

Usage

create_experiment(
  experiment_name = NULL,
  project_name = NULL,
  workspace_name = NULL,
  api_key = NULL,
  keep_active = TRUE,
  log_output = TRUE,
  log_error = FALSE,
  log_code = TRUE,
  log_system_details = TRUE,
  log_git_info = FALSE
)

Value

An Experiment object.

Arguments

experiment_name

Experiment name.

project_name

Project name (can also be specified using the COMET_PROJECT_NAME parameter as an environment variable or in a comet config file).

workspace_name

Workspace name (can also be specified using the COMET_WORKSPACE parameter as an environment variable or in a comet config file).

api_key

Comet API key (can also be specified using the COMET_API_KEY parameter as an environment variable or in a comet config file).

keep_active

If TRUE, automatically send Comet a status update every few seconds until the experiment is stopped to mark the experiment as active on the Comet web dashboard.

log_output

If TRUE, all standard output will automatically be sent to the Comet servers to display as message logs for the experiment. The output will still be shown in the console as well.

log_error

If TRUE, all output from 'stderr' (which includes errors, warnings, and messages) will be redirected to the Comet servers to display as message logs for the experiment. Note that unlike auto_log_output, if this option is on then these messages will not be shown in the console and instead they will only be logged to the Comet experiment. This option is set to FALSE by default because of this behavior.

log_code

If TRUE, log the source code of the R script that was called to Comet as the associated code of this experiment. This only works if the you run a script using the Rscript tool and will not work in interactive sessions.

log_system_details

If TRUE, automatically log the system details to Comet when the experiment is created.

log_git_info

If TRUE, log information about the active git repository. Requires the git2r package to be installed.

Examples

if (FALSE) {
library(cometr)
# Assuming you have COMET_API_KEY, COMET_WORKSPACE, COMET_PROJECT_NAME variables defined
exp <- create_experiment()
exp$get_key()
exp$get_metadata()
exp$add_tags(c("test", "tag2"))
exp$get_tags()
exp$log_metric("metric1", 5)
exp$get_metric("metric1")
exp$get_metrics_summary()
exp$stop()
}