ml.comet.experiment.artifact

Interface LoggedArtifact

All Known Implementing Classes:

LoggedArtifactImpl

public interface LoggedArtifact

Defines the public contract of the Comet artifact that already logged to the Comet servers.

LoggedArtifact allows reading artifact properties and downloading all or particular assets associated with it.

Method Summary

Modifier and Type	Method and Description
DownloadedArtifact	download(Path folder)
DownloadedArtifact	download(Path folder, AssetOverwriteStrategy overwriteStrategy) Download the current Artifact Version assets to a given directory.
Set<String>	getAliases() Returns set of aliases associated with the artifact.
String	getArtifactId() Returns unique identifier of the artifact.
Set<String>	getArtifactTags() Returns set of TAGs associated with the artifact.
String	getArtifactType() Returns type of the artifact.
LoggedArtifactAsset	getAsset(String assetLogicalPath) Allows getting asset keyed by provided logicalPath from the Comet backend.
Collection<LoggedArtifactAsset>	getAssets() Allows reading list of assets associated with this artifact from the Comet backend.
String	getFullName() Returns the fully qualified name of the artifact in form 'workspace/name:version'.
Map<String,Object>	getMetadata() Returns metadata associated with artifact.
String	getName() Returns name of the artifact.
Collection<LoggedArtifactAsset>	getRemoteAssets() Allows reading list of remote assets associated with this artifact from Comet backend.
long	getSize() Returns the total size of logged artifact version; it is the sum of all the artifact version assets.
String	getSourceExperimentKey() Returns key of the experiment that was used to create this artifact.
String	getVersion() Returns the version of this artifact represented in semantic version format.
String	getVersionId() Returns the unique identifier of the artifact version.
Set<String>	getVersionTags() Returns set of TAGs associated with current version of the artifact.
String	getWorkspace() Returns workspace name where artifact was logged.

Method Detail

getAliases

Set<String> getAliases()

Returns set of aliases associated with the artifact.

Returns:

the set of aliases associated with artifact.

getArtifactId

String getArtifactId()

Returns unique identifier of the artifact.

Returns:

the unique identifier of the artifact.

getArtifactTags

Set<String> getArtifactTags()

Returns set of TAGs associated with the artifact.

Returns:

the set of TAGs associated with the artifact.

getArtifactType

String getArtifactType()

Returns type of the artifact.

Returns:

the type of the artifact.

getMetadata

Map<String,Object> getMetadata()

Returns metadata associated with artifact.

Returns:

the optional metadata associated with artifact.

getName

String getName()

Returns name of the artifact.

Returns:

the name of the artifact.

getFullName

String getFullName()

Returns the fully qualified name of the artifact in form 'workspace/name:version'.

Returns:

the fully qualified name of the artifact.

getSize

long getSize()

Returns the total size of logged artifact version; it is the sum of all the artifact version assets.

Returns:

the total size of logged artifact version; it is the sum of all the artifact version assets.

getSourceExperimentKey

String getSourceExperimentKey()

Returns key of the experiment that was used to create this artifact.

Returns:

the key of the experiment that was used to create this artifact.

getVersion

String getVersion()

Returns the version of this artifact represented in semantic version format.

Returns:

the version of this artifact represented in semantic version format.

getVersionId

String getVersionId()

Returns the unique identifier of the artifact version.

Returns:

the unique identifier of the artifact version.

getVersionTags

Set<String> getVersionTags()

Returns set of TAGs associated with current version of the artifact.

Returns:

the set of TAGs associated with current version of the artifact.

getWorkspace

String getWorkspace()

Returns workspace name where artifact was logged.

Returns:

the workspace name where artifact was logged.

getRemoteAssets

Collection<LoggedArtifactAsset> getRemoteAssets()
                                         throws ArtifactException

Allows reading list of remote assets associated with this artifact from Comet backend.

This method is the remote method invocation and will contact the Comet backend.

Returns:

the list of LoggedArtifactAsset associated with this artifact.

Throws:

ArtifactException - if failed to read assets from Comet.

getAssets

Collection<LoggedArtifactAsset> getAssets()
                                   throws ArtifactException

Allows reading list of assets associated with this artifact from the Comet backend.

This method is the remote method invocation and will contact the Comet backend.

Returns:

the list of LoggedArtifactAsset associated with this artifact.

Throws:

ArtifactException - if failed to read assets from the Comet.

getAsset

LoggedArtifactAsset getAsset(String assetLogicalPath)
                      throws ArtifactAssetNotFoundException,
                             ArtifactException

Allows getting asset keyed by provided logicalPath from the Comet backend.

Parameters:

assetLogicalPath - the logical path of the asset.

Returns:

the LoggedArtifactAsset instance associated with given logical path.

Throws:

ArtifactAssetNotFoundException - if failed to find asset with given logical path.

ArtifactException - if operation failed.

download

DownloadedArtifact download(Path folder,
                            AssetOverwriteStrategy overwriteStrategy)
                     throws ArtifactException

Download the current Artifact Version assets to a given directory. This downloads only non-remote assets. You can access remote assets links using returned list of assets.

Parameters:

folder - the path to the folder to keep downloaded files of the assets.

overwriteStrategy - the overwriting strategy to apply when conflicting file name found.

Returns:

the Artifact representing downloaded artifact with a list of all associated assets.

Throws:

ArtifactException - thrown if operation failed.

download

DownloadedArtifact download(Path folder)
                     throws ArtifactException

Throws:

ArtifactException