cometr (version 0.4.0)

create_artifact: Create Comet Artifact object

Description

Creates new Artifact object with provided parameters. After that, the Artifact object can be used to save assets and can be logged with an Experiment.

Usage

create_artifact(
  artifact_name,
  artifact_type,
  artifact_version = NULL,
  aliases = NULL,
  metadata = NULL,
  version_tags = NULL
)

Arguments

artifact_name

(Required) Artifact name.

artifact_type

(Required) The artifact type, for example 'dataset'.

artifact_version

The version number to create. If not provided, a new version number will be created automatically.

aliases

List of aliases. Some aliases to attach to the future Artifact Version. The aliases list is normalized to remove duplicates.

metadata

Some additional meta-data to attach to the future Artifact Version.

version_tags

List of tags to be attached to the future Artifact Version.

Examples

if (FALSE) {
library(cometr)
# Assuming you have COMET_API_KEY, COMET_WORKSPACE, COMET_PROJECT_NAME variables define
exp <- create_experiment()

# Create a Comet Artifact
artifact <- create_artifact(artifact_name = "Artifact-Name", artifact_type = "Artifact-Type")
artifact$add("local-file")

exp$log_artifact(artifact)
exp$stop()
}