ml.comet.experiment.impl.utils

Class CometUtils

java.lang.Object

ml.comet.experiment.impl.utils.CometUtils

public final class CometUtils
extends Object

The common Comet SDK utilities.

Field Summary

Fields

Modifier and Type	Field and Description
static String	COMET_JAVA_SDK_VERSION The current version of the Comet Java SDK.

Constructor Summary

Constructors

Constructor and Description
CometUtils()

Method Summary

Modifier and Type	Method and Description
String	createExperimentLink(String baseUrl, String workspaceName, String projectName, String experimentKey) Creates link to the experiment at Comet.
static Duration	durationOrNull(Long durationMillis) Allows safe conversion of duration in millis into Duration.
static String	fullMetricName(@NonNull String name, @NonNull ExperimentContext context) Creates full name of the metric as it is returned by backend.
static String	generateGUID() Generates global unique identifier in format supported by Comet.ml
static Instant	instantOrNull(Long timestamp) Allows safe conversion of timestamp into Instant.
void	printCometSdkVersion() Prints the current version of the Comet Java SDK.
static <T> void	putNotNull(@NonNull Map<T,String> map, T key, Object value) Puts provided value into the map as string if it is not null.
<T> Set<T>	setFromList(List<T> list) Safe conversion of list to set.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

COMET_JAVA_SDK_VERSION

public static final String COMET_JAVA_SDK_VERSION

The current version of the Comet Java SDK.

Constructor Detail

CometUtils

public CometUtils()

Method Detail

printCometSdkVersion

public void printCometSdkVersion()

Prints the current version of the Comet Java SDK.

createExperimentLink

public String createExperimentLink(String baseUrl,
                                   String workspaceName,
                                   String projectName,
                                   String experimentKey)

Creates link to the experiment at Comet.

Parameters:

baseUrl - the server's base URL

workspaceName - the name of the workspace.

projectName - the name of project

experimentKey - the key of the experiment.

Returns:

the link to the experiment.

generateGUID

public static String generateGUID()

Generates global unique identifier in format supported by Comet.ml

Returns:

the global unique identifier in format supported by Comet.ml.

putNotNull

public static <T> void putNotNull(@NonNull
                                  @NonNull Map<T,String> map,
                                  @NonNull
                                  T key,
                                  Object value)

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

Type Parameters:

T - the type of the key.

Parameters:

map - the container map.

key - the key to use.

value - the optional value.

fullMetricName

public static String fullMetricName(@NonNull
                                    @NonNull String name,
                                    @NonNull
                                    @NonNull ExperimentContext context)

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

Parameters:

name - the short name of the metric

context - the experiment context associated with metric

Returns:

the full name of the metric, which can be prefixed by context ID if present in the provided context parameter.

instantOrNull

public static Instant instantOrNull(Long timestamp)

Allows safe conversion of timestamp into Instant.

Parameters:

timestamp - the time in millis since epoch or null.

Returns:

the instance of Instant or null if timestamp is not set.

durationOrNull

public static Duration durationOrNull(Long durationMillis)

Allows safe conversion of duration in millis into Duration.

Parameters:

durationMillis - the duration in millis since epoch or null.

Returns:

the instance of Duration or null if duration is not set.

setFromList

public <T> Set<T> setFromList(List<T> list)

Safe conversion of list to set.

Type Parameters:

T - the type of the data objects in the list.

Parameters:

list - the list to be converted

Returns:

the set from provided list or empty set if list is null.