ml.comet.experiment.artifact

Interface Artifact

All Known Subinterfaces:

DownloadedArtifact

All Known Implementing Classes:

ArtifactImpl, DownloadedArtifactImpl

public interface Artifact

Defines the public contract of the Comet Artifact.

Comet Artifacts allow keeping track of assets beyond any particular experiment. You can keep track of Artifact versions, create many types of assets, manage them, and use them in any step in your ML pipelines - from training to production deployment.

Artifacts live in a Comet Project, are identified by their name and version string number.

Method Summary

Modifier and Type	Method and Description
void	addAsset(byte[] data, String logicalPath)
void	addAsset(byte[] data, String logicalPath, boolean overwrite)
void	addAsset(byte[] data, String logicalPath, boolean overwrite, Map<String,Object> metadata) Adds a local asset data to the current pending artifact object.
void	addAsset(File file, boolean overwrite)
void	addAsset(File file, boolean overwrite, Map<String,Object> metadata)
void	addAsset(File file, String logicalPath, boolean overwrite)
void	addAsset(File file, String logicalPath, boolean overwrite, Map<String,Object> metadata) Adds a local asset file to the current pending artifact object.
void	addAssetFolder(File folder)
void	addAssetFolder(File folder, boolean logFilePath)
void	addAssetFolder(File folder, boolean logFilePath, boolean recursive)
void	addAssetFolder(File folder, boolean logFilePath, boolean recursive, Map<String,Object> metadata) Adds all asset files located in the given folder to this artifact.
void	addRemoteAsset(URI uri, String logicalPath)
void	addRemoteAsset(URI uri, String logicalPath, boolean overwrite)
void	addRemoteAsset(URI uri, String logicalPath, boolean overwrite, Map<String,Object> metadata) Adds remote asses to the current pending artifact object.
Collection<ArtifactAsset>	getAssets() Returns assets associated with this artifact.
static ArtifactBuilder	newArtifact(@NonNull String name, @NonNull String type) Creates new ArtifactBuilder instance which can be used to create properly initialized instances of the Artifact.

Method Detail

addAsset

void addAsset(File file,
              String logicalPath,
              boolean overwrite,
              Map<String,Object> metadata)
       throws ConflictingArtifactAssetNameException

Adds a local asset file to the current pending artifact object.

Parameters:

file - the path to the file asset.

logicalPath - the custom asset's file name to be displayed. If not provided the filename from the file argument will be used.

overwrite - if true will overwrite all existing assets with the same name.

metadata - Some additional data to attach to the asset. Must be a map with JSON-encodable values.

Throws:

ConflictingArtifactAssetNameException - is name of the asset is not unique within this artifact.

addAsset

void addAsset(File file,
              boolean overwrite,
              Map<String,Object> metadata)
       throws ConflictingArtifactAssetNameException

Throws:

ConflictingArtifactAssetNameException

addAsset

void addAsset(File file,
              String logicalPath,
              boolean overwrite)
       throws ConflictingArtifactAssetNameException

Throws:

ConflictingArtifactAssetNameException

addAsset

void addAsset(File file,
              boolean overwrite)
       throws ConflictingArtifactAssetNameException

Throws:

ConflictingArtifactAssetNameException

addAsset

void addAsset(byte[] data,
              String logicalPath,
              boolean overwrite,
              Map<String,Object> metadata)
       throws ConflictingArtifactAssetNameException

Adds a local asset data to the current pending artifact object.

Parameters:

data - the data of the asset.

logicalPath - the custom asset's file name to be displayed.

overwrite - if true will overwrite all existing assets with the same name.

metadata - some additional data to attach to the asset. Must be a map with JSON-encodable values.

Throws:

ConflictingArtifactAssetNameException - is name of the asset is not unique within this artifact.

addAsset

void addAsset(byte[] data,
              String logicalPath,
              boolean overwrite)
       throws ConflictingArtifactAssetNameException

Throws:

ConflictingArtifactAssetNameException

addAsset

void addAsset(byte[] data,
              String logicalPath)
       throws ConflictingArtifactAssetNameException

Throws:

ConflictingArtifactAssetNameException

addRemoteAsset

void addRemoteAsset(URI uri,
                    String logicalPath,
                    boolean overwrite,
                    Map<String,Object> metadata)
             throws ConflictingArtifactAssetNameException

Adds remote asses to the current pending artifact object. A Remote Asset is an asset but its content is not uploaded and stored on Comet. Rather a link for its location is stored, so you can identify and distinguish between two experiment using different version of a dataset stored somewhere else.

Parameters:

uri - the URI pointing to the location of the remote asset.

logicalPath - the "name" of the remote asset, could be a dataset name, a model file name.

overwrite - if true will overwrite all existing assets with the same name.

metadata - some additional data to attach to the asset. Must be a map with JSON-encodable values.

Throws:

ConflictingArtifactAssetNameException - is name of the asset is not unique within this artifact.

addRemoteAsset

void addRemoteAsset(URI uri,
                    String logicalPath,
                    boolean overwrite)
             throws ConflictingArtifactAssetNameException

Throws:

ConflictingArtifactAssetNameException

addRemoteAsset

void addRemoteAsset(URI uri,
                    String logicalPath)
             throws ConflictingArtifactAssetNameException

Throws:

ConflictingArtifactAssetNameException

addAssetFolder

void addAssetFolder(File folder,
                    boolean logFilePath,
                    boolean recursive,
                    Map<String,Object> metadata)
             throws ConflictingArtifactAssetNameException,
                    IOException

Adds all asset files located in the given folder to this artifact.

Parameters:

folder - the folder you want to log.

logFilePath - if true, logs the relative file path of each file.

recursive - if true, recurse the folder.

metadata - some additional data to attach to the asset. Must be a map with JSON-encodable values.

Throws:

ConflictingArtifactAssetNameException - is name of some asset is not unique within this artifact.

IOException - if an I/O exception occurred when walking through the folder.

addAssetFolder

void addAssetFolder(File folder,
                    boolean logFilePath,
                    boolean recursive)
             throws ConflictingArtifactAssetNameException,
                    IOException

Throws:

ConflictingArtifactAssetNameException

IOException

addAssetFolder

void addAssetFolder(File folder,
                    boolean logFilePath)
             throws ConflictingArtifactAssetNameException,
                    IOException

Throws:

ConflictingArtifactAssetNameException

IOException

addAssetFolder

void addAssetFolder(File folder)
             throws ConflictingArtifactAssetNameException,
                    IOException

Throws:

ConflictingArtifactAssetNameException

IOException

getAssets

Collection<ArtifactAsset> getAssets()

Returns assets associated with this artifact.

Returns:

the assets associated with this artifact.

newArtifact

static ArtifactBuilder newArtifact(@NonNull
                                   @NonNull String name,
                                   @NonNull
                                   @NonNull String type)

Creates new ArtifactBuilder instance which can be used to create properly initialized instances of the Artifact.

Parameters:

name - the name of the artifact.

type - the type of the artifact. Typical artifact types could be "dataset", "image", "training-data", "validation-data", "testing-data", etc.

Returns:

the ArtifactBuilder instance to create properly initialized instances of the Artifact.