ml.comet.experiment.artifact

Interface DownloadedArtifact

All Superinterfaces:

Artifact

All Known Implementing Classes:

DownloadedArtifactImpl

public interface DownloadedArtifact
extends Artifact

Defines the public contract of the Comet Artifact which was downloaded.

You can use this artifact object to update some properties of the artifact as well as to add new assets to it. After that, the artifact can be uploaded to the Comet using OnlineExperiment.logArtifact(Artifact) method.

Method Summary

Modifier and Type	Method and Description
Set<String>	getAliases() Returns set of aliases associated with the artifact.
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() Returns metadata associated with artifact.
String	getName() Returns name of the artifact.
String	getVersion() Returns the version of this artifact represented in semantic version format.
Set<String>	getVersionTags() Returns set of TAGs associated with current version of the artifact.
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.
void	setAliases(Set<String> aliases) Sets the new aliases to be associated with the artifact.
boolean	setVersion(String version) Sets new version for this artifact.
void	setVersionTags(Set<String> tags) Sets the TAGs for the new version of the artifact.

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

String getArtifactId()

Returns unique identifier of the artifact.

Returns:

the unique identifier of the 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.

getArtifactType

String getArtifactType()

Returns type of the artifact.

Returns:

the type of the artifact.

getWorkspace

String getWorkspace()

Returns workspace name where artifact was logged.

Returns:

the workspace name where artifact was logged.

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.

setVersion

boolean setVersion(String version)

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.

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.

incrementMajorVersion

String incrementMajorVersion()

Allows bumping artifact version to the next major version.

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

Returns:

the new artifact version.

incrementMinorVersion

String incrementMinorVersion()

Allows bumping artifact version to the next minor version.

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

Returns:

the new artifact version.

incrementPatchVersion

String incrementPatchVersion()

Allows bumping artifact version to the next patch version.

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

Returns:

the new 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.

setVersionTags

void setVersionTags(Set<String> tags)

Sets the TAGs for the new version of the artifact. The current version TAGs will be replaced by provided ones.

Parameters:

tags - the set of version TAGs to replace existing.

getAliases

Set<String> getAliases()

Returns set of aliases associated with the artifact.

Returns:

the set of aliases associated with artifact.

setAliases

void setAliases(Set<String> aliases)

Sets the new aliases to be associated with the artifact. The current aliases will be replaced by provided ones.

Parameters:

aliases - the set of aliases to be associated with artifact.

getMetadata

Map<String,Object> getMetadata()

Returns metadata associated with artifact.

Returns:

the optional metadata associated with artifact.