ml.comet.experiment.registrymodel

Class DownloadModelOptions.DownloadModelOptionsBuilder

java.lang.Object

ml.comet.experiment.registrymodel.DownloadModelOptions.DownloadModelOptionsBuilder

Enclosing class:

DownloadModelOptions

public static final class DownloadModelOptions.DownloadModelOptionsBuilder
extends Object

The factory to create properly initialized instance of the DownloadModelOptions.

Method Summary

Modifier and Type	Method and Description
DownloadModelOptions	build() Creates properly initialized instance of the DownloadModelOptions.
DownloadModelOptions.DownloadModelOptionsBuilder	withExpand(boolean expand) Creates options with flag to indicate whether downloaded ZIP with model files should be expanded.
DownloadModelOptions.DownloadModelOptionsBuilder	withStage(String stage) Creates options with TAG associated with particular model's version.
DownloadModelOptions.DownloadModelOptionsBuilder	withVersion(String version) Creates options with specific model version.

Methods inherited from class java.lang.Object

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

Method Detail

withVersion

public DownloadModelOptions.DownloadModelOptionsBuilder withVersion(String version)

Creates options with specific model version.

Parameters:

version - the version of the model in the registry.

Returns:

the instance of the DownloadModelOptions.DownloadModelOptionsBuilder.

withStage

public DownloadModelOptions.DownloadModelOptionsBuilder withStage(String stage)

Creates options with TAG associated with particular model's version.

Parameters:

stage - the TAG associated with model version, such as: "production", "staging", etc.

Returns:

the instance of the DownloadModelOptions.DownloadModelOptionsBuilder.

withExpand

public DownloadModelOptions.DownloadModelOptionsBuilder withExpand(boolean expand)

Creates options with flag to indicate whether downloaded ZIP with model files should be expanded.

Parameters:

expand - if true the downloaded ZIP with model files will be unzipped.

Returns:

the instance of the DownloadModelOptions.DownloadModelOptionsBuilder.

build

public DownloadModelOptions build()
                           throws IllegalArgumentException

Creates properly initialized instance of the DownloadModelOptions.

Returns:

the properly initialized instance of the DownloadModelOptions.

Throws:

IllegalArgumentException - if simultaneously provided version and stage of the model.