ml.comet.experiment.impl.utils

Class DataModelUtils

java.lang.Object

ml.comet.experiment.impl.utils.DataModelUtils

public class DataModelUtils
extends Object

The common factory methods to create initialized model DTO instances.

Constructor Summary

Constructors

Constructor and Description
DataModelUtils()

Method Summary

Modifier and Type	Method and Description
static ArtifactRequest	createArtifactUpsertRequest(ArtifactImpl artifact) The factory to create ArtifactRequest instance to be used to upsert Comet artifact.
static ArtifactRequest	createArtifactVersionStateRequest(String artifactVersionId, ArtifactVersionState state) Creates request to signal the state of the artifact version send operation.
static GitMetadataRest	createGitMetadataRequest(GitMetaData metaData) The factory to create GitMetadataRest request instance.
static AddGraphRest	createGraphRequest(@NonNull String graph) The factory to create AddGraphRest instance.
static ExperimentTimeRequest	createLogEndTimeRequest(long endTimeMillis) The factory to create ExperimentTimeRequest instance.
static HtmlRest	createLogHtmlRequest(@NonNull String html, boolean override) The factory to create HtmlRest instance.
static OutputUpdate	createLogLineRequest(@NonNull String line, long offset, boolean stderr, String context) The factory to create OutputUpdate instance.
static MetricRest	createLogMetricRequest(@NonNull String metricName, @NonNull Object metricValue, @NonNull ExperimentContext context) The factory to create MetricRest instance.
static LogOtherRest	createLogOtherRequest(@NonNull String key, @NonNull Object value) The factory to create LogOtherRest instance.
static ParameterRest	createLogParamRequest(@NonNull String parameterName, @NonNull Object paramValue, @NonNull ExperimentContext context) The factory to create ParameterRest instance.
static ExperimentTimeRequest	createLogStartTimeRequest(long startTimeMillis) The factory to create ExperimentTimeRequest instance.
static RegistryModelCreateRequest	createRegistryModelCreateRequest(RegistryModelImpl model) Prepares request to create new registry record of the model associated with particular experiment.
static RegistryModelItemCreateRequest	createRegistryModelItemCreateRequest(RegistryModelImpl model) Prepares request which can be used to update the existing registry record of the model associated with particular experiment.
static AddExperimentTagsRest	createTagRequest(@NonNull String tag) The factory to create AddExperimentTagsRest instance.
Map<String,Object>	metadataFromJson(String json) Converts JSON encoded metadata into Map object.

Methods inherited from class java.lang.Object

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

Constructor Detail

DataModelUtils

public DataModelUtils()

Method Detail

createLogMetricRequest

public static MetricRest createLogMetricRequest(@NonNull
                                                @NonNull String metricName,
                                                @NonNull
                                                @NonNull Object metricValue,
                                                @NonNull
                                                @NonNull ExperimentContext context)

The factory to create MetricRest instance.

Parameters:

metricName - the metric name

metricValue - the metric value

context - the current context

Returns:

the initialized MetricRest instance.

createLogParamRequest

public static ParameterRest createLogParamRequest(@NonNull
                                                  @NonNull String parameterName,
                                                  @NonNull
                                                  @NonNull Object paramValue,
                                                  @NonNull
                                                  @NonNull ExperimentContext context)

The factory to create ParameterRest instance.

Parameters:

parameterName - the name of the parameter

paramValue - the value of the parameter

context - the current context

Returns:

the initialized ParameterRest instance.

createLogLineRequest

public static OutputUpdate createLogLineRequest(@NonNull
                                                @NonNull String line,
                                                long offset,
                                                boolean stderr,
                                                String context)

The factory to create OutputUpdate instance.

Parameters:

line - the log line

offset - the log line offset

stderr - the flag to indicate if it's from StdErr

context - the current context

Returns:

the initialized OutputUpdate instance.

createLogHtmlRequest

public static HtmlRest createLogHtmlRequest(@NonNull
                                            @NonNull String html,
                                            boolean override)

The factory to create HtmlRest instance.

Parameters:

html - the HTML code to be logged.

override - the flag to indicate whether it should override already saved version.

Returns:

the initialized HtmlRest instance.

createLogOtherRequest

public static LogOtherRest createLogOtherRequest(@NonNull
                                                 @NonNull String key,
                                                 @NonNull
                                                 @NonNull Object value)

The factory to create LogOtherRest instance.

Parameters:

key - the parameter name/key.

value - the parameter value.

Returns:

the initialized LogOtherRest instance.

createTagRequest

public static AddExperimentTagsRest createTagRequest(@NonNull
                                                     @NonNull String tag)

The factory to create AddExperimentTagsRest instance.

Parameters:

tag - the tag value

Returns:

the initialized AddExperimentTagsRest instance

createGraphRequest

public static AddGraphRest createGraphRequest(@NonNull
                                              @NonNull String graph)

The factory to create AddGraphRest instance.

Parameters:

graph - the NN graph representation.

Returns:

the initialized AddGraphRest instance.

createLogStartTimeRequest

public static ExperimentTimeRequest createLogStartTimeRequest(long startTimeMillis)

The factory to create ExperimentTimeRequest instance.

Parameters:

startTimeMillis - the experiment's start time in milliseconds.

Returns:

the initialized ExperimentTimeRequest instance.

createLogEndTimeRequest

public static ExperimentTimeRequest createLogEndTimeRequest(long endTimeMillis)

The factory to create ExperimentTimeRequest instance.

Parameters:

endTimeMillis - the experiment's end time in milliseconds.

Returns:

the initialized ExperimentTimeRequest instance.

createGitMetadataRequest

public static GitMetadataRest createGitMetadataRequest(GitMetaData metaData)

The factory to create GitMetadataRest request instance.

Parameters:

metaData - the GitMetaData model object from public API.

Returns:

the initialized GitMetadataRest instance.

createArtifactUpsertRequest

public static ArtifactRequest createArtifactUpsertRequest(ArtifactImpl artifact)

The factory to create ArtifactRequest instance to be used to upsert Comet artifact.

Parameters:

artifact - the ArtifactImpl instance.

Returns:

the initialized ArtifactRequest instance.

createArtifactVersionStateRequest

public static ArtifactRequest createArtifactVersionStateRequest(String artifactVersionId,
                                                                ArtifactVersionState state)

Creates request to signal the state of the artifact version send operation.

Parameters:

artifactVersionId - the identifier of the artifact version.

state - the ArtifactVersionState signaling state of the operation.

Returns:

the properly initialized ArtifactRequest instance.

createRegistryModelCreateRequest

public static RegistryModelCreateRequest createRegistryModelCreateRequest(RegistryModelImpl model)

Prepares request to create new registry record of the model associated with particular experiment.

Parameters:

model - the RegistryModelImpl instance holding all required data.

Returns:

the properly initialized instance of RegistryModelCreateRequest.

createRegistryModelItemCreateRequest

public static RegistryModelItemCreateRequest createRegistryModelItemCreateRequest(RegistryModelImpl model)

Prepares request which can be used to update the existing registry record of the model associated with particular experiment.

Parameters:

model - the RegistryModelImpl instance holding all required data.

Returns:

the properly initialized instance of RegistryModelItemCreateRequest.

metadataFromJson

public Map<String,Object> metadataFromJson(String json)

Converts JSON encoded metadata into Map object.

Parameters:

json - the JSON encoded metadata string.

Returns:

the instance of the Map object.