A B C D E F G H I J L M N O P Q R S T U V W

A

ADD_ASSET - Static variable in class ml.comet.experiment.impl.constants.ApiEndpoints

ADD_GIT_METADATA - Static variable in class ml.comet.experiment.impl.constants.ApiEndpoints

ADD_GRAPH - Static variable in class ml.comet.experiment.impl.constants.ApiEndpoints

ADD_HTML - Static variable in class ml.comet.experiment.impl.constants.ApiEndpoints

ADD_LOG_OTHER - Static variable in class ml.comet.experiment.impl.constants.ApiEndpoints

ADD_METRIC - Static variable in class ml.comet.experiment.impl.constants.ApiEndpoints

ADD_OUTPUT - Static variable in class ml.comet.experiment.impl.constants.ApiEndpoints

ADD_PARAMETER - Static variable in class ml.comet.experiment.impl.constants.ApiEndpoints

ADD_START_END_TIME - Static variable in class ml.comet.experiment.impl.constants.ApiEndpoints

ADD_TAG - Static variable in class ml.comet.experiment.impl.constants.ApiEndpoints

AddExperimentTagsRest - Class in ml.comet.experiment.model

AddExperimentTagsRest() - Constructor for class ml.comet.experiment.model.AddExperimentTagsRest

AddGraphRest - Class in ml.comet.experiment.model

AddGraphRest() - Constructor for class ml.comet.experiment.model.AddGraphRest

addTag(String) - Method in interface ml.comet.experiment.Experiment

Adds a tag to this experiment.

addTag(String) - Method in class ml.comet.experiment.impl.OnlineExperimentImpl

ApiEndpoints - Class in ml.comet.experiment.impl.constants

Definitions of the Comet API endpoints.

ApiEndpoints() - Constructor for class ml.comet.experiment.impl.constants.ApiEndpoints

ApiExperiment - Interface in ml.comet.experiment

The ApiExperiment can be used to synchronously read/update data of your Comet.ml experiment.

ApiExperiment() - Static method in class ml.comet.experiment.ExperimentBuilder

The factory to create instance of the ApiExperimentBuilder which can be used to configure and create fully initialized instance of the ApiExperiment.

ApiExperimentBuilder - Interface in ml.comet.experiment.builder

Defines the public contract of the factory to create initialized instances of the ApiExperiment allowing to work with Comet API synchronously.

ApiExperimentImpl - Class in ml.comet.experiment

Deprecated.

It would be replaced in the future with new experiment creation API.

ApiExperimentImpl() - Constructor for class ml.comet.experiment.ApiExperimentImpl

Deprecated.

ApiExperimentImpl - Class in ml.comet.experiment.impl

Implementation of the Experiment that allows to read/update existing experiment synchronously.

ApiExperimentImpl.ApiExperimentBuilderImpl - Class in ml.comet.experiment.impl

The builder to create properly configured ApiExperiment instance.

apply(Response) - Method in class ml.comet.experiment.impl.http.ConnectionUtils.DebugLogResponse

applyConfigOverride(File) - Static method in class ml.comet.experiment.impl.config.CometConfig

Uses provided configuration file to override some/all default configuration tree values.

applyConfigOverride(URL) - Static method in class ml.comet.experiment.impl.config.CometConfig

Allows overriding default configuration tree with values parsed from provided URL pointing to the configuration file.

Asset - Class in ml.comet.experiment.impl.asset

Describes asset data.

Asset() - Constructor for class ml.comet.experiment.impl.asset.Asset

assetFormParameters(Asset) - Static method in class ml.comet.experiment.impl.utils.AssetUtils

Extracts form parameters from the provided Asset.

assetQueryParameters(Asset, String) - Static method in class ml.comet.experiment.impl.utils.AssetUtils

Extracts query parameters from the provided Asset.

ASSETS_FOLDER_UPLOAD_COMPLETED - Static variable in class ml.comet.experiment.impl.resources.LogMessages

AssetType - Enum in ml.comet.experiment.impl.asset

Represents known types of the assets.

AssetUtils - Class in ml.comet.experiment.impl.utils

Utilities to work with assets.

AssetUtils() - Constructor for class ml.comet.experiment.impl.utils.AssetUtils

B

BaseCometBuilder<T> - Interface in ml.comet.experiment.builder

Defines public contract of base interface for all experiment builders in the Comet Java SDK.

build() - Method in interface ml.comet.experiment.builder.BaseCometBuilder

Instantiates the Comet experiment instance defined by T.

build() - Method in class ml.comet.experiment.context.ExperimentContext.ExperimentContextBuilder

Creates fully initialized ExperimentContext instance.

build() - Method in class ml.comet.experiment.impl.ApiExperimentImpl.ApiExperimentBuilderImpl

builder(String) - Static method in class ml.comet.experiment.ApiExperimentImpl

Deprecated.

Returns builder to create Experiment instance.

builder() - Static method in class ml.comet.experiment.CometApiImpl

Deprecated.

Returns builder to be used to properly create instance of CometApi.

builder() - Static method in class ml.comet.experiment.context.ExperimentContext

Returns builder to create populated instance of the ExperimentContext.

builder(String) - Static method in class ml.comet.experiment.impl.ApiExperimentImpl

Returns builder to create Experiment instance.

builder() - Static method in class ml.comet.experiment.impl.ApiExperimentImpl

Returns builder to create Experiment instance.

builder() - Static method in class ml.comet.experiment.impl.CometApiImpl

Returns builder to be used to properly create instance of this class.

builder() - Static method in class ml.comet.experiment.impl.OnlineExperimentImpl

Returns builder to be used to create properly configured instance of this class.

builder() - Static method in class ml.comet.experiment.OnlineExperimentImpl

Deprecated.

please use ExperimentBuilder.OnlineExperiment() instead.

C

clearConfigOverride() - Static method in class ml.comet.experiment.impl.config.CometConfig

Restores default configuration values if it was overridden previously.

close() - Method in class ml.comet.experiment.impl.ApiExperimentImpl

close() - Method in class ml.comet.experiment.impl.CometApiImpl

Release all resources hold by this instance, such as connection to the Comet server.

close() - Method in class ml.comet.experiment.impl.http.Connection

Closes this connection immediately by releasing underlying resources.

close() - Method in class ml.comet.experiment.impl.log.StdOutLogger

Closes this logger and release any hold resources.

close() - Method in class ml.comet.experiment.impl.OnlineExperimentImpl

Allows using OnlineExperiment with try-with-resources statement with automatic closing after usage.

COMET_API_KEY - Static variable in class ml.comet.experiment.impl.config.CometConfig

The Comet API key.

COMET_BASE_URL - Static variable in class ml.comet.experiment.impl.config.CometConfig

The Comet's servers base URL.

COMET_JAVA_SDK_VERSION - Static variable in class ml.comet.experiment.impl.utils.CometUtils

The current version of the Comet Java SDK.

COMET_MAX_AUTH_RETRIES - Static variable in class ml.comet.experiment.impl.config.CometConfig

The maximal number of authentication retries against Comet.

COMET_PROJECT_NAME - Static variable in class ml.comet.experiment.impl.config.CometConfig

The Comet project name.

COMET_SDK_API_HEADER - Static variable in class ml.comet.experiment.impl.http.Connection

COMET_TIMEOUT_CLEANING_SECONDS - Static variable in class ml.comet.experiment.impl.config.CometConfig

The timeout to clean up all waiting uploads and close connection to the server (seconds).

COMET_WORKSPACE_NAME - Static variable in class ml.comet.experiment.impl.config.CometConfig

The Comet workspace name.

CometApi - Interface in ml.comet.experiment

The utility providing direct access to the Comet REST API.

CometApiBuilder - Interface in ml.comet.experiment.builder

Defines the public contract of the factory builder to create properly initialized instances of the CometApi.

CometApiException - Exception in ml.comet.experiment.exception

Signals that REST API call operation has been failed or returned unexpected result.

CometApiException(String) - Constructor for exception ml.comet.experiment.exception.CometApiException

Constructs a new runtime exception with the specified detail message.

CometApiException(String, Throwable) - Constructor for exception ml.comet.experiment.exception.CometApiException

Constructs a new runtime exception with the specified detail message and cause.

CometApiException(String, Object...) - Constructor for exception ml.comet.experiment.exception.CometApiException

Constructs a new runtime exception with detail message that can be build using provided format string and arguments.

CometApiImpl - Class in ml.comet.experiment

Deprecated.

It would be replaced in the future with new experiment creation API.

CometApiImpl() - Constructor for class ml.comet.experiment.CometApiImpl

Deprecated.

CometApiImpl - Class in ml.comet.experiment.impl

The implementation of the CometApi.

CometConfig - Class in ml.comet.experiment.impl.config

The configuration holder of the Comet Java SDK.

CometConfig() - Constructor for class ml.comet.experiment.impl.config.CometConfig

CometGeneralException - Exception in ml.comet.experiment.exception

The root exception for all Comet SDK exceptions.

CometGeneralException() - Constructor for exception ml.comet.experiment.exception.CometGeneralException

Constructs a new runtime exception with null as its detail message.

CometGeneralException(String) - Constructor for exception ml.comet.experiment.exception.CometGeneralException

Constructs a new runtime exception with the specified detail message.

CometGeneralException(String, Throwable) - Constructor for exception ml.comet.experiment.exception.CometGeneralException

Constructs a new runtime exception with the specified detail message and cause.

CometUtils - Class in ml.comet.experiment.impl.utils

The common Comet SDK utilities.

CometUtils() - Constructor for class ml.comet.experiment.impl.utils.CometUtils

ConfigException - Exception in ml.comet.experiment.exception

The exception to be thrown if any configuration issues found.

ConfigException(String) - Constructor for exception ml.comet.experiment.exception.ConfigException

Constructs a new runtime exception with the specified detail message.

ConfigException(String, Throwable) - Constructor for exception ml.comet.experiment.exception.ConfigException

Constructs a new runtime exception with the specified detail message and cause.

ConfigItem - Class in ml.comet.experiment.impl.config

Represents specific configuration item holding information about key in the configuration file and environment variable key.

ConfigItem() - Constructor for class ml.comet.experiment.impl.config.ConfigItem

Connection - Class in ml.comet.experiment.impl.http

Represents connection with the CometML server.

Connection(String, String, int, Logger) - Constructor for class ml.comet.experiment.impl.http.Connection

Creates new instance with specified parameters.

CONNECTION_SHUTDOWN_TIMEOUT_MS - Static variable in class ml.comet.experiment.impl.http.Connection

ConnectionInitializer - Class in ml.comet.experiment.impl.http

The factory to build properly initialized connections.

ConnectionInitializer() - Constructor for class ml.comet.experiment.impl.http.ConnectionInitializer

ConnectionUtils - Class in ml.comet.experiment.impl.http

Collection of the utilities used by Connection.

ConnectionUtils() - Constructor for class ml.comet.experiment.impl.http.ConnectionUtils

ConnectionUtils.DebugLogResponse - Class in ml.comet.experiment.impl.http

The function allowing to debug response.

createExperimentLink(String, String, String, String) - Method in class ml.comet.experiment.impl.utils.CometUtils

Creates link to the experiment at Comet.

CreateExperimentRequest - Class in ml.comet.experiment.model

CreateExperimentRequest(String, String, String) - Constructor for class ml.comet.experiment.model.CreateExperimentRequest

CreateExperimentResponse - Class in ml.comet.experiment.model

CreateExperimentResponse() - Constructor for class ml.comet.experiment.model.CreateExperimentResponse

createGraphRequest(String) - Static method in class ml.comet.experiment.impl.utils.DataUtils

The factory to create AddGraphRest instance.

createLogEndTimeRequest(long) - Static method in class ml.comet.experiment.impl.utils.DataUtils

The factory to create ExperimentTimeRequest instance.

createLogHtmlRequest(String, boolean) - Static method in class ml.comet.experiment.impl.utils.DataUtils

The factory to create HtmlRest instance.

createLogLineRequest(String, long, boolean, String) - Static method in class ml.comet.experiment.impl.utils.DataUtils

The factory to create OutputUpdate instance.

createLogMetricRequest(String, Object, ExperimentContext) - Static method in class ml.comet.experiment.impl.utils.DataUtils

The factory to create MetricRest instance.

createLogOtherRequest(String, Object) - Static method in class ml.comet.experiment.impl.utils.DataUtils

The factory to create LogOtherRest instance.

createLogParamRequest(String, Object, ExperimentContext) - Static method in class ml.comet.experiment.impl.utils.DataUtils

The factory to create ParameterRest instance.

createLogStartTimeRequest(long) - Static method in class ml.comet.experiment.impl.utils.DataUtils

The factory to create ExperimentTimeRequest instance.

createRemoteAsset(URI, Optional<String>, boolean, Optional<Map<String, Object>>) - Static method in class ml.comet.experiment.impl.utils.AssetUtils

Creates remote asset representation encapsulated into RemoteAsset instance.

createStderrLogger(OnlineExperiment) - Static method in class ml.comet.experiment.impl.log.StdOutLogger

Creates logger instance that captures StdErr stream for a given OnlineExperiment.

createStdoutLogger(OnlineExperiment) - Static method in class ml.comet.experiment.impl.log.StdOutLogger

Creates logger instance that captures StdOut stream for a given OnlineExperiment.

createTagRequest(String) - Static method in class ml.comet.experiment.impl.utils.DataUtils

The factory to create AddExperimentTagsRest instance.

D

DataUtils - Class in ml.comet.experiment.impl.utils

The common factory methods to create initialized DTO instances.

DataUtils() - Constructor for class ml.comet.experiment.impl.utils.DataUtils

DebugLogResponse() - Constructor for class ml.comet.experiment.impl.http.ConnectionUtils.DebugLogResponse

E

empty() - Static method in class ml.comet.experiment.context.ExperimentContext

The factory to return empty ExperimentContext instance.

end() - Method in interface ml.comet.experiment.Experiment

Tells Comet that the Experiment is complete and release all associated resources.

end() - Method in class ml.comet.experiment.impl.OnlineExperimentImpl

Experiment - Interface in ml.comet.experiment

The Experiment is a unit of measurable research that defines a single run with some data/parameters/code/results.

EXPERIMENT_CLEANUP_PROMPT - Static variable in class ml.comet.experiment.impl.resources.LogMessages

EXPERIMENT_HEARTBEAT_STOPPED_PROMPT - Static variable in class ml.comet.experiment.impl.resources.LogMessages

EXPERIMENT_LIVE - Static variable in class ml.comet.experiment.impl.resources.LogMessages

ExperimentAssetLink - Class in ml.comet.experiment.model

ExperimentAssetLink() - Constructor for class ml.comet.experiment.model.ExperimentAssetLink

ExperimentAssetListResponse - Class in ml.comet.experiment.model

ExperimentAssetListResponse() - Constructor for class ml.comet.experiment.model.ExperimentAssetListResponse

ExperimentBuilder - Class in ml.comet.experiment

The factory of builders to be used for creation of different Experiment implementations.

ExperimentBuilder() - Constructor for class ml.comet.experiment.ExperimentBuilder

ExperimentContext - Class in ml.comet.experiment.context

Describes context of the Experiment.

ExperimentContext(long, long, String) - Constructor for class ml.comet.experiment.context.ExperimentContext

Creates new instance with specified parameters.

ExperimentContext(long, long) - Constructor for class ml.comet.experiment.context.ExperimentContext

Creates new instance with specified parameters.

ExperimentContext(long) - Constructor for class ml.comet.experiment.context.ExperimentContext

Creates new instance with specified parameters.

ExperimentContext(ExperimentContext) - Constructor for class ml.comet.experiment.context.ExperimentContext

The copy constructor.

ExperimentContext.ExperimentContextBuilder - Class in ml.comet.experiment.context

Builder to create populated instance of the ExperimentContext.

ExperimentMetadataRest - Class in ml.comet.experiment.model

ExperimentMetadataRest() - Constructor for class ml.comet.experiment.model.ExperimentMetadataRest

EXPERIMENTS - Static variable in class ml.comet.experiment.impl.constants.ApiEndpoints

ExperimentStatusResponse - Class in ml.comet.experiment.model

Describes response received when experiment set status sent.

ExperimentStatusResponse() - Constructor for class ml.comet.experiment.model.ExperimentStatusResponse

ExperimentTimeRequest - Class in ml.comet.experiment.model

ExperimentTimeRequest() - Constructor for class ml.comet.experiment.model.ExperimentTimeRequest

F

FAILED_READ_DATA_FOR_EXPERIMENT - Static variable in class ml.comet.experiment.impl.resources.LogMessages

FAILED_TO_LOG_ASSET_FOLDER - Static variable in class ml.comet.experiment.impl.resources.LogMessages

FAILED_TO_LOG_SOME_ASSET_FROM_FOLDER - Static variable in class ml.comet.experiment.impl.resources.LogMessages

FAILED_TO_SEND_LOG_ASSET_REQUEST - Static variable in class ml.comet.experiment.impl.resources.LogMessages

FAILED_TO_SEND_LOG_REQUEST - Static variable in class ml.comet.experiment.impl.resources.LogMessages

FileUtils - Class in ml.comet.experiment.impl.utils

Provides common file system utilities.

FileUtils() - Constructor for class ml.comet.experiment.impl.utils.FileUtils

flush() - Method in class ml.comet.experiment.impl.log.StdOutLogger

Flushes this logger by flushing intercepted system stream.

FormParamName - Enum in ml.comet.experiment.impl.constants

Enumeration of all known form parameter names of the REST endpoints.

fromJson(String, Class<T>) - Method in class ml.comet.experiment.impl.utils.JsonUtils

fullMetricName(String, ExperimentContext) - Static method in class ml.comet.experiment.impl.utils.CometUtils

Creates full name of the metric as it is returned by backend.

G

generateGUID() - Static method in class ml.comet.experiment.impl.utils.CometUtils

Generates global unique identifier in format supported by Comet.ml

GET_ASSET_INFO - Static variable in class ml.comet.experiment.impl.constants.ApiEndpoints

GET_GIT_METADATA - Static variable in class ml.comet.experiment.impl.constants.ApiEndpoints

GET_GRAPH - Static variable in class ml.comet.experiment.impl.constants.ApiEndpoints

GET_HTML - Static variable in class ml.comet.experiment.impl.constants.ApiEndpoints

GET_LOG_OTHER - Static variable in class ml.comet.experiment.impl.constants.ApiEndpoints

GET_METADATA - Static variable in class ml.comet.experiment.impl.constants.ApiEndpoints

GET_METRICS - Static variable in class ml.comet.experiment.impl.constants.ApiEndpoints

GET_OUTPUT - Static variable in class ml.comet.experiment.impl.constants.ApiEndpoints

GET_PARAMETERS - Static variable in class ml.comet.experiment.impl.constants.ApiEndpoints

GET_TAGS - Static variable in class ml.comet.experiment.impl.constants.ApiEndpoints

getAllExperiments(String) - Method in interface ml.comet.experiment.CometApi

Gets all experiment DTOs under specified project id.

getAllExperiments(String) - Method in class ml.comet.experiment.impl.CometApiImpl

getAllProjects(String) - Method in interface ml.comet.experiment.CometApi

Gets all project DTOs under specified workspace name.

getAllProjects(String) - Method in class ml.comet.experiment.impl.CometApiImpl

getAllWorkspaces() - Method in interface ml.comet.experiment.CometApi

Gets all workspaces available for current API key.

getAllWorkspaces() - Method in class ml.comet.experiment.impl.CometApiImpl

getAssetList(AssetType) - Method in interface ml.comet.experiment.Experiment

Get experiment asset list.

getContext() - Method in class ml.comet.experiment.impl.OnlineExperimentImpl

getContext() - Method in interface ml.comet.experiment.OnlineExperiment

Gets the current context identifier as recorded in the OnlineExperiment object locally.

getDisableHeartBeat() - Method in class ml.comet.experiment.model.CreateExperimentRequest

getDuration() - Method in class ml.comet.experiment.impl.config.ConfigItem

Returns value of this item as Duration or throw an ConfigException if value is missing or have wrong type.

getEpoch() - Method in class ml.comet.experiment.impl.OnlineExperimentImpl

getEpoch() - Method in interface ml.comet.experiment.OnlineExperiment

Gets the current epoch as recorded by the Experiment object locally.

getExperimentKey() - Method in interface ml.comet.experiment.Experiment

Get the experiment key returned by Comet.

getExperimentLink() - Method in interface ml.comet.experiment.Experiment

Get the experiment link returned by Comet.

getExperimentLink() - Method in class ml.comet.experiment.impl.ApiExperimentImpl

getExperimentLink() - Method in class ml.comet.experiment.impl.OnlineExperimentImpl

getExperimentName() - Method in interface ml.comet.experiment.Experiment

Get experiment name.

getExperimentName() - Method in class ml.comet.experiment.impl.ApiExperimentImpl

GetExperimentsResponse - Class in ml.comet.experiment.model

GetExperimentsResponse() - Constructor for class ml.comet.experiment.model.GetExperimentsResponse

getGitMetadata() - Method in interface ml.comet.experiment.Experiment

Get experiment git metadata.

getGraph() - Method in interface ml.comet.experiment.Experiment

Get experiment graph data.

GetGraphResponse - Class in ml.comet.experiment.model

GetGraphResponse() - Constructor for class ml.comet.experiment.model.GetGraphResponse

getHtml() - Method in interface ml.comet.experiment.Experiment

Get experiment html.

GetHtmlResponse - Class in ml.comet.experiment.model

GetHtmlResponse() - Constructor for class ml.comet.experiment.model.GetHtmlResponse

getInt() - Method in class ml.comet.experiment.impl.config.ConfigItem

Returns value of this item as int or throw an ConfigException if value is missing or have wrong type.

getIsOwner() - Method in class ml.comet.experiment.model.GetProject

getLogOther() - Method in interface ml.comet.experiment.Experiment

Get experiment log other data.

getMetadata() - Method in interface ml.comet.experiment.Experiment

Get experiment metadata.

getMetrics() - Method in interface ml.comet.experiment.Experiment

Get experiment metrics.

getOptionalString() - Method in class ml.comet.experiment.impl.config.ConfigItem

Returns optional value for this item as string.

getOutput() - Method in interface ml.comet.experiment.Experiment

Get experiment output data.

GetOutputResponse - Class in ml.comet.experiment.model

GetOutputResponse() - Constructor for class ml.comet.experiment.model.GetOutputResponse

getParameters() - Method in interface ml.comet.experiment.Experiment

Get experiment parameters.

GetProject - Class in ml.comet.experiment.model

GetProject() - Constructor for class ml.comet.experiment.model.GetProject

GetProject(String, String, String, String, String, Boolean, int, boolean, Long, boolean, boolean, Timestamp) - Constructor for class ml.comet.experiment.model.GetProject

getProjectName() - Method in interface ml.comet.experiment.Experiment

Get project name of the experiment.

getProjectName() - Method in class ml.comet.experiment.impl.ApiExperimentImpl

GetProjectsResponse - Class in ml.comet.experiment.model

GetProjectsResponse() - Constructor for class ml.comet.experiment.model.GetProjectsResponse

getStep() - Method in class ml.comet.experiment.impl.OnlineExperimentImpl

getStep() - Method in interface ml.comet.experiment.OnlineExperiment

Gets the current step as recorded by the Experiment object locally.

getString() - Method in class ml.comet.experiment.impl.config.ConfigItem

Return value of this item as string or throw an ConfigException if value is missing.

getString(String, Object...) - Static method in class ml.comet.experiment.impl.resources.LogMessages

Gets a formatted string for the given key from this resource bundle.

getString(String) - Static method in class ml.comet.experiment.impl.resources.LogMessages

Gets a string for the given key from this resource bundle.

getTags() - Method in interface ml.comet.experiment.Experiment

Get experiment tags.

getWorkspaceName() - Method in interface ml.comet.experiment.Experiment

Get workspace name of the experiment.

getWorkspaceName() - Method in class ml.comet.experiment.impl.ApiExperimentImpl

GetWorkspacesResponse - Class in ml.comet.experiment.model

GetWorkspacesResponse() - Constructor for class ml.comet.experiment.model.GetWorkspacesResponse

GitMetadata - Class in ml.comet.experiment.model

GitMetadata() - Constructor for class ml.comet.experiment.model.GitMetadata

GitMetadataRest - Class in ml.comet.experiment.model

GitMetadataRest() - Constructor for class ml.comet.experiment.model.GitMetadataRest

H

hasFailed() - Method in class ml.comet.experiment.model.LogDataResponse

HtmlRest - Class in ml.comet.experiment.model

HtmlRest() - Constructor for class ml.comet.experiment.model.HtmlRest

I

initConnection(String, String, int, Logger) - Method in class ml.comet.experiment.impl.http.ConnectionInitializer

Builds properly configured Connection instance.

interceptStdout() - Method in interface ml.comet.experiment.builder.OnlineExperimentBuilder

Turn on intercept of stdout and stderr and the logging of both in Comet.

isOwner() - Method in class ml.comet.experiment.model.GetProject

J

JsonUtils - Class in ml.comet.experiment.impl.utils

Collection of utilities to process JSON-to-object mappings.

JsonUtils() - Constructor for class ml.comet.experiment.impl.utils.JsonUtils

L

listFiles(File, boolean) - Static method in class ml.comet.experiment.impl.utils.FileUtils

Lists files under given folder.

LOG_ASSET_FOLDER_EMPTY - Static variable in class ml.comet.experiment.impl.resources.LogMessages

LOG_REMOTE_ASSET_URI_FILE_NAME_TO_DEFAULT - Static variable in class ml.comet.experiment.impl.resources.LogMessages

logAssetFolder(File, boolean, boolean, ExperimentContext) - Method in class ml.comet.experiment.impl.OnlineExperimentImpl

logAssetFolder(File, boolean, boolean) - Method in class ml.comet.experiment.impl.OnlineExperimentImpl

logAssetFolder(File, boolean) - Method in class ml.comet.experiment.impl.OnlineExperimentImpl

logAssetFolder(File, boolean, boolean, ExperimentContext) - Method in interface ml.comet.experiment.OnlineExperiment

Logs all the files located in the given folder as assets.

logAssetFolder(File, boolean, boolean) - Method in interface ml.comet.experiment.OnlineExperiment

logAssetFolder(File, boolean) - Method in interface ml.comet.experiment.OnlineExperiment

logCode(String, String, ExperimentContext) - Method in interface ml.comet.experiment.Experiment

Allows you to report code for the experiment.

logCode(String, String) - Method in interface ml.comet.experiment.Experiment

Allows you to report code for the experiment.

logCode(File, ExperimentContext) - Method in interface ml.comet.experiment.Experiment

Allows you to report code for the experiment.

logCode(File) - Method in interface ml.comet.experiment.Experiment

Allows you to report code for the experiment.

logCode(String, String, ExperimentContext) - Method in class ml.comet.experiment.impl.OnlineExperimentImpl

logCode(File, ExperimentContext) - Method in class ml.comet.experiment.impl.OnlineExperimentImpl

logCode(String, String) - Method in class ml.comet.experiment.impl.OnlineExperimentImpl

logCode(File) - Method in class ml.comet.experiment.impl.OnlineExperimentImpl

LogDataResponse - Class in ml.comet.experiment.model

Encodes common fields of response received for POST logXXX requests.

LogDataResponse() - Constructor for class ml.comet.experiment.model.LogDataResponse

logEndTime(long) - Method in interface ml.comet.experiment.Experiment

Logs the start time of the experiment.

logEndTime(long) - Method in class ml.comet.experiment.impl.OnlineExperimentImpl

logGitMetadata(GitMetadata) - Method in interface ml.comet.experiment.Experiment

Logs Git Metadata for the experiment.

logGitMetadata(GitMetadata) - Method in class ml.comet.experiment.impl.OnlineExperimentImpl

logGraph(String) - Method in interface ml.comet.experiment.Experiment

Logs a graph to Comet.

logGraph(String) - Method in class ml.comet.experiment.impl.OnlineExperimentImpl

logHtml(String, boolean) - Method in interface ml.comet.experiment.Experiment

Allows you to create html report for the experiment.

logHtml(String, boolean) - Method in class ml.comet.experiment.impl.OnlineExperimentImpl

logLine(String, long, boolean, String) - Method in interface ml.comet.experiment.Experiment

Send logs to Comet.

logLine(String, long, boolean) - Method in class ml.comet.experiment.impl.OnlineExperimentImpl

logLine(String, long, boolean, String) - Method in class ml.comet.experiment.impl.OnlineExperimentImpl

logLine(String, long, boolean) - Method in interface ml.comet.experiment.OnlineExperiment

Send output logs to Comet.

LogMessages - Class in ml.comet.experiment.impl.resources

Provides access to the log messages to be presented to the user.

LogMessages() - Constructor for class ml.comet.experiment.impl.resources.LogMessages

logMetric(String, Object, ExperimentContext) - Method in interface ml.comet.experiment.Experiment

Logs a metric with Comet.

logMetric(String, Object, long, long) - Method in interface ml.comet.experiment.Experiment

Logs a metric with Comet.

logMetric(String, Object, ExperimentContext) - Method in class ml.comet.experiment.impl.OnlineExperimentImpl

logMetric(String, Object, long, long) - Method in class ml.comet.experiment.impl.OnlineExperimentImpl

logMetric(String, Object, long) - Method in class ml.comet.experiment.impl.OnlineExperimentImpl

logMetric(String, Object) - Method in class ml.comet.experiment.impl.OnlineExperimentImpl

logMetric(String, Object, long) - Method in interface ml.comet.experiment.OnlineExperiment

Logs a metric with Comet.

logMetric(String, Object) - Method in interface ml.comet.experiment.OnlineExperiment

logOther(String, Object) - Method in interface ml.comet.experiment.Experiment

Logs a key value pair with Comet.

logOther(String, Object) - Method in class ml.comet.experiment.impl.OnlineExperimentImpl

LogOtherRest - Class in ml.comet.experiment.model

LogOtherRest() - Constructor for class ml.comet.experiment.model.LogOtherRest

logParameter(String, Object, ExperimentContext) - Method in interface ml.comet.experiment.Experiment

Logs a param with Comet.

logParameter(String, Object, long) - Method in interface ml.comet.experiment.Experiment

Logs a param with Comet.

logParameter(String, Object) - Method in class ml.comet.experiment.impl.OnlineExperimentImpl

logParameter(String, Object, long) - Method in class ml.comet.experiment.impl.OnlineExperimentImpl

logParameter(String, Object, ExperimentContext) - Method in class ml.comet.experiment.impl.OnlineExperimentImpl

logParameter(String, Object) - Method in interface ml.comet.experiment.OnlineExperiment

Logs a param with Comet under the current experiment step.

logRemoteAsset(URI, String, boolean, Map<String, Object>, ExperimentContext) - Method in class ml.comet.experiment.impl.OnlineExperimentImpl

logRemoteAsset(URI, String, boolean, Map<String, Object>) - Method in class ml.comet.experiment.impl.OnlineExperimentImpl

logRemoteAsset(URI, String, boolean) - Method in class ml.comet.experiment.impl.OnlineExperimentImpl

logRemoteAsset(URI, boolean) - Method in class ml.comet.experiment.impl.OnlineExperimentImpl

logRemoteAsset(URI, String, boolean, Map<String, Object>, ExperimentContext) - Method in interface ml.comet.experiment.OnlineExperiment

Logs a Remote Asset identified by a URI.

logRemoteAsset(URI, String, boolean, Map<String, Object>) - Method in interface ml.comet.experiment.OnlineExperiment

logRemoteAsset(URI, String, boolean) - Method in interface ml.comet.experiment.OnlineExperiment

logRemoteAsset(URI, boolean) - Method in interface ml.comet.experiment.OnlineExperiment

logStartTime(long) - Method in interface ml.comet.experiment.Experiment

Logs the start time of the experiment.

logStartTime(long) - Method in class ml.comet.experiment.impl.OnlineExperimentImpl

M

mergeFrom(ExperimentContext) - Method in class ml.comet.experiment.context.ExperimentContext

Merges not empty values from other context into this one.

MetricRest - Class in ml.comet.experiment.model

MetricRest() - Constructor for class ml.comet.experiment.model.MetricRest

MinMaxResponse - Class in ml.comet.experiment.model

MinMaxResponse() - Constructor for class ml.comet.experiment.model.MinMaxResponse

ml.comet.experiment - package ml.comet.experiment

Contains all classes to create various types of Comet Experiments.

ml.comet.experiment.builder - package ml.comet.experiment.builder

Contains all interfaces defining the Comet experiment builders.

ml.comet.experiment.context - package ml.comet.experiment.context

ml.comet.experiment.exception - package ml.comet.experiment.exception

Contains exceptions which can be thrown by Comet experiment.

ml.comet.experiment.impl - package ml.comet.experiment.impl

Contains implementations of public interfaces of the Comet experiment's API.

ml.comet.experiment.impl.asset - package ml.comet.experiment.impl.asset

ml.comet.experiment.impl.config - package ml.comet.experiment.impl.config

ml.comet.experiment.impl.constants - package ml.comet.experiment.impl.constants

ml.comet.experiment.impl.http - package ml.comet.experiment.impl.http

ml.comet.experiment.impl.log - package ml.comet.experiment.impl.log

ml.comet.experiment.impl.resources - package ml.comet.experiment.impl.resources

ml.comet.experiment.impl.utils - package ml.comet.experiment.impl.utils

ml.comet.experiment.model - package ml.comet.experiment.model

Contains all classes used to model Comet REST API data transfer objects.

N

NEW_EXPERIMENT - Static variable in class ml.comet.experiment.impl.constants.ApiEndpoints

nextEpoch() - Method in class ml.comet.experiment.impl.OnlineExperimentImpl

nextEpoch() - Method in interface ml.comet.experiment.OnlineExperiment

Increments the epoch that the experiment is on.

nextStep() - Method in class ml.comet.experiment.impl.OnlineExperimentImpl

nextStep() - Method in interface ml.comet.experiment.OnlineExperiment

Increments the step that the experiment is on.

O

OnlineExperiment() - Static method in class ml.comet.experiment.ExperimentBuilder

Returns instance of the OnlineExperimentBuilder which can be used to configure and create fully initialized instance of the OnlineExperiment.

OnlineExperiment - Interface in ml.comet.experiment

The OnlineExperiment should be used to asynchronously update data of your Comet.ml experiment.

OnlineExperimentBuilder - Interface in ml.comet.experiment.builder

Defines the public contract of the OnlineExperiment builder.

OnlineExperimentImpl - Class in ml.comet.experiment.impl

The implementation of the OnlineExperiment to work with Comet API asynchronously.

OnlineExperimentImpl - Class in ml.comet.experiment

Deprecated.

You should use ExperimentBuilder.OnlineExperiment() instead to create instance of the OnlineExperiment.

OnlineExperimentImpl() - Constructor for class ml.comet.experiment.OnlineExperimentImpl

Deprecated.

OutputLine - Class in ml.comet.experiment.model

OutputLine() - Constructor for class ml.comet.experiment.model.OutputLine

OutputUpdate - Class in ml.comet.experiment.model

OutputUpdate() - Constructor for class ml.comet.experiment.model.OutputUpdate

P

ParameterRest - Class in ml.comet.experiment.model

ParameterRest() - Constructor for class ml.comet.experiment.model.ParameterRest

paramName() - Method in enum ml.comet.experiment.impl.constants.FormParamName

paramName() - Method in enum ml.comet.experiment.impl.constants.QueryParamName

printCometSdkVersion() - Method in class ml.comet.experiment.impl.utils.CometUtils

Prints the current version of the Comet Java SDK.

PROJECTS - Static variable in class ml.comet.experiment.impl.constants.ApiEndpoints

putNotNull(Map<T, String>, T, Object) - Static method in class ml.comet.experiment.impl.utils.CometUtils

Puts provided value into the map as string if it is not null.

Q

QueryParamName - Enum in ml.comet.experiment.impl.constants

The enumeration of all known query parameter names of the REST endpoints.

R

READ_API_URL - Static variable in class ml.comet.experiment.impl.constants.ApiEndpoints

readProperties(String) - Static method in class ml.comet.experiment.impl.utils.ResourceUtils

Allows reading properties from bundled resources.

REMOTE_FILE_NAME_DEFAULT - Static variable in class ml.comet.experiment.impl.utils.AssetUtils

RemoteAsset - Class in ml.comet.experiment.impl.asset

Describes remote asset data.

RemoteAsset() - Constructor for class ml.comet.experiment.impl.asset.RemoteAsset

REQUEST_TIMEOUT_MS - Static variable in class ml.comet.experiment.impl.http.Connection

ResourceUtils - Class in ml.comet.experiment.impl.utils

Collection of utilities to access bundled resource files.

ResourceUtils() - Constructor for class ml.comet.experiment.impl.utils.ResourceUtils

RestProject - Class in ml.comet.experiment.model

RestProject(GetProject) - Constructor for class ml.comet.experiment.model.RestProject

run() - Method in class ml.comet.experiment.impl.log.StdOutLogger

S

sendGetWithRetries(String, Map<QueryParamName, String>) - Method in class ml.comet.experiment.impl.http.Connection

Allows sending synchronous GET request to the specified endpoint with given request parameters.

sendPostAsync(String, String) - Method in class ml.comet.experiment.impl.http.Connection

Allows asynchronous sending of text as JSON encoded body of the POST request.

sendPostAsync(File, String, Map<QueryParamName, String>, Map<FormParamName, Object>) - Method in class ml.comet.experiment.impl.http.Connection

Allows asynchronous posting the content of the file as multipart form data to the specified endpoint.

sendPostAsync(byte[], String, Map<QueryParamName, String>, Map<FormParamName, Object>) - Method in class ml.comet.experiment.impl.http.Connection

Allows asynchronous sending of provided byte array as POST request to the specified endpoint.

sendPostAsync(String, Map<QueryParamName, String>, Map<FormParamName, Object>) - Method in class ml.comet.experiment.impl.http.Connection

Allows asynchronous FORM submission to the specified endpoint.

sendPostWithRetries(String, String, boolean) - Method in class ml.comet.experiment.impl.http.Connection

Allows sending POST to the specified endpoint with body as JSON string.

SET_EXPERIMENT_STATUS - Static variable in class ml.comet.experiment.impl.constants.ApiEndpoints

setContext(String) - Method in class ml.comet.experiment.impl.OnlineExperimentImpl

setContext(String) - Method in interface ml.comet.experiment.OnlineExperiment

Sets the context identifier for any logs and uploaded files.

setCurrent(String, Long, String, Long) - Method in class ml.comet.experiment.model.ValueMinMaxDto

setEpoch(long) - Method in class ml.comet.experiment.impl.OnlineExperimentImpl

setEpoch(long) - Method in interface ml.comet.experiment.OnlineExperiment

Sets the current epoch for the experiment.

setExperimentContext(ExperimentContext) - Method in class ml.comet.experiment.impl.asset.Asset

Updates this asset with values from provided ExperimentContext.

setExperimentName(String) - Method in interface ml.comet.experiment.Experiment

Sets the experiment name.

setGeneral(boolean) - Method in class ml.comet.experiment.model.GetProject

setInterceptStdout() - Method in class ml.comet.experiment.impl.OnlineExperimentImpl

setInterceptStdout() - Method in interface ml.comet.experiment.OnlineExperiment

Turn on intercept of stdout and stderr and the logging of both in Comet.

setMax(String, Long, String, Long) - Method in class ml.comet.experiment.model.ValueMinMaxDto

setMin(String, Long, String, Long) - Method in class ml.comet.experiment.model.ValueMinMaxDto

setOwner(boolean) - Method in class ml.comet.experiment.model.GetProject

setStep(long) - Method in class ml.comet.experiment.impl.OnlineExperimentImpl

setStep(long) - Method in interface ml.comet.experiment.OnlineExperiment

Sets the current step for the experiment.

setUserOnTeamForProject(boolean) - Method in class ml.comet.experiment.model.GetProject

StdOutLogger - Class in ml.comet.experiment.impl.log

The logger to capture StdOut/StdErr streams and log collected text to the Comet.

stopInterceptStdout() - Method in class ml.comet.experiment.impl.OnlineExperimentImpl

stopInterceptStdout() - Method in interface ml.comet.experiment.OnlineExperiment

Turn off intercept of stdout and stderr and turns off their logging in Comet.

T

TagsResponse - Class in ml.comet.experiment.model

TagsResponse() - Constructor for class ml.comet.experiment.model.TagsResponse

toJson(Object) - Method in class ml.comet.experiment.impl.utils.JsonUtils

toString() - Method in enum ml.comet.experiment.impl.asset.AssetType

toString() - Method in class ml.comet.experiment.impl.config.ConfigItem

toString() - Method in enum ml.comet.experiment.impl.constants.FormParamName

toString() - Method in enum ml.comet.experiment.impl.constants.QueryParamName

type() - Method in enum ml.comet.experiment.impl.asset.AssetType

Returns type of the asset as string.

U

UPDATE_API_URL - Static variable in class ml.comet.experiment.impl.constants.ApiEndpoints

uploadAsset(File, String, boolean, ExperimentContext) - Method in interface ml.comet.experiment.Experiment

Upload an asset to be associated with the experiment, for example the trained weights of a neural net.

uploadAsset(File, String, boolean, long, long) - Method in interface ml.comet.experiment.Experiment

Upload an asset to be associated with the experiment, for example the trained weights of a neural net.

uploadAsset(File, boolean, ExperimentContext) - Method in interface ml.comet.experiment.Experiment

Upload an asset to be associated with the experiment, for example the trained weights of a neural net.

uploadAsset(File, boolean, long, long) - Method in interface ml.comet.experiment.Experiment

Upload an asset to be associated with the experiment, for example the trained weights of a neural net.

uploadAsset(File, String, boolean, ExperimentContext) - Method in class ml.comet.experiment.impl.OnlineExperimentImpl

uploadAsset(File, boolean, ExperimentContext) - Method in class ml.comet.experiment.impl.OnlineExperimentImpl

uploadAsset(File, boolean, long, long) - Method in class ml.comet.experiment.impl.OnlineExperimentImpl

uploadAsset(File, String, boolean, long) - Method in class ml.comet.experiment.impl.OnlineExperimentImpl

uploadAsset(File, String, boolean) - Method in class ml.comet.experiment.impl.OnlineExperimentImpl

uploadAsset(File, boolean) - Method in class ml.comet.experiment.impl.OnlineExperimentImpl

uploadAsset(File, String, boolean, long) - Method in interface ml.comet.experiment.OnlineExperiment

Upload an asset under the current experiment step to be associated with the experiment, for example the trained weights of a neural net.

uploadAsset(File, String, boolean) - Method in interface ml.comet.experiment.OnlineExperiment

uploadAsset(File, boolean) - Method in interface ml.comet.experiment.OnlineExperiment

V

ValueMinMaxDto - Class in ml.comet.experiment.model

ValueMinMaxDto(String, String, Long, Long, String) - Constructor for class ml.comet.experiment.model.ValueMinMaxDto

ValueMinMaxDto(String, String, String, String, Long, Long, Long, Long, Long, Long, String, String, String) - Constructor for class ml.comet.experiment.model.ValueMinMaxDto

valueOf(String) - Static method in enum ml.comet.experiment.impl.asset.AssetType

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum ml.comet.experiment.impl.constants.FormParamName

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum ml.comet.experiment.impl.constants.QueryParamName

Returns the enum constant of this type with the specified name.

values() - Static method in enum ml.comet.experiment.impl.asset.AssetType

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum ml.comet.experiment.impl.constants.FormParamName

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum ml.comet.experiment.impl.constants.QueryParamName

Returns an array containing the constants of this enum type, in the order they are declared.

W

waitAndClose(Duration) - Method in class ml.comet.experiment.impl.http.Connection

Allows to properly close this connection after all scheduled posts request are executed or if timeout expired.

walkFolderAssets(File, boolean, boolean, boolean) - Static method in class ml.comet.experiment.impl.utils.AssetUtils

Walks through the asset files in the given folder and produce stream of Asset objects holding information about file assets found in the folder.

withApiKey(String) - Method in interface ml.comet.experiment.builder.BaseCometBuilder

Set the api key matched to the account you wish to use.

withApiKey(String) - Method in class ml.comet.experiment.impl.ApiExperimentImpl.ApiExperimentBuilderImpl

withConfigOverride(File) - Method in interface ml.comet.experiment.builder.BaseCometBuilder

Provide an override config to changeExperiment parameters being provided by the config.

withConfigOverride(File) - Method in class ml.comet.experiment.impl.ApiExperimentImpl.ApiExperimentBuilderImpl

withContext(String) - Method in class ml.comet.experiment.context.ExperimentContext.ExperimentContextBuilder

Populates context with specified context identifier string.

withEpoch(long) - Method in class ml.comet.experiment.context.ExperimentContext.ExperimentContextBuilder

Populates context with specified epoch of the experiment.

withExistingExperimentKey(String) - Method in interface ml.comet.experiment.builder.ApiExperimentBuilder

Allows to continue a previous experiment by providing the key of the existing experiment.

withExistingExperimentKey(String) - Method in interface ml.comet.experiment.builder.OnlineExperimentBuilder

Allows to continue a previous experiment by providing the key of the existing experiment.

withExistingExperimentKey(String) - Method in class ml.comet.experiment.impl.ApiExperimentImpl.ApiExperimentBuilderImpl

withExperimentName(String) - Method in interface ml.comet.experiment.builder.OnlineExperimentBuilder

Sets the name the experiment.

withLogger(Logger) - Method in interface ml.comet.experiment.builder.BaseCometBuilder

The slf4j Logger through which the instance can log its actions.

withLogger(Logger) - Method in class ml.comet.experiment.impl.ApiExperimentImpl.ApiExperimentBuilderImpl

withMaxAuthRetries(int) - Method in interface ml.comet.experiment.builder.OnlineExperimentBuilder

Set the max auth retry attempts.

withProjectName(String) - Method in interface ml.comet.experiment.builder.OnlineExperimentBuilder

Set project name for the experiment.

withStep(long) - Method in class ml.comet.experiment.context.ExperimentContext.ExperimentContextBuilder

Populates context with specified step of the experiment.

withUrlOverride(String) - Method in interface ml.comet.experiment.builder.OnlineExperimentBuilder

Set the URL of your comet installation.

withWorkspace(String) - Method in interface ml.comet.experiment.builder.OnlineExperimentBuilder

Set workspace for the project.

WORKSPACES - Static variable in class ml.comet.experiment.impl.constants.ApiEndpoints

A B C D E F G H I J L M N O P Q R S T U V W