ml.comet.experiment.impl.utils

Class RestApiUtils

java.lang.Object

ml.comet.experiment.impl.utils.RestApiUtils

public class RestApiUtils
extends Object

The common factory methods to create initialized DTO instances used in REST API.

Constructor Summary

Constructors

Constructor and Description
RestApiUtils()

Method Summary

Modifier and Type	Method and Description
static Map<QueryParamName,String>	artifactDownloadAssetParams(@NonNull DownloadArtifactAssetOptions options, @NonNull String experimentKey) Extracts query parameters from provided DownloadArtifactAssetOptions to be used to download specific asset associated with Comet artifact.
static Map<QueryParamName,String>	artifactVersionDetailsParams(@NonNull GetArtifactOptions options, @NonNull String experimentKey) Extracts query parameters from provided GetArtifactOptions object to be used for getting details about particular artifact version.
static Map<QueryParamName,String>	artifactVersionFilesParams(@NonNull GetArtifactOptions options) Extracts query parameters from provided GetArtifactOptions object to be used for getting list of assets associated with particular artifact.
static Map<FormParamName,Object>	assetFormParameters(@NonNull Asset asset) Extracts form parameters from the provided Asset.
static Map<QueryParamName,String>	assetQueryParameters(@NonNull AssetImpl asset, @NonNull String experimentKey) Extracts query parameters from the provided Asset.
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 RegistryModelNotesUpdateRequest	createRegistryModelNotesUpdateRequest(String notes, String registryName, String workspace) Creates request to create/update notes of the registry model.
static RegistryModelUpdateRequest	createRegistryModelUpdateRequest(String registryModelName, String description, Boolean isPublic) Creates request to update the registry model.
static AddExperimentTagsRest	createTagRequest(@NonNull String tag) The factory to create AddExperimentTagsRest instance.
static Map<QueryParamName,String>	downloadModelParams(@NonNull String workspace, @NonNull String registryName, @NonNull DownloadModelOptions options) Creates query parameters to be used to download model from the Comet registry.
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

RestApiUtils

public RestApiUtils()

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.

createRegistryModelNotesUpdateRequest

public static RegistryModelNotesUpdateRequest createRegistryModelNotesUpdateRequest(String notes,
                                                                                    String registryName,
                                                                                    String workspace)

Creates request to create/update notes of the registry model.

Parameters:

notes - the notes to be created.

registryName - the registry model name.

workspace - the workspace name.

Returns:

the properly initialized instance of RegistryModelNotesUpdateRequest.

createRegistryModelUpdateRequest

public static RegistryModelUpdateRequest createRegistryModelUpdateRequest(String registryModelName,
                                                                          String description,
                                                                          Boolean isPublic)

Creates request to update the registry model.

Parameters:

registryModelName - the new name for the model.

description - the new description for the model.

isPublic - the flag to change visibility status of the model.

Returns:

the property initialized instance of RegistryModelUpdateRequest.

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.

downloadModelParams

public static Map<QueryParamName,String> downloadModelParams(@NonNull
                                                             @NonNull String workspace,
                                                             @NonNull
                                                             @NonNull String registryName,
                                                             @NonNull
                                                             @NonNull DownloadModelOptions options)

Creates query parameters to be used to download model from the Comet registry.

Parameters:

workspace - the name of the model's workspace.

registryName - the model's name in the registry.

options - the additional download options.

Returns:

the map with query parameters.

assetQueryParameters

public static Map<QueryParamName,String> assetQueryParameters(@NonNull
                                                              @NonNull AssetImpl asset,
                                                              @NonNull
                                                              @NonNull String experimentKey)

Extracts query parameters from the provided Asset.

Parameters:

asset - the AssetImpl to extract HTTP query parameters from.

experimentKey - the key of the Comet experiment.

Returns:

the map with query parameters.

assetFormParameters

public static Map<FormParamName,Object> assetFormParameters(@NonNull
                                                            @NonNull Asset asset)

Extracts form parameters from the provided Asset.

Parameters:

asset - the Asset to extract HTTP form parameters from.

Returns:

the map with form parameters.

artifactVersionDetailsParams

public static Map<QueryParamName,String> artifactVersionDetailsParams(@NonNull
                                                                      @NonNull GetArtifactOptions options,
                                                                      @NonNull
                                                                      @NonNull String experimentKey)

Extracts query parameters from provided GetArtifactOptions object to be used for getting details about particular artifact version.

Parameters:

options - the GetArtifactOptions

experimentKey - the current experiment's key

Returns:

the map with query parameters.

artifactVersionFilesParams

public static Map<QueryParamName,String> artifactVersionFilesParams(@NonNull
                                                                    @NonNull GetArtifactOptions options)

Extracts query parameters from provided GetArtifactOptions object to be used for getting list of assets associated with particular artifact.

Parameters:

options - the GetArtifactOptions

Returns:

the map with query parameters.

artifactDownloadAssetParams

public static Map<QueryParamName,String> artifactDownloadAssetParams(@NonNull
                                                                     @NonNull DownloadArtifactAssetOptions options,
                                                                     @NonNull
                                                                     @NonNull String experimentKey)

Extracts query parameters from provided DownloadArtifactAssetOptions to be used to download specific asset associated with Comet artifact.

Parameters:

options - the DownloadArtifactAssetOptions

experimentKey - the current experiment's key

Returns:

the map with query parameters.