org.apache.gravitino.model

Interface ModelVersion

All Superinterfaces:

Auditable

All Known Implementing Classes:

ModelVersionDTO

@Evolving
public interface ModelVersion
extends Auditable

An interface representing a single model checkpoint under a model Model. A model version is a snapshot at a point of time of a model artifact in ML. Users can link a model version to a registered model.

Method Summary

Modifier and Type	Method and Description
java.lang.String[]	aliases() The aliases of this model version.
default java.lang.String	comment() The comment of this model version.
default java.util.Map<java.lang.String,java.lang.String>	properties() The properties of the model version.
java.lang.String	uri() The URI of the model artifact.
int	version() The version of this model object.

Methods inherited from interface org.apache.gravitino.Auditable

auditInfo

Method Detail

version

int version()

The version of this model object. The version number is an integer number starts from 0. Each time the model checkpoint / snapshot is linked to the registered, the version number will be increased by 1.

Returns:

The version of the model object.

comment

default java.lang.String comment()

The comment of this model version. This comment can be different from the comment of the model to provide more detailed information about this version.

Returns:

The comment of the model version. Null is returned if no comment is set.

aliases

java.lang.String[] aliases()

The aliases of this model version. The aliases are the alternative names of the model version. The aliases are optional. The aliases are unique for a model version. If the alias is already set to one model version, it cannot be set to another model version.

Returns:

The aliases of the model version.

uri

java.lang.String uri()

The URI of the model artifact. The URI is the location of the model artifact. The URI can be a file path or a remote URI.

Returns:

The URI of the model artifact.

properties

default java.util.Map<java.lang.String,java.lang.String> properties()

The properties of the model version. The properties are key-value pairs that can be used to store additional information of the model version. The properties are optional.

Returns:

the properties of the model version.