ArtifactAsset: An Artifact Asset object

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

An Artifact Asset object

Description

The ArtifactAsset represent local or remote asset added to an Artifact object but not yet uploaded

Methods

Public methods

• ArtifactAsset$new()

• ArtifactAsset$get_local_path()

• ArtifactAsset$get_logical_path()

• ArtifactAsset$is_remote()

• ArtifactAsset$has_overwrite()

• ArtifactAsset$get_size()

• ArtifactAsset$get_link()

• ArtifactAsset$get_metadata()

• ArtifactAsset$get_asset_type()

---

Method new()

Creates a new ArtifactAsset object with provided parameters.

Usage

ArtifactAsset$new(
  logical_path,
  overwrite = FALSE,
  remote = FALSE,
  size = 0,
  link = NULL,
  local_path = NULL,
  metadata = NULL,
  asset_type = NULL
)

Arguments

logical_path

the logical file name.

overwrite

If TRUE will overwrite all existing assets with the same name.

remote

Is the asset a remote asset or not.

size

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

link

The remote link if the asset is remote.

local_path

The local file path if the asset is non-remote.

metadata

The metadata to be associated with the asset.

asset_type

The type of asset.

---

Method get_local_path()

Asset local path if the asset is non-remote

Usage

ArtifactAsset$get_local_path()

---

Method get_logical_path()

Asset logical file name

Usage

ArtifactAsset$get_logical_path()

---

Method is_remote()

Is the asset a remote asset or not

Usage

ArtifactAsset$is_remote()

---

Method has_overwrite()

Is the asset will overwrite existing asset with the same name.

Usage

ArtifactAsset$has_overwrite()

---

Method get_size()

Asset size if the asset is a non-remote asset

Usage

ArtifactAsset$get_size()

---

Method get_link()

Asset remote link if the asset is remote or NULL

Usage

ArtifactAsset$get_link()

---

Method get_metadata()

Asset metadata

Usage

ArtifactAsset$get_metadata()

---

Method get_asset_type()

Asset type

Usage

ArtifactAsset$get_asset_type()

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