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
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.
ModelRegistryRecord	registerModel(Model model, String experimentKey) Register model defined in the specified experiment in the Comet's model registry.

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