ml.comet.experiment.impl

Class RegistryModelImpl.RegistryModelBuilderImpl

java.lang.Object

ml.comet.experiment.impl.RegistryModelImpl.RegistryModelBuilderImpl

All Implemented Interfaces:

ModelBuilder

Enclosing class:

RegistryModelImpl

public static class RegistryModelImpl.RegistryModelBuilderImpl
extends Object
implements ModelBuilder

The implementation of the ModelBuilder.

Constructor Summary

Constructors

Constructor and Description
RegistryModelBuilderImpl(String name)

Method Summary

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

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

RegistryModelBuilderImpl

public RegistryModelBuilderImpl(String name)

Method Detail

withVersion

public RegistryModelImpl.RegistryModelBuilderImpl withVersion(String version)

Description copied from interface: ModelBuilder

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)

Specified by:

withVersion in interface ModelBuilder

Parameters:

version - the version of the model to be applied.

Returns:

the ModelBuilder instance.

withWorkspace

public RegistryModelImpl.RegistryModelBuilderImpl withWorkspace(String workspace)

Description copied from interface: ModelBuilder

Updates the workspace name of the model.

Specified by:

withWorkspace in interface ModelBuilder

Parameters:

workspace - the name of the workspace.

Returns:

the ModelBuilder instance.

withRegistryName

public RegistryModelImpl.RegistryModelBuilderImpl withRegistryName(String registryModelName)

Description copied from interface: ModelBuilder

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

Specified by:

withRegistryName in interface ModelBuilder

Parameters:

registryModelName - the name of the mode in the Comet registry

Returns:

the ModelBuilder instance.

asPublic

public RegistryModelImpl.RegistryModelBuilderImpl asPublic(boolean isPublic)

Description copied from interface: ModelBuilder

Updates the visibility of this model.

Specified by:

asPublic in interface ModelBuilder

Parameters:

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

Returns:

the ModelBuilder instance.

withDescription

public RegistryModelImpl.RegistryModelBuilderImpl withDescription(String description)

Description copied from interface: ModelBuilder

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

Specified by:

withDescription in interface ModelBuilder

Parameters:

description - the long description of the model.

Returns:

the ModelBuilder instance.

withComment

public RegistryModelImpl.RegistryModelBuilderImpl withComment(String comment)

Description copied from interface: ModelBuilder

Updates the short comment associated with model's record.

Specified by:

withComment in interface ModelBuilder

Parameters:

comment - the short comment about the model.

Returns:

the ModelBuilder instance.

withStages

public RegistryModelImpl.RegistryModelBuilderImpl withStages(List<String> tags)

Description copied from interface: ModelBuilder

Updates the TAGs associated with the model.

Specified by:

withStages in interface ModelBuilder

Parameters:

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

Returns:

the ModelBuilder instance.

build

public Model build()

Description copied from interface: ModelBuilder

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

Specified by:

build in interface ModelBuilder

Returns:

the properly initialized Model instance.