ml.comet.experiment.CometApi Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of comet-java-client Show documentation

There is a newer version: 1.1.14

package ml.comet.experiment;

import ml.comet.experiment.model.ExperimentMetadataRest;
import ml.comet.experiment.model.RestProject;

import java.io.Closeable;
import java.util.List;

/**
 * The utility providing direct access to the Comet REST API.
 *
 * Make sure to call CometApi.close() after finished with usage to release underlying resources.
 */
public interface CometApi extends Closeable {

    /**
     * Gets all workspaces available for current API key.
     *
     * @return List of workspace names
     */
    List getAllWorkspaces();

    /**
     * Gets all project DTOs under specified workspace name.
     *
     * @param workspaceName workspace name
     * @return List of project DTOs
     */
    List getAllProjects(String workspaceName);

    /**
     * Gets all experiment DTOs under specified project id.
     *
     * @param projectId Project id
     * @return List of experiment DTOs
     */
    List getAllExperiments(String projectId);
}