ml.comet.experiment.impl

Class CometApiImpl

java.lang.Object

ml.comet.experiment.impl.CometApiImpl

All Implemented Interfaces:

Closeable, AutoCloseable, CometApi

public final class CometApiImpl
extends Object
implements CometApi

The implementation of the CometApi.

Method Summary

Modifier and Type	Method and Description
static CometApiBuilder	builder() Returns builder to be used to properly create instance of this class.
void	close() Release all resources hold by this instance, such as connection to the Comet server.
void	deleteRegistryModel(@NonNull String registryName, @NonNull String workspace) Deletes registered model with given name.
void	deleteRegistryModelVersion(@NonNull String registryName, @NonNull String workspace, @NonNull String version) Deletes specific version of the registered model with given name.
ModelDownloadInfo	downloadRegistryModel(@NonNull Path outputPath, @NonNull String registryName, @NonNull String workspace)
ModelDownloadInfo	downloadRegistryModel(@NonNull Path outputPath, @NonNull String registryName, @NonNull String workspace, @NonNull DownloadModelOptions options) Downloads and saves all files from the registered model.
List<ExperimentMetadata>	getAllExperiments(@NonNull String projectId) Gets metadata of all experiments created under specified project id.
List<Project>	getAllProjects(@NonNull String workspaceName) Gets all projects under specified workspace name.
List<String>	getAllWorkspaces() Gets all workspaces available for current API key.
Optional<ModelOverview>	getRegistryModelDetails(@NonNull String registryName, @NonNull String workspace) Allows querying for details about specific registry model.
List<String>	getRegistryModelNames(@NonNull String workspace) Returns list of the registry model names registered in specified workspace.
Optional<String>	getRegistryModelNotes(@NonNull String registryName, @NonNull String workspace) Returns notes associated with the registry model.
Optional<ModelVersionOverview>	getRegistryModelVersion(@NonNull String registryName, @NonNull String workspace, @NonNull String version) Allows querying for details about specific version of the registry model.
List<String>	getRegistryModelVersions(@NonNull String registryName, @NonNull String workspace) Returns list of the version strings of the registry model.
ModelRegistryRecord	registerModel(@NonNull Model model, @NonNull String experimentKey) Register model defined in the specified experiment in the Comet's model registry.
void	updateRegistryModel(@NonNull String registryName, @NonNull String workspace, String newRegistryName)
void	updateRegistryModel(@NonNull String registryName, @NonNull String workspace, String newRegistryName, String newDescription)
void	updateRegistryModel(@NonNull String registryName, @NonNull String workspace, String newRegistryName, String newDescription, boolean isPublic) Updates the registry model with new values.
void	updateRegistryModelNotes(@NonNull String notes, @NonNull String registryName, @NonNull String workspace) Adds or updates notes associated with the registry model.
void	updateRegistryModelVersion(String registryName, String workspace, String version, String comments)
void	updateRegistryModelVersion(@NonNull String registryName, @NonNull String workspace, @NonNull String version, String comments, List<String> stages) Updates the comments and stages of particular version of the registered model.

Methods inherited from class java.lang.Object

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

Method Detail

getAllWorkspaces

public List<String> getAllWorkspaces()

Description copied from interface: CometApi

Gets all workspaces available for current API key.

Specified by:

getAllWorkspaces in interface CometApi

Returns:

the list of workspace names

getAllProjects

public List<Project> getAllProjects(@NonNull
                                    @NonNull String workspaceName)

Description copied from interface: CometApi

Gets all projects under specified workspace name.

Specified by:

getAllProjects in interface CometApi

Parameters:

workspaceName - workspace name

Returns:

the list of projects

getAllExperiments

public List<ExperimentMetadata> getAllExperiments(@NonNull
                                                  @NonNull String projectId)

Description copied from interface: CometApi

Gets metadata of all experiments created under specified project id.

Specified by:

getAllExperiments in interface CometApi

Parameters:

projectId - the ID of the project.

Returns:

the list of experiments' metadata objects.

registerModel

public ModelRegistryRecord registerModel(@NonNull
                                         @NonNull Model model,
                                         @NonNull
                                         @NonNull String experimentKey)

Description copied from interface: CometApi

Register model defined in the specified experiment in the Comet's model registry.

Specified by:

registerModel in interface CometApi

Parameters:

model - the Model to be registered.

experimentKey - the identifier of the experiment where model assets was logged.

Returns:

the ModelRegistryRecord instance holding information about model registry record.

downloadRegistryModel

public ModelDownloadInfo downloadRegistryModel(@NonNull
                                               @NonNull Path outputPath,
                                               @NonNull
                                               @NonNull String registryName,
                                               @NonNull
                                               @NonNull String workspace,
                                               @NonNull
                                               @NonNull DownloadModelOptions options)
                                        throws IOException

Description copied from interface: CometApi

Downloads and saves all files from the registered model.

Specified by:

downloadRegistryModel in interface CometApi

Parameters:

outputPath - the output directory to save files.

registryName - the name of the model as in models' registry.

workspace - the name of the workspace.

options - the DownloadModelOptions defining additional download options.

Returns:

the ModelDownloadInfo with download details.

Throws:

IOException - if an I/O exception occurs while saving model files.

downloadRegistryModel

public ModelDownloadInfo downloadRegistryModel(@NonNull
                                               @NonNull Path outputPath,
                                               @NonNull
                                               @NonNull String registryName,
                                               @NonNull
                                               @NonNull String workspace)
                                        throws IOException

Specified by:

downloadRegistryModel in interface CometApi

Throws:

IOException

getRegistryModelDetails

public Optional<ModelOverview> getRegistryModelDetails(@NonNull
                                                       @NonNull String registryName,
                                                       @NonNull
                                                       @NonNull String workspace)

Description copied from interface: CometApi

Allows querying for details about specific registry model.

Specified by:

getRegistryModelDetails in interface CometApi

Parameters:

registryName - the name of the model as in models' registry.

workspace - the name of the model's workspace.

Returns:

the optional ModelOverview with model version details.

getRegistryModelVersion

public Optional<ModelVersionOverview> getRegistryModelVersion(@NonNull
                                                              @NonNull String registryName,
                                                              @NonNull
                                                              @NonNull String workspace,
                                                              @NonNull
                                                              @NonNull String version)

Description copied from interface: CometApi

Allows querying for details about specific version of the registry model.

Specified by:

getRegistryModelVersion in interface CometApi

Parameters:

registryName - the name of the model as in models' registry.

workspace - the name of the model's workspace.

version - the version of the registry model to be returned.

Returns:

the optional ModelOverview with model version details.

getRegistryModelNames

public List<String> getRegistryModelNames(@NonNull
                                          @NonNull String workspace)

Description copied from interface: CometApi

Returns list of the registry model names registered in specified workspace.

Specified by:

getRegistryModelNames in interface CometApi

Parameters:

workspace - the name of the workspace.

Returns:

the list of the registry model names registered in specified workspace.

getRegistryModelVersions

public List<String> getRegistryModelVersions(@NonNull
                                             @NonNull String registryName,
                                             @NonNull
                                             @NonNull String workspace)

Description copied from interface: CometApi

Returns list of the version strings of the registry model.

Specified by:

getRegistryModelVersions in interface CometApi

Parameters:

registryName - the name of the model as in models' registry.

workspace - the name of the model's workspace.

Returns:

the list of the version strings of the registry model.

updateRegistryModelNotes

public void updateRegistryModelNotes(@NonNull
                                     @NonNull String notes,
                                     @NonNull
                                     @NonNull String registryName,
                                     @NonNull
                                     @NonNull String workspace)

Description copied from interface: CometApi

Adds or updates notes associated with the registry model.

Specified by:

updateRegistryModelNotes in interface CometApi

Parameters:

notes - the notes to be associated.

registryName - the name of the model as in models' registry.

workspace - the name of the model's workspace.

getRegistryModelNotes

public Optional<String> getRegistryModelNotes(@NonNull
                                              @NonNull String registryName,
                                              @NonNull
                                              @NonNull String workspace)

Description copied from interface: CometApi

Returns notes associated with the registry model.

Specified by:

getRegistryModelNotes in interface CometApi

Parameters:

registryName - the name of the model as in models' registry.

workspace - the name of the model's workspace.

Returns:

the notes associated with the registry model or empty.

updateRegistryModel

public void updateRegistryModel(@NonNull
                                @NonNull String registryName,
                                @NonNull
                                @NonNull String workspace,
                                String newRegistryName,
                                String newDescription,
                                boolean isPublic)
                         throws ModelNotFoundException

Description copied from interface: CometApi

Updates the registry model with new values.

Specified by:

updateRegistryModel in interface CometApi

Parameters:

registryName - the current name of the model.

workspace - the name of the model's workspace.

newRegistryName - the new name for the model.

newDescription - the new description of the model.

isPublic - the new visibility status of the model.

Throws:

ModelNotFoundException - if model doesn't exists.

updateRegistryModel

public void updateRegistryModel(@NonNull
                                @NonNull String registryName,
                                @NonNull
                                @NonNull String workspace,
                                String newRegistryName,
                                String newDescription)
                         throws ModelNotFoundException

Specified by:

updateRegistryModel in interface CometApi

Throws:

ModelNotFoundException

updateRegistryModel

public void updateRegistryModel(@NonNull
                                @NonNull String registryName,
                                @NonNull
                                @NonNull String workspace,
                                String newRegistryName)
                         throws ModelNotFoundException

Specified by:

updateRegistryModel in interface CometApi

Throws:

ModelNotFoundException

updateRegistryModelVersion

public void updateRegistryModelVersion(@NonNull
                                       @NonNull String registryName,
                                       @NonNull
                                       @NonNull String workspace,
                                       @NonNull
                                       @NonNull String version,
                                       String comments,
                                       List<String> stages)

Description copied from interface: CometApi

Updates the comments and stages of particular version of the registered model.

Specified by:

updateRegistryModelVersion in interface CometApi

Parameters:

registryName - the name of the model.

workspace - the name of the model's workspace.

version - the version of the registered model to be updated.

comments - the comment to associate with new version.

stages - the stages to associate with new version.

updateRegistryModelVersion

public void updateRegistryModelVersion(String registryName,
                                       String workspace,
                                       String version,
                                       String comments)

Specified by:

updateRegistryModelVersion in interface CometApi

deleteRegistryModel

public void deleteRegistryModel(@NonNull
                                @NonNull String registryName,
                                @NonNull
                                @NonNull String workspace)

Description copied from interface: CometApi

Deletes registered model with given name.

Specified by:

deleteRegistryModel in interface CometApi

Parameters:

registryName - the name of the model.

workspace - the name of the model's workspace.

deleteRegistryModelVersion

public void deleteRegistryModelVersion(@NonNull
                                       @NonNull String registryName,
                                       @NonNull
                                       @NonNull String workspace,
                                       @NonNull
                                       @NonNull String version)

Description copied from interface: CometApi

Deletes specific version of the registered model with given name.

Specified by:

deleteRegistryModelVersion in interface CometApi

Parameters:

registryName - the name of the model.

workspace - the name of the model's workspace.

version - the version of the registered model to be deleted.

close

public void close()
           throws IOException

Release all resources hold by this instance, such as connection to the Comet server.

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Throws:

IOException - if an I/O exception occurs.

builder

public static CometApiBuilder builder()

Returns builder to be used to properly create instance of this class.

Returns:

the builder to be used to properly create instance of this class.