A comet experiment object can be used to modify or get information about an active
experiment. All methods documented here are the different ways to interact with an
experiment. Use create_experiment()
to create or get_experiment()
to
retrieve a Comet experiment object.
new()
Do not call this function directly. Use create_experiment()
or get_experiment()
instead.
Experiment$new( experiment_key, experiment_url = NULL, api_key = NULL, keep_active = FALSE, log_output = FALSE, log_error = FALSE, dynamic = TRUE )
get_key()
Get the experiment key of an experiment.
Experiment$get_key()
get_dynamic()
Get the dynamic status of an experiment.
Experiment$get_dynamic()
get_url()
Get the URL to view an experiment in the browser.
Experiment$get_url()
get_metadata()
Get an experiment's metadata.
Experiment$get_metadata()
archive()
Archive an experiment.
Experiment$archive()
restore()
Restore an archived experiment.
Experiment$restore()
delete()
Delete an experiment.
Experiment$delete()
stop()
Stop an experiment. Always call this method before creating a new experiment.
Experiment$stop()
log_metric()
Log a metric name and value. Metrics are the only items that are logged as a full time series. However, even metrics can be throttled if too much data (either by rate or by count) is attempted to be logged.
Experiment$log_metric(name, value, step = NULL, epoch = NULL, context = NULL)
name
(Required) Name of the metric.
value
(Required) Value of the metric.
step
Step number.
epoch
Epoch.
context
Context.
get_metric()
Get All Metrics For Name
Experiment$get_metric(name)
name
(Required) Name of metric.
get_metrics_summary()
Get an experiment's metrics summary.
Experiment$get_metrics_summary()
log_graph()
Log an experiment's associated model graph.
Experiment$log_graph(graph)
graph
(Required) JSON representation of a graph.
get_graph()
Get an experiment's model graph.
Experiment$get_graph()
log_parameter()
Log a parameter name and value. Note that you can only retrieve parameters summary data (e.g., this is not recorded as a full time series).
Experiment$log_parameter(name, value, step = NULL)
name
(Required) Name of the parameter.
value
(Required) Value of the parameter.
step
Step number.
get_parameters()
Get an experiment's parameters summary.
Experiment$get_parameters()
log_other()
Log a key/value 'other“ data (not a metric or parameter). Note that you can only retrieve others summary data (e.g., this is not recorded as a full time series).
Experiment$log_other(key, value)
key
(Required) The key.
value
(Required) The value.
get_other()
Get an experiment's others (logged with log_other()
) summary.
Experiment$get_other()
add_tags()
Add a list of tags to an experiment.
Experiment$add_tags(tags)
tags
(Required) List of tags.
get_tags()
Get an experiment's tags.
Experiment$get_tags()
log_html()
Set (or append onto) an experiment's HTML.
Experiment$log_html(html, override = FALSE)
html
(Required) An HTML string to add to the experiment.
override
If TRUE
, override the previous HTML. If FALSE
, append to it.
get_html()
Get an experiment's HTML.
Experiment$get_html()
upload_asset()
Upload a file to the experiment.
Experiment$upload_asset( file, step = NULL, overwrite = NULL, context = NULL, type = NULL, name = NULL, metadata = NULL )
file
(Required) Path to the file to upload.
step
Step number.
overwrite
If TRUE
, overwrite any uploaded file with the same name.
context
The context.
type
The type of asset.
name
Name of the file on comet. By default the name of the file will match the file that you upload, but you can use this parameter to use a different name.
metadata
Metadata to upload along with the file.
get_asset_list()
Get an experiment's asset list.
Experiment$get_asset_list(type = NULL)
type
The type of assets to retrieve (by default, all assets are returned).
get_asset()
Get an asset.
Experiment$get_asset(assetId)
assetId
(Required) The asset ID to retrieve.
create_symlink()
Add a symlink to an experiment in another project.
Experiment$create_symlink(project_name)
project_name
(Required) Project that the experiment to should linked to.
log_git_metadata()
Log an experiment's git metadata. This should only be called once and it can be done
automatically by enabling log_git_info
in create_experiment()
or get_experiment()
.
This will replace any previous git metadata that was logged.
Experiment$log_git_metadata( branch = NULL, origin = NULL, parent = NULL, user = NULL, root = NULL )
branch
Git branch name.
origin
Git repository origin.
parent
Git commit SHA.
user
Git username.
root
Git root.
get_git_metadata()
Get the git metadata of an experiment.
Experiment$get_git_metadata()
get_git_patch()
Get the git patch of an experiment.
Experiment$get_git_patch()
get_output()
Get an experiment's standard output and error.
Experiment$get_output()
log_code()
Log an experiment's source code. This should only be called once and it can be done
automatically by enabling log_code
in create_experiment()
or get_experiment()
.
This will replace any previous code that was logged.
Experiment$log_code(code)
code
The code to set as the source code.
get_code()
Get an experiment's source code.
Experiment$get_code()
log_system_details()
Log system details. This can be done automatically by enabling log_system_details
in create_experiment()
or get_experiment()
.
Experiment$log_system_details( command = NULL, executable = NULL, hostname = NULL, installed_packages = NULL, gpu_static_info = NULL, ip = NULL, network_interface_ips = NULL, additional_system_info = NULL, os = NULL, os_packages = NULL, os_type = NULL, pid = NULL, user = NULL, r_version = NULL, r_version_verbose = NULL )
command
Script and optional arguments.
executable
Executable.
hostname
Hostname.
installed_packages
List of installed R packages.
gpu_static_info
List of GPU information, where each GPU is a list()
with
fields gpuIndex
, name
, powerLimit
, totalMemory
, uuid
.
ip
IP address.
network_interface_ips
List of network interface IPs.
additional_system_info
List of additional parameters to log,
where each parameter is a list()
with key
and value
pairs.
os
Full details about operating system.
os_packages
List of operating system packages installed.
os_type
Operating system type.
pid
Process ID.
user
User.
r_version
Short form R version.
r_version_verbose
Long form R version.
get_system_details()
Get an experiment's system details.
Experiment$get_system_details()
set_start_end_time()
Set an experiment's start and end time.
Experiment$set_start_end_time(start = NULL, end = NULL)
start
Start time for the experiment (milliseconds since the Epoch)
end
End time for the experiment (milliseconds since the Epoch)
print()
Print the experiment.
Experiment$print()
1 2 3 4 5 6 7 8 9 10 11 12 13 14 | ## Not run:
library(cometr)
# Assuming you have COMET_API_KEY, COMET_WORKSPACE, COMET_PROJECT_NAME variables define
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()
## End(Not run)
|
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.