ml.comet.experiment.impl

Class LoggedArtifactImpl

java.lang.Object

ml.comet.experiment.impl.LoggedArtifactImpl

All Implemented Interfaces:

LoggedArtifact

public final class LoggedArtifactImpl
extends Object
implements LoggedArtifact

The implementation of the LoggedArtifact.

Method Summary

Modifier and Type	Method and Description
DownloadedArtifact	download(Path folder)
DownloadedArtifact	download(@NonNull Path folder, @NonNull AssetOverwriteStrategy overwriteStrategy) Download the current Artifact Version assets to a given directory.
Set<String>	getAliases()
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()
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()
String	getWorkspace() Returns workspace name where artifact was logged.

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.LoggedArtifact

getAliases, getArtifactId, getMetadata, getName, getVersionTags

Method Detail

getArtifactTags

public Set<String> getArtifactTags()

Description copied from interface: LoggedArtifact

Returns set of TAGs associated with the artifact.

Specified by:

getArtifactTags in interface LoggedArtifact

Returns:

the set of TAGs associated with the artifact.

getArtifactType

public String getArtifactType()

Description copied from interface: LoggedArtifact

Returns type of the artifact.

Specified by:

getArtifactType in interface LoggedArtifact

Returns:

the type of the artifact.

getSize

public long getSize()

Description copied from interface: LoggedArtifact

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

Specified by:

getSize in interface LoggedArtifact

Returns:

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

getSourceExperimentKey

public String getSourceExperimentKey()

Description copied from interface: LoggedArtifact

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

Specified by:

getSourceExperimentKey in interface LoggedArtifact

Returns:

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

getVersion

public String getVersion()

Description copied from interface: LoggedArtifact

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

Specified by:

getVersion in interface LoggedArtifact

Returns:

the version of this artifact represented in semantic version format.

getWorkspace

public String getWorkspace()

Description copied from interface: LoggedArtifact

Returns workspace name where artifact was logged.

Specified by:

getWorkspace in interface LoggedArtifact

Returns:

the workspace name where artifact was logged.

getVersionId

public String getVersionId()

Description copied from interface: LoggedArtifact

Returns the unique identifier of the artifact version.

Specified by:

getVersionId in interface LoggedArtifact

Returns:

the unique identifier of the artifact version.

getFullName

public String getFullName()

Description copied from interface: LoggedArtifact

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

Specified by:

getFullName in interface LoggedArtifact

Returns:

the fully qualified name of the artifact.

getRemoteAssets

public Collection<LoggedArtifactAsset> getRemoteAssets()
                                                throws ArtifactException

Description copied from interface: LoggedArtifact

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.

Specified by:

getRemoteAssets in interface LoggedArtifact

Returns:

the list of LoggedArtifactAsset associated with this artifact.

Throws:

ArtifactException - if failed to read assets from Comet.

getAssets

public Collection<LoggedArtifactAsset> getAssets()
                                          throws ArtifactException

Description copied from interface: LoggedArtifact

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.

Specified by:

getAssets in interface LoggedArtifact

Returns:

the list of LoggedArtifactAsset associated with this artifact.

Throws:

ArtifactException - if failed to read assets from the Comet.

getAsset

public LoggedArtifactAsset getAsset(String assetLogicalPath)
                             throws ArtifactException

Description copied from interface: LoggedArtifact

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

Specified by:

getAsset in interface LoggedArtifact

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

public DownloadedArtifact download(Path folder)

Specified by:

download in interface LoggedArtifact

download

public DownloadedArtifact download(@NonNull
                                   @NonNull Path folder,
                                   @NonNull
                                   @NonNull AssetOverwriteStrategy overwriteStrategy)
                            throws ArtifactException

Description copied from interface: LoggedArtifact

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.

Specified by:

download in interface LoggedArtifact

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.

getMetadata

public Map<String,Object> getMetadata()

getAliases

public Set<String> getAliases()

getVersionTags

public Set<String> getVersionTags()