ml.comet.experiment.registrymodel

Interface ModelBuilder

All Known Implementing Classes:

RegistryModelImpl.RegistryModelBuilderImpl

public interface ModelBuilder

The ModelBuilder can be used to create properly initialized instance of the Model.

Method Summary

Modifier and Type	Method and Description
ModelBuilder	asPublic(boolean isPublic) Updates the visibility of this model.
Model	build() Creates properly initialized Model instance using defined by this builder configuration options.
ModelBuilder	withComment(String comment) Updates the short comment associated with model's record.
ModelBuilder	withDescription(String description) Updates the long description associated with this model's record.
ModelBuilder	withRegistryName(String registryModelName) Updates the name of the model as defined in the Comet registry.
ModelBuilder	withStages(List<String> tags) Updates the TAGs associated with the model.
ModelBuilder	withVersion(String version) Updates the version of the model.
ModelBuilder	withWorkspace(String workspace) Updates the workspace name of the model.

Method Detail

withVersion

ModelBuilder withVersion(String version)

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

• 1 is the major part (required)
• 2 is the minor part (required)
• 3 is the patch part (required)
• beta and 4 are the version suffixes (optional)
• sha899d8g79f87 is the build information (optional)

Parameters:

version - the version of the model to be applied.

Returns:

the ModelBuilder instance.

withWorkspace

ModelBuilder withWorkspace(String workspace)

Updates the workspace name of the model.

Parameters:

workspace - the name of the workspace.

Returns:

the ModelBuilder instance.

withRegistryName

ModelBuilder withRegistryName(String registryModelName)

Updates the name of the model as defined in the Comet registry.

Parameters:

registryModelName - the name of the mode in the Comet registry

Returns:

the ModelBuilder instance.

asPublic

ModelBuilder asPublic(boolean isPublic)

Updates the visibility of this model.

Parameters:

isPublic - if true the model registry will be listed as public.

Returns:

the ModelBuilder instance.

withDescription

ModelBuilder withDescription(String description)

Updates the long description associated with this model's record.

Parameters:

description - the long description of the model.

Returns:

the ModelBuilder instance.

withComment

ModelBuilder withComment(String comment)

Updates the short comment associated with model's record.

Parameters:

comment - the short comment about the model.

Returns:

the ModelBuilder instance.

withStages

ModelBuilder withStages(List<String> tags)

Updates the TAGs associated with the model.

Parameters:

tags - the list of TAGs to associate with the model.

Returns:

the ModelBuilder instance.

build

Model build()

Creates properly initialized Model instance using defined by this builder configuration options.

Returns:

the properly initialized Model instance.