LoggedArtifactAsset: An Artifact Asset object that was already logged.

In comet-ml/cometr: 'Comet' API for R

An Artifact Asset object that was already logged.

Description

The LoggedArtifactAsset represent local or remote asset already logged with particular Artifact to the Comet.

Super class

cometr::ArtifactAsset -> LoggedArtifactAsset

Methods

Public methods

• LoggedArtifactAsset$new()

• LoggedArtifactAsset$get_id()

• LoggedArtifactAsset$get_artifact_version_id()

• LoggedArtifactAsset$get_artifact_id()

• LoggedArtifactAsset$download()

Inherited methods

• cometr::ArtifactAsset$get_asset_type()
• cometr::ArtifactAsset$get_link()
• cometr::ArtifactAsset$get_local_path()
• cometr::ArtifactAsset$get_logical_path()
• cometr::ArtifactAsset$get_metadata()
• cometr::ArtifactAsset$get_size()
• cometr::ArtifactAsset$has_overwrite()
• cometr::ArtifactAsset$is_remote()

---

Method new()

Creates a new LoggedArtifactAsset object with provided parameters.

Usage

LoggedArtifactAsset$new(
  logical_path,
  remote,
  size,
  metadata,
  asset_type,
  id,
  artifact_version_id,
  artifact_id,
  experiment_key,
  link = NULL
)

Arguments

logical_path

the logical file name.

remote

Is the asset a remote asset or not.

size

The size if the asset of a non-remote asset.

metadata

The metadata to be associated with the asset.

asset_type

The type of asset.

id

The ID of the asset

artifact_version_id

The ID of Artifact Version associated with this asset.

artifact_id

The ID of Artifact associated with this asset.

experiment_key

The experiment key of the experiment that logged this asset.

link

The remote link if the asset is remote.

---

Method get_id()

Asset unique ID

Usage

LoggedArtifactAsset$get_id()

---

Method get_artifact_version_id()

The ID of Artifact Version associated with this asset

Usage

LoggedArtifactAsset$get_artifact_version_id()

---

Method get_artifact_id()

The ID of Artifact associated with this asset

Usage

LoggedArtifactAsset$get_artifact_id()

---

Method download()

Download the asset to a given full path or directory.

Usage

LoggedArtifactAsset$download(
  local_path = NULL,
  logical_path = NULL,
  overwrite_strategy = FALSE
)

Arguments

local_path

The root folder to which to download. If NULL, will download to a tmp path, otherwise will be either a root local path or a full local path.

logical_path

The path relative to the root local_path to use If NULL and local_path==NULL then no relative path is used, file would just be a tmp path on local disk. If NULL and local_path!=NULL then the local_path will be treated as a root path, and the asset's logical_path will be appended to the root path to form a full local path.

overwrite_strategy

can be FALSE, "FAIL", "PRESERVE" or "OVERWRITE" and follows the same semantics for overwrite strategy as artifact.download()

Returns

ArtifactAsset holding information about downloaded asset data file.

comet-ml/cometr documentation built on Oct. 23, 2023, 7:44 a.m.