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
List<ExperimentMetadata>	getAllExperiments(String projectId) Gets all experiment DTOs under specified project id.
List<Project>	getAllProjects(String workspaceName) Gets all project DTOs under specified workspace name.
List<String>	getAllWorkspaces() Gets all workspaces available for current API key.

Methods inherited from interface java.io.Closeable

close

Method Detail

getAllWorkspaces

List<String> getAllWorkspaces()

Gets all workspaces available for current API key.

Returns:

List of workspace names

getAllProjects

List<Project> getAllProjects(String workspaceName)

Gets all project DTOs under specified workspace name.

Parameters:

workspaceName - workspace name

Returns:

List of project DTOs

getAllExperiments

List<ExperimentMetadata> getAllExperiments(String projectId)

Gets all experiment DTOs under specified project id.

Parameters:

projectId - Project id

Returns:

List of experiment DTOs