ml.comet.experiment.impl

Class ArtifactImpl

java.lang.Object

ml.comet.experiment.impl.ArtifactImpl

All Implemented Interfaces:

Artifact

Direct Known Subclasses:

DownloadedArtifactImpl

public class ArtifactImpl
extends Object
implements Artifact

The implementation of the Artifact.

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, @NonNull Map<String,Object> metadata) Adds a local asset data to the current pending artifact object.
void	addAsset(@NonNull File file, boolean overwrite)
void	addAsset(@NonNull File file, boolean overwrite, @NonNull Map<String,Object> metadata)
void	addAsset(File file, String logicalPath, boolean overwrite)
void	addAsset(@NonNull File file, @NonNull String logicalPath, boolean overwrite, Map<String,Object> metadata) Adds a local asset file to the current pending artifact object.
void	addAssetFolder(@NonNull File folder)
void	addAssetFolder(@NonNull File folder, boolean logFilePath)
void	addAssetFolder(@NonNull File folder, boolean logFilePath, boolean recursive)
void	addAssetFolder(@NonNull File folder, boolean logFilePath, boolean recursive, @NonNull Map<String,Object> metadata) Adds all asset files located in the given folder to this artifact.
void	addRemoteAsset(@NonNull URI uri, @NonNull String logicalPath)
void	addRemoteAsset(@NonNull URI uri, @NonNull String logicalPath, boolean overwrite)
void	addRemoteAsset(@NonNull URI uri, @NonNull String logicalPath, boolean overwrite, @NonNull Map<String,Object> metadata) Adds remote asses to the current pending artifact object.
static ArtifactBuilder	builder(@NonNull String name, @NonNull String type) Returns ArtifactBuilder instance which can be used to create Artifact instances.
Set<String>	getAliases()
Collection<ArtifactAsset>	getAssets() Returns assets associated with this artifact.
Map<String,Object>	getMetadata()
Set<String>	getVersionTags()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface ml.comet.experiment.artifact.Artifact

newArtifact

Method Detail

getAssets

public Collection<ArtifactAsset> getAssets()

Description copied from interface: Artifact

Returns assets associated with this artifact.

Specified by:

getAssets in interface Artifact

Returns:

the assets associated with this artifact.

addAsset

public void addAsset(@NonNull
                     @NonNull File file,
                     @NonNull
                     @NonNull String logicalPath,
                     boolean overwrite,
                     Map<String,Object> metadata)

Description copied from interface: Artifact

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

Specified by:

addAsset in interface Artifact

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.

addAsset

public void addAsset(@NonNull
                     @NonNull File file,
                     boolean overwrite,
                     @NonNull
                     @NonNull Map<String,Object> metadata)

Specified by:

addAsset in interface Artifact

addAsset

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

Specified by:

addAsset in interface Artifact

Throws:

ConflictingArtifactAssetNameException

addAsset

public void addAsset(@NonNull
                     @NonNull File file,
                     boolean overwrite)

Specified by:

addAsset in interface Artifact

addAsset

public void addAsset(byte[] data,
                     String logicalPath,
                     boolean overwrite,
                     @NonNull
                     @NonNull Map<String,Object> metadata)

Description copied from interface: Artifact

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

Specified by:

addAsset in interface Artifact

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.

addAsset

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

Specified by:

addAsset in interface Artifact

addAsset

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

Specified by:

addAsset in interface Artifact

Throws:

ConflictingArtifactAssetNameException

addRemoteAsset

public void addRemoteAsset(@NonNull
                           @NonNull URI uri,
                           @NonNull
                           @NonNull String logicalPath,
                           boolean overwrite,
                           @NonNull
                           @NonNull Map<String,Object> metadata)

Description copied from interface: Artifact

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.

Specified by:

addRemoteAsset in interface Artifact

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.

addRemoteAsset

public void addRemoteAsset(@NonNull
                           @NonNull URI uri,
                           @NonNull
                           @NonNull String logicalPath,
                           boolean overwrite)

Specified by:

addRemoteAsset in interface Artifact

addRemoteAsset

public void addRemoteAsset(@NonNull
                           @NonNull URI uri,
                           @NonNull
                           @NonNull String logicalPath)

Specified by:

addRemoteAsset in interface Artifact

addAssetFolder

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

Description copied from interface: Artifact

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

Specified by:

addAssetFolder in interface 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

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

Specified by:

addAssetFolder in interface Artifact

Throws:

ConflictingArtifactAssetNameException

IOException

addAssetFolder

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

Specified by:

addAssetFolder in interface Artifact

Throws:

ConflictingArtifactAssetNameException

IOException

addAssetFolder

public void addAssetFolder(@NonNull
                           @NonNull File folder)
                    throws ConflictingArtifactAssetNameException,
                           IOException

Specified by:

addAssetFolder in interface Artifact

Throws:

ConflictingArtifactAssetNameException

IOException

builder

public static ArtifactBuilder builder(@NonNull
                                      @NonNull String name,
                                      @NonNull
                                      @NonNull String type)

Returns ArtifactBuilder instance which can be used to create Artifact instances.

Parameters:

name - the name of the artifact.

type - the type of the artifact.

Returns:

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

getMetadata

public Map<String,Object> getMetadata()

getAliases

public Set<String> getAliases()

getVersionTags

public Set<String> getVersionTags()