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

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

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.