ml.comet.experiment

Interface CometApi

All Superinterfaces:

AutoCloseable, Closeable

All Known Implementing Classes:

CometApiImpl

public interface CometApi
extends Closeable

The utility providing direct access to the Comet REST API.

Make sure to call CometApi.close() after finished with usage to release underlying resources.

Method Summary

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

Methods inherited from interface java.io.Closeable

close

Method Detail

getAllWorkspaces

List<String> getAllWorkspaces()

Gets all workspaces available for current API key.

Returns:

the list of workspace names

getAllProjects

List<Project> getAllProjects(String workspaceName)

Gets all projects under specified workspace name.

Parameters:

workspaceName - workspace name

Returns:

the list of projects

getAllExperiments

List<ExperimentMetadata> getAllExperiments(String projectId)

Gets metadata of all experiments created under specified project id.

Parameters:

projectId - the ID of the project.

Returns:

the list of experiments' metadata objects.

registerModel

ModelRegistryRecord registerModel(Model model,
                                  String experimentKey)

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

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

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

Downloads and saves all files from the registered model.

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

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

Throws:

IOException

getRegistryModelDetails

Optional<ModelOverview> getRegistryModelDetails(String registryName,
                                                String workspace)

Allows querying for details about specific registry model.

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

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

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

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

List<String> getRegistryModelNames(String workspace)

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

Parameters:

workspace - the name of the workspace.

Returns:

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

getRegistryModelVersions

List<String> getRegistryModelVersions(String registryName,
                                      String workspace)

Returns list of the version strings of the registry model.

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

void updateRegistryModelNotes(String notes,
                              String registryName,
                              String workspace)

Adds or updates notes associated with the registry model.

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

Optional<String> getRegistryModelNotes(String registryName,
                                       String workspace)

Returns notes associated with the registry model.

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

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

Updates the registry model with new values.

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

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

Throws:

ModelNotFoundException

updateRegistryModel

void updateRegistryModel(String registryName,
                         String workspace,
                         String newRegistryName)
                  throws ModelNotFoundException

Throws:

ModelNotFoundException

updateRegistryModelVersion

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

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

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

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

deleteRegistryModel

void deleteRegistryModel(String registryName,
                         String workspace)

Deletes registered model with given name.

Parameters:

registryName - the name of the model.

workspace - the name of the model's workspace.

deleteRegistryModelVersion

void deleteRegistryModelVersion(String registryName,
                                String workspace,
                                String version)

Deletes specific version of the registered model with given name.

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.