Skip navigation links
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.constants.ApiEndpoints
 
ADD_GIT_METADATA - Static variable in class ml.comet.experiment.constants.ApiEndpoints
 
ADD_GRAPH - Static variable in class ml.comet.experiment.constants.ApiEndpoints
 
ADD_HTML - Static variable in class ml.comet.experiment.constants.ApiEndpoints
 
ADD_LOG_OTHER - Static variable in class ml.comet.experiment.constants.ApiEndpoints
 
ADD_METRIC - Static variable in class ml.comet.experiment.constants.ApiEndpoints
 
ADD_OUTPUT - Static variable in class ml.comet.experiment.constants.ApiEndpoints
 
ADD_PARAMETER - Static variable in class ml.comet.experiment.constants.ApiEndpoints
 
ADD_START_END_TIME - Static variable in class ml.comet.experiment.constants.ApiEndpoints
 
ADD_TAG - Static variable in class ml.comet.experiment.constants.ApiEndpoints
 
AddGraphRest - Class in ml.comet.experiment.model
 
AddGraphRest() - Constructor for class ml.comet.experiment.model.AddGraphRest
 
addTag(String) - Method in class ml.comet.experiment.BaseExperiment
 
addTag(String) - Method in interface ml.comet.experiment.Experiment
Adds a tag to this experiment.
AddTagsToExperimentRest - Class in ml.comet.experiment.model
 
AddTagsToExperimentRest() - Constructor for class ml.comet.experiment.model.AddTagsToExperimentRest
 
ApiEndpoints - Class in ml.comet.experiment.constants
Definitions of the Comet API endpoints.
ApiEndpoints() - Constructor for class ml.comet.experiment.constants.ApiEndpoints
 
ApiExperiment - Class in ml.comet.experiment
Implementation of the Experiment that allows to read/update existing experiment.
ApiExperiment.ApiExperimentBuilderImpl - Class in ml.comet.experiment
The builder to create properly configured ApiExperiment instance.
ApiExperimentBuilder - Interface in ml.comet.experiment.builder
Defines the public contract of the factory to create initialized instances of the ApiExperiment.
apply(Response) - Method in class ml.comet.experiment.http.ConnectionUtils.DebugLogResponse
 
applyConfigOverride(File) - Static method in class ml.comet.experiment.config.CometConfig
Uses provided configuration file to override some/all default configuration tree values.
applyConfigOverride(URL) - Static method in class ml.comet.experiment.config.CometConfig
Allows overriding default configuration tree with values parsed from provided URL pointing to the configuration file.
AssetType - Enum in ml.comet.experiment.constants
Represents known types of the assets.

B

BaseCometBuilder<T> - Interface in ml.comet.experiment.builder
Defines public contract of base interface for all experiment builders in the Comet Java SDK.
BaseExperiment - Class in ml.comet.experiment
The base class for all experiment implementations providing implementation of common routines.
BaseExperiment() - Constructor for class ml.comet.experiment.BaseExperiment
 
build() - Method in class ml.comet.experiment.ApiExperiment.ApiExperimentBuilderImpl
 
build() - Method in interface ml.comet.experiment.builder.BaseCometBuilder
Instantiates the Comet experiment instance defined by T.
build() - Method in class ml.comet.experiment.OnlineExperimentImpl.OnlineExperimentBuilderImpl
 
builder(String) - Static method in class ml.comet.experiment.ApiExperiment
Returns builder to create ApiExperiment instance.
builder() - Static method in class ml.comet.experiment.CometApiImpl
Returns builder to be used to properly create instance of this class.
builder() - Static method in class ml.comet.experiment.OnlineExperimentImpl
Returns builder to be used to create properly configured instance of this class.

C

clearConfigOverride() - Static method in class ml.comet.experiment.config.CometConfig
Restores default configuration values if it was overridden previously.
close() - Method in class ml.comet.experiment.CometApiImpl
Release all resources hold by this instance, such as connection to the Comet server.
close() - Method in class ml.comet.experiment.http.Connection
Closes this connection immediately by releasing underlying resources.
close() - Method in class ml.comet.experiment.log.StdOutLogger
Closes this logger and release any hold resources.
COMET_API_KEY - Static variable in class ml.comet.experiment.config.CometConfig
The Comet API key.
COMET_BASE_URL - Static variable in class ml.comet.experiment.config.CometConfig
The Comet's servers base URL.
COMET_JAVA_SDK_VERSION - Static variable in class ml.comet.experiment.utils.CometUtils
The current version of the Comet Java SDK.
COMET_MAX_AUTH_RETRIES - Static variable in class ml.comet.experiment.config.CometConfig
The maximal number of authentication retries against Comet.
COMET_PROJECT_NAME - Static variable in class ml.comet.experiment.config.CometConfig
The Comet project name.
COMET_SDK_API_HEADER - Static variable in class ml.comet.experiment.http.Connection
 
COMET_TIMEOUT_CLEANING_SECONDS - Static variable in class ml.comet.experiment.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.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.
CometApiImpl - Class in ml.comet.experiment
The implementation of the CometApi.
CometConfig - Class in ml.comet.experiment.config
The configuration holder of the Comet Java SDK.
CometConfig() - Constructor for class ml.comet.experiment.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.utils
The common Comet SDK utilities.
CometUtils() - Constructor for class ml.comet.experiment.utils.CometUtils
 
ConfigException - Exception in ml.comet.experiment.config
The exception to be thrown if any configuration issues found.
ConfigException(String, Throwable) - Constructor for exception ml.comet.experiment.config.ConfigException
Constructs a new runtime exception with the specified detail message and cause.
ConfigItem - Class in ml.comet.experiment.config
Represents specific configuration item holding information about key in the configuration file and environment variable key.
ConfigItem() - Constructor for class ml.comet.experiment.config.ConfigItem
 
Connection - Class in ml.comet.experiment.http
Represents connection with the CometML server.
Connection(String, String, int, Logger) - Constructor for class ml.comet.experiment.http.Connection
Creates new instance with specified parameters.
CONNECTION_SHUTDOWN_TIMEOUT_MS - Static variable in class ml.comet.experiment.http.Connection
 
ConnectionInitializer - Class in ml.comet.experiment.http
The factory to build properly initialized connections.
ConnectionInitializer() - Constructor for class ml.comet.experiment.http.ConnectionInitializer
 
ConnectionUtils - Class in ml.comet.experiment.http
Collection of the utilities used by Connection.
ConnectionUtils() - Constructor for class ml.comet.experiment.http.ConnectionUtils
 
ConnectionUtils.DebugLogResponse - Class in ml.comet.experiment.http
The function allowing to debug response.
createExperimentLink(String, String, String, String) - Method in class ml.comet.experiment.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
 
CreateGitMetadata - Class in ml.comet.experiment.model
 
CreateGitMetadata() - Constructor for class ml.comet.experiment.model.CreateGitMetadata
 
createStderrLogger(OnlineExperiment) - Static method in class ml.comet.experiment.log.StdOutLogger
Creates logger instance that captures StdErr stream for a given OnlineExperiment.
createStdoutLogger(OnlineExperiment) - Static method in class ml.comet.experiment.log.StdOutLogger
Creates logger instance that captures StdOut stream for a given OnlineExperiment.

D

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

E

end() - Method in class ml.comet.experiment.ApiExperiment
 
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.OnlineExperimentImpl
 
Experiment - Interface in ml.comet.experiment
Describes the public contract of the Experiment.
EXPERIMENT_STATUS - Static variable in class ml.comet.experiment.constants.ApiEndpoints
 
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
 
ExperimentMetadataRest - Class in ml.comet.experiment.model
 
ExperimentMetadataRest() - Constructor for class ml.comet.experiment.model.ExperimentMetadataRest
 
EXPERIMENTS - Static variable in class ml.comet.experiment.constants.ApiEndpoints
 
ExperimentTimeRequest - Class in ml.comet.experiment.model
 
ExperimentTimeRequest() - Constructor for class ml.comet.experiment.model.ExperimentTimeRequest
 

F

flush() - Method in class ml.comet.experiment.log.StdOutLogger
Flushes this logger by flushing intercepted system stream.
fromJson(String, Class<T>) - Method in class ml.comet.experiment.utils.JsonUtils
 

G

GET_ASSET_INFO - Static variable in class ml.comet.experiment.constants.ApiEndpoints
 
GET_GIT_METADATA - Static variable in class ml.comet.experiment.constants.ApiEndpoints
 
GET_GRAPH - Static variable in class ml.comet.experiment.constants.ApiEndpoints
 
GET_HTML - Static variable in class ml.comet.experiment.constants.ApiEndpoints
 
GET_LOG_OTHER - Static variable in class ml.comet.experiment.constants.ApiEndpoints
 
GET_METADATA - Static variable in class ml.comet.experiment.constants.ApiEndpoints
 
GET_METRICS - Static variable in class ml.comet.experiment.constants.ApiEndpoints
 
GET_OUTPUT - Static variable in class ml.comet.experiment.constants.ApiEndpoints
 
GET_PARAMETERS - Static variable in class ml.comet.experiment.constants.ApiEndpoints
 
GET_TAGS - Static variable in class ml.comet.experiment.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.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.CometApiImpl
 
getAllWorkspaces() - Method in interface ml.comet.experiment.CometApi
Gets all workspaces available for current API key.
getAllWorkspaces() - Method in class ml.comet.experiment.CometApiImpl
 
getAssetList(AssetType) - Method in class ml.comet.experiment.BaseExperiment
 
getAssetList(AssetType) - Method in interface ml.comet.experiment.Experiment
Get experiment asset list.
getConnection() - Method in class ml.comet.experiment.ApiExperiment
 
getConnection() - Method in class ml.comet.experiment.BaseExperiment
Returns connection associated with particular experiment.
getConnection() - Method in class ml.comet.experiment.OnlineExperimentImpl
 
getContext() - Method in class ml.comet.experiment.ApiExperiment
 
getContext() - Method in class ml.comet.experiment.BaseExperiment
Gets the current context as recorded in the Experiment object locally.
getContext() - Method in interface ml.comet.experiment.OnlineExperiment
Gets the current context as recorded in the Experiment object locally.
getContext() - Method in class ml.comet.experiment.OnlineExperimentImpl
 
getDisableHeartBeat() - Method in class ml.comet.experiment.model.CreateExperimentRequest
 
getDuration() - Method in class ml.comet.experiment.config.ConfigItem
Returns value of this item as Duration or throw an ConfigException if value is missing or have wrong type.
getEpoch() - Method in interface ml.comet.experiment.OnlineExperiment
Gets the current epoch as recorded by the Experiment object locally.
getEpoch() - Method in class ml.comet.experiment.OnlineExperimentImpl
 
getExperimentKey() - Method in class ml.comet.experiment.ApiExperiment
 
getExperimentKey() - Method in interface ml.comet.experiment.Experiment
Get the experiment key returned by Comet.
getExperimentKey() - Method in class ml.comet.experiment.OnlineExperimentImpl
 
getExperimentLink() - Method in class ml.comet.experiment.ApiExperiment
 
getExperimentLink() - Method in interface ml.comet.experiment.Experiment
Get the experiment link returned by Comet.
getExperimentLink() - Method in class ml.comet.experiment.OnlineExperimentImpl
 
getExperimentName() - Method in class ml.comet.experiment.ApiExperiment
 
getExperimentName() - Method in interface ml.comet.experiment.Experiment
Get experiment name.
getExperimentName() - Method in class ml.comet.experiment.OnlineExperimentImpl
 
GetExperimentsResponse - Class in ml.comet.experiment.model
 
GetExperimentsResponse() - Constructor for class ml.comet.experiment.model.GetExperimentsResponse
 
getGitMetadata() - Method in class ml.comet.experiment.BaseExperiment
 
getGitMetadata() - Method in interface ml.comet.experiment.Experiment
Get experiment git metadata.
getGraph() - Method in class ml.comet.experiment.BaseExperiment
 
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 class ml.comet.experiment.BaseExperiment
 
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.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
 
getLogger() - Method in class ml.comet.experiment.ApiExperiment
 
getLogger() - Method in class ml.comet.experiment.BaseExperiment
Returns logger instance associated with particular experiment.
getLogger() - Method in class ml.comet.experiment.OnlineExperimentImpl
 
getLogOther() - Method in class ml.comet.experiment.BaseExperiment
 
getLogOther() - Method in interface ml.comet.experiment.Experiment
Get experiment log other data.
getMetadata() - Method in class ml.comet.experiment.BaseExperiment
 
getMetadata() - Method in interface ml.comet.experiment.Experiment
Get experiment metadata.
getMetrics() - Method in class ml.comet.experiment.BaseExperiment
 
getMetrics() - Method in interface ml.comet.experiment.Experiment
Get experiment metrics.
getOptionalString() - Method in class ml.comet.experiment.config.ConfigItem
Returns optional value for this item as string.
getOutput() - Method in class ml.comet.experiment.BaseExperiment
 
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 class ml.comet.experiment.BaseExperiment
 
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 class ml.comet.experiment.ApiExperiment
 
getProjectName() - Method in interface ml.comet.experiment.Experiment
Get project name of the experiment.
GetProjectsResponse - Class in ml.comet.experiment.model
 
GetProjectsResponse() - Constructor for class ml.comet.experiment.model.GetProjectsResponse
 
getStep() - Method in interface ml.comet.experiment.OnlineExperiment
Gets the current step as recorded by the Experiment object locally.
getStep() - Method in class ml.comet.experiment.OnlineExperimentImpl
 
getString() - Method in class ml.comet.experiment.config.ConfigItem
Return value of this item as string or throw an ConfigException if value is missing.
getTags() - Method in class ml.comet.experiment.BaseExperiment
 
getTags() - Method in interface ml.comet.experiment.Experiment
Get experiment tags.
getWorkspaceName() - Method in class ml.comet.experiment.ApiExperiment
 
getWorkspaceName() - Method in interface ml.comet.experiment.Experiment
Get workspace name of the experiment.
GetWorkspacesResponse - Class in ml.comet.experiment.model
 
GetWorkspacesResponse() - Constructor for class ml.comet.experiment.model.GetWorkspacesResponse
 
GitMetadataRest - Class in ml.comet.experiment.model
 
GitMetadataRest() - Constructor for class ml.comet.experiment.model.GitMetadataRest
 

H

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.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.
interceptStdout() - Method in class ml.comet.experiment.OnlineExperimentImpl.OnlineExperimentBuilderImpl
 
isOwner() - Method in class ml.comet.experiment.model.GetProject
 

J

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

L

logCode(String, String) - Method in class ml.comet.experiment.BaseExperiment
 
logCode(File) - Method in class ml.comet.experiment.BaseExperiment
 
logCode(String, String) - 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.
logEndTime(long) - Method in class ml.comet.experiment.BaseExperiment
 
logEndTime(long) - Method in interface ml.comet.experiment.Experiment
Logs the start time of the experiment.
logGitMetadata(CreateGitMetadata) - Method in class ml.comet.experiment.BaseExperiment
 
logGitMetadata(CreateGitMetadata) - Method in interface ml.comet.experiment.Experiment
Logs Git Metadata for the experiment.
logGraph(String) - Method in class ml.comet.experiment.BaseExperiment
 
logGraph(String) - Method in interface ml.comet.experiment.Experiment
Logs a graph to Comet.
logHtml(String, boolean) - Method in class ml.comet.experiment.BaseExperiment
 
logHtml(String, boolean) - Method in interface ml.comet.experiment.Experiment
Allows you to create html report for the experiment.
logLine(String, long, boolean) - Method in interface ml.comet.experiment.OnlineExperiment
Send logs to Comet.
logLine(String, long, boolean) - Method in class ml.comet.experiment.OnlineExperimentImpl
 
logMetric(String, Object, long, long) - Method in class ml.comet.experiment.BaseExperiment
 
logMetric(String, Object, long, long) - Method in interface ml.comet.experiment.Experiment
Logs a metric with Comet.
logMetric(String, Object, long) - Method in interface ml.comet.experiment.OnlineExperiment
Logs a metric with Comet under the current experiment step.
logMetric(String, Object) - Method in interface ml.comet.experiment.OnlineExperiment
 
logMetric(String, Object, long) - Method in class ml.comet.experiment.OnlineExperimentImpl
 
logMetric(String, Object) - Method in class ml.comet.experiment.OnlineExperimentImpl
 
logMetric(String, Object, long, long) - Method in class ml.comet.experiment.OnlineExperimentImpl
 
logOther(String, Object) - Method in class ml.comet.experiment.BaseExperiment
 
logOther(String, Object) - Method in interface ml.comet.experiment.Experiment
Logs a key value pair with Comet.
LogOtherRest - Class in ml.comet.experiment.model
 
LogOtherRest() - Constructor for class ml.comet.experiment.model.LogOtherRest
 
logParameter(String, Object, long) - Method in class ml.comet.experiment.BaseExperiment
 
logParameter(String, Object, long) - Method in interface ml.comet.experiment.Experiment
Logs a param with Comet.
logParameter(String, Object) - Method in interface ml.comet.experiment.OnlineExperiment
Logs a param with Comet under the current experiment step.
logParameter(String, Object) - Method in class ml.comet.experiment.OnlineExperimentImpl
 
logParameter(String, Object, long) - Method in class ml.comet.experiment.OnlineExperimentImpl
 
logStartTime(long) - Method in class ml.comet.experiment.BaseExperiment
 
logStartTime(long) - Method in interface ml.comet.experiment.Experiment
Logs the start time of the experiment.

M

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.config - package ml.comet.experiment.config
Contains all classes allowing to read Comet Java SDK configuration from files and environment.
ml.comet.experiment.constants - package ml.comet.experiment.constants
 
ml.comet.experiment.exception - package ml.comet.experiment.exception
 
ml.comet.experiment.http - package ml.comet.experiment.http
 
ml.comet.experiment.log - package ml.comet.experiment.log
 
ml.comet.experiment.model - package ml.comet.experiment.model
 
ml.comet.experiment.utils - package ml.comet.experiment.utils
 

N

NEW_EXPERIMENT - Static variable in class ml.comet.experiment.constants.ApiEndpoints
 
nextEpoch() - Method in interface ml.comet.experiment.OnlineExperiment
Increments the epoch that the experiment is on.
nextEpoch() - Method in class ml.comet.experiment.OnlineExperimentImpl
 
nextStep() - Method in interface ml.comet.experiment.OnlineExperiment
Increments the step that the experiment is on.
nextStep() - Method in class ml.comet.experiment.OnlineExperimentImpl
 

O

OnlineExperiment - Interface in ml.comet.experiment
Describes the public contract of the online experiment which extends functionality of the Experiment by providing additional methods to log various parameters in real time.
OnlineExperimentBuilder - Interface in ml.comet.experiment.builder
Defines the public contract of the OnlineExperiment builder.
OnlineExperimentImpl - Class in ml.comet.experiment
The implementation of the OnlineExperiment.
OnlineExperimentImpl() - Constructor for class ml.comet.experiment.OnlineExperimentImpl
Default constructor which reads all configuration parameters of the experiment either from configuration file or from environment variables.
OnlineExperimentImpl.OnlineExperimentBuilderImpl - Class in ml.comet.experiment
The builder to create properly configured instance of the OnlineExperimentImpl.
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.constants.QueryParamName
 
printCometSdkVersion() - Method in class ml.comet.experiment.utils.CometUtils
Prints the current version of the Comet Java SDK.
PROJECTS - Static variable in class ml.comet.experiment.constants.ApiEndpoints
 

Q

QueryParamName - Enum in ml.comet.experiment.constants
The enumeration of all known query parameter names.

R

READ_API_URL - Static variable in class ml.comet.experiment.constants.ApiEndpoints
 
readProperties(String) - Static method in class ml.comet.experiment.utils.ResourceUtils
Allows reading properties from bundled resources.
REQUEST_TIMEOUT_MS - Static variable in class ml.comet.experiment.http.Connection
 
ResourceUtils - Class in ml.comet.experiment.utils
Collection of utilities to access bundled resource files.
ResourceUtils() - Constructor for class ml.comet.experiment.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.log.StdOutLogger
 

S

sendGet(String, Map<QueryParamName, String>) - Method in class ml.comet.experiment.http.Connection
Allows sending synchronous GET request to the specified endpoint with given request parameters.
sendHeartbeat() - Method in class ml.comet.experiment.OnlineExperimentImpl
 
sendPost(String, String, boolean) - Method in class ml.comet.experiment.http.Connection
Allows sending POST to the specified endpoint with body as JSON string.
sendPostAsync(Object, String) - Method in class ml.comet.experiment.http.Connection
Allows asynchronous sending given object as JSON encoded body of the POST request.
sendPostAsync(String, String) - Method in class ml.comet.experiment.http.Connection
Allows asynchronous sending of text as JSON encoded body of the POST request.
sendPostAsync(File, String, Map<QueryParamName, String>) - Method in class ml.comet.experiment.http.Connection
Allows asynchronous posting the content of the file as multipart form data to the specified endpoint.
sendPostAsync(byte[], String, Map<QueryParamName, String>) - Method in class ml.comet.experiment.http.Connection
Allows asynchronous sending of provided byte array as POST request to the specified endpoint.
setContext(String) - Method in interface ml.comet.experiment.OnlineExperiment
Sets the context for any logs and uploaded files.
setContext(String) - Method in class ml.comet.experiment.OnlineExperimentImpl
 
setCurrent(String, Long, String, Long) - Method in class ml.comet.experiment.model.ValueMinMaxDto
 
setEpoch(long) - Method in interface ml.comet.experiment.OnlineExperiment
Sets the current epoch for the experiment.
setEpoch(long) - Method in class ml.comet.experiment.OnlineExperimentImpl
 
setExperimentName(String) - Method in class ml.comet.experiment.BaseExperiment
 
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 interface ml.comet.experiment.OnlineExperiment
Turn on intercept of stdout and stderr and the logging of both in Comet.
setInterceptStdout() - Method in class ml.comet.experiment.OnlineExperimentImpl
 
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 interface ml.comet.experiment.OnlineExperiment
Sets the current step for the experiment.
setStep(long) - Method in class ml.comet.experiment.OnlineExperimentImpl
 
setUserOnTeamForProject(boolean) - Method in class ml.comet.experiment.model.GetProject
 
StdOutLogger - Class in ml.comet.experiment.log
The logger to capture StdOut/StdErr streams and log collected text to the Comet.
stopInterceptStdout() - Method in interface ml.comet.experiment.OnlineExperiment
Turn off intercept of stdout and stderr and turns off their logging in Comet.
stopInterceptStdout() - Method in class ml.comet.experiment.OnlineExperimentImpl
 

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.utils.JsonUtils
 
toString() - Method in class ml.comet.experiment.config.ConfigItem
 
toString() - Method in enum ml.comet.experiment.constants.AssetType
 
toString() - Method in enum ml.comet.experiment.constants.QueryParamName
 
type() - Method in enum ml.comet.experiment.constants.AssetType
Returns type of the asset as string.

U

UPDATE_API_URL - Static variable in class ml.comet.experiment.constants.ApiEndpoints
 
uploadAsset(File, String, boolean, long, long) - Method in class ml.comet.experiment.BaseExperiment
 
uploadAsset(File, boolean, long, long) - Method in class ml.comet.experiment.BaseExperiment
 
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, long, long) - Method in interface ml.comet.experiment.Experiment
 
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
 
uploadAsset(File, String, boolean, long) - Method in class ml.comet.experiment.OnlineExperimentImpl
 
uploadAsset(File, boolean) - Method in class ml.comet.experiment.OnlineExperimentImpl
 
uploadAsset(File, String, boolean) - Method in class ml.comet.experiment.OnlineExperimentImpl
 

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.constants.AssetType
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum ml.comet.experiment.constants.QueryParamName
Returns the enum constant of this type with the specified name.
values() - Static method in enum ml.comet.experiment.constants.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.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.http.Connection
Allows to properly close this connection after all scheduled posts request are executed or if timeout expired.
withApiKey(String) - Method in class ml.comet.experiment.ApiExperiment.ApiExperimentBuilderImpl
 
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.OnlineExperimentImpl.OnlineExperimentBuilderImpl
 
withConfigOverride(File) - Method in class ml.comet.experiment.ApiExperiment.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.OnlineExperimentImpl.OnlineExperimentBuilderImpl
 
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.OnlineExperimentImpl.OnlineExperimentBuilderImpl
 
withExperimentName(String) - Method in interface ml.comet.experiment.builder.OnlineExperimentBuilder
Sets the name the experiment.
withExperimentName(String) - Method in class ml.comet.experiment.OnlineExperimentImpl.OnlineExperimentBuilderImpl
 
withLogger(Logger) - Method in class ml.comet.experiment.ApiExperiment.ApiExperimentBuilderImpl
 
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.OnlineExperimentImpl.OnlineExperimentBuilderImpl
 
withMaxAuthRetries(int) - Method in interface ml.comet.experiment.builder.OnlineExperimentBuilder
Set the max auth retry attempts.
withMaxAuthRetries(int) - Method in class ml.comet.experiment.OnlineExperimentImpl.OnlineExperimentBuilderImpl
 
withProjectName(String) - Method in interface ml.comet.experiment.builder.OnlineExperimentBuilder
Set project name for the experiment.
withProjectName(String) - Method in class ml.comet.experiment.OnlineExperimentImpl.OnlineExperimentBuilderImpl
 
withUrlOverride(String) - Method in interface ml.comet.experiment.builder.OnlineExperimentBuilder
Set the URL of your comet installation.
withUrlOverride(String) - Method in class ml.comet.experiment.OnlineExperimentImpl.OnlineExperimentBuilderImpl
 
withWorkspace(String) - Method in interface ml.comet.experiment.builder.OnlineExperimentBuilder
Set workspace for the project.
withWorkspace(String) - Method in class ml.comet.experiment.OnlineExperimentImpl.OnlineExperimentBuilderImpl
 
WORKSPACES - Static variable in class ml.comet.experiment.constants.ApiEndpoints
 
A B C D E F G H I J L M N O P Q R S T U V W 
Skip navigation links

Copyright © 2021. All rights reserved.