ml.comet.experiment.impl

Class DownloadedArtifactImpl

java.lang.Object

ml.comet.experiment.impl.ArtifactImpl

ml.comet.experiment.impl.DownloadedArtifactImpl

All Implemented Interfaces:

Artifact, DownloadedArtifact

public final class DownloadedArtifactImpl
extends ArtifactImpl
implements DownloadedArtifact

The implementation of the Artifact to represent artifact downloaded from the Comet by LoggedArtifact.download(Path, AssetOverwriteStrategy) method.

Method Summary

Modifier and Type	Method and Description
Set<String>	getAliases()
String	getArtifactId() Returns unique identifier of the artifact.
String	getArtifactType() Returns type of the artifact.
String	getFullName() Returns the fully qualified name of the artifact in form 'workspace/name:version'.
Map<String,Object>	getMetadata()
String	getName() Returns name of the artifact.
String	getVersion() Returns the version of this artifact represented in semantic version format.
Set<String>	getVersionTags()
String	getWorkspace() Returns workspace name where artifact was logged.
String	incrementMajorVersion() Allows bumping artifact version to the next major version.
String	incrementMinorVersion() Allows bumping artifact version to the next minor version.
String	incrementPatchVersion() Allows bumping artifact version to the next patch version.
boolean	setVersion(String version) Sets new version for this artifact.

Methods inherited from class ml.comet.experiment.impl.ArtifactImpl

addAsset, addAsset, addAsset, addAsset, addAsset, addAsset, addAsset, addAssetFolder, addAssetFolder, addAssetFolder, addAssetFolder, addRemoteAsset, addRemoteAsset, addRemoteAsset, builder, getAssets

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

getAliases, getMetadata, getVersionTags, setAliases, setVersionTags

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

addAsset, addAsset, addAsset, addAsset, addAsset, addAsset, addAsset, addAssetFolder, addAssetFolder, addAssetFolder, addAssetFolder, addRemoteAsset, addRemoteAsset, addRemoteAsset, getAssets, newArtifact

Method Detail

getArtifactId

public String getArtifactId()

Description copied from interface: DownloadedArtifact

Returns unique identifier of the artifact.

Specified by:

getArtifactId in interface DownloadedArtifact

Returns:

the unique identifier of the artifact.

getName

public String getName()

Description copied from interface: DownloadedArtifact

Returns name of the artifact.

Specified by:

getName in interface DownloadedArtifact

Returns:

the name of the artifact.

getFullName

public String getFullName()

Description copied from interface: DownloadedArtifact

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

Specified by:

getFullName in interface DownloadedArtifact

Returns:

the fully qualified name of the artifact.

getArtifactType

public String getArtifactType()

Description copied from interface: DownloadedArtifact

Returns type of the artifact.

Specified by:

getArtifactType in interface DownloadedArtifact

Returns:

the type of the artifact.

getWorkspace

public String getWorkspace()

Description copied from interface: DownloadedArtifact

Returns workspace name where artifact was logged.

Specified by:

getWorkspace in interface DownloadedArtifact

Returns:

the workspace name where artifact was logged.

getVersion

public String getVersion()

Description copied from interface: DownloadedArtifact

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

Specified by:

getVersion in interface DownloadedArtifact

Returns:

the version of this artifact represented in semantic version format.

setVersion

public boolean setVersion(String version)

Description copied from interface: DownloadedArtifact

Sets new version for this artifact. If provided version is lower or equal than current version it would be applied but false will be returned. The Comet may accept version lower than current if it was not logged before. Thus, in general, it is safer to always log the greater version or check value returned but this method.

The version string should follow the semantic versioning rules and be in the form: 1.2.3-beta.4+sha899d8g79f87.

See ArtifactBuilder.withVersion(String) for details about version format.

Specified by:

setVersion in interface DownloadedArtifact

Parameters:

version - the new version of the artifact.

Returns:

true if new version is valid, i.e., greater than current. The returned value can be used for quick check of the new version. If true returned then new version will be accepted by Comet backend. Otherwise, it may depend on backend already having provided artifact version logged.

incrementMinorVersion

public String incrementMinorVersion()

Description copied from interface: DownloadedArtifact

Allows bumping artifact version to the next minor version.

See ArtifactBuilder.withVersion(String) for details about version format.

Specified by:

incrementMinorVersion in interface DownloadedArtifact

Returns:

the new artifact version.

incrementMajorVersion

public String incrementMajorVersion()

Description copied from interface: DownloadedArtifact

Allows bumping artifact version to the next major version.

See ArtifactBuilder.withVersion(String) for details about version format.

Specified by:

incrementMajorVersion in interface DownloadedArtifact

Returns:

the new artifact version.

incrementPatchVersion

public String incrementPatchVersion()

Description copied from interface: DownloadedArtifact

Allows bumping artifact version to the next patch version.

See ArtifactBuilder.withVersion(String) for details about version format.

Specified by:

incrementPatchVersion in interface DownloadedArtifact

Returns:

the new artifact version.

getMetadata

public Map<String,Object> getMetadata()

getAliases

public Set<String> getAliases()

getVersionTags

public Set<String> getVersionTags()