Skip to content

Commit

Permalink
docs(client-sagemaker-metrics): Update SageMaker Metrics documentation.
Browse files Browse the repository at this point in the history
  • Loading branch information
awstools committed Dec 14, 2022
1 parent 4aa9511 commit 09e09ff
Show file tree
Hide file tree
Showing 4 changed files with 61 additions and 59 deletions.
2 changes: 1 addition & 1 deletion clients/client-sagemaker-metrics/src/SageMakerMetrics.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ import { SageMakerMetricsClient } from "./SageMakerMetricsClient";
*/
export class SageMakerMetrics extends SageMakerMetricsClient {
/**
* <p>Used to ingest training metrics into SageMaker which can be visualized in SageMaker Studio and
* <p>Used to ingest training metrics into SageMaker. These metrics can be visualized in SageMaker Studio and
* retrieved with the <code>GetMetrics</code> API.
* </p>
*/
Expand Down
2 changes: 1 addition & 1 deletion clients/client-sagemaker-metrics/src/commands/BatchPutMetricsCommand.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ export interface BatchPutMetricsCommandInput extends BatchPutMetricsRequest {}
export interface BatchPutMetricsCommandOutput extends BatchPutMetricsResponse, __MetadataBearer {}

/**
* <p>Used to ingest training metrics into SageMaker which can be visualized in SageMaker Studio and
* <p>Used to ingest training metrics into SageMaker. These metrics can be visualized in SageMaker Studio and
* retrieved with the <code>GetMetrics</code> API.
* </p>
* @example
Expand Down
18 changes: 10 additions & 8 deletions clients/client-sagemaker-metrics/src/models/models_0.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -9,12 +9,12 @@ export interface RawMetricData {
MetricName: string | undefined;

/**
* <p>The time when the metric was recorded.</p>
* <p>The time that the metric was recorded.</p>
*/
Timestamp: Date | undefined;

/**
* <p>Metric step (aka Epoch).
* <p>The metric step (epoch).
* </p>
*/
Step?: number;
Expand All @@ -27,7 +27,7 @@ export interface RawMetricData {

export interface BatchPutMetricsRequest {
/**
* <p>The name of Trial Component to associate the metrics with.</p>
* <p>The name of the Trial Component to associate with the metrics.</p>
*/
TrialComponentName: string | undefined;

Expand All @@ -53,19 +53,21 @@ export interface BatchPutMetricsError {
* <ul>
* <li>
* <p>
* <code>METRIC_LIMIT_EXCEEDED</code> - The max amount of metrics per resource has been exceeded.</p>
* <code>METRIC_LIMIT_EXCEEDED</code>: The maximum amount of metrics per resource is
* exceeded.</p>
* </li>
* <li>
* <p>
* <code>INTERNAL_ERROR</code> - An internal error occured.</p>
* <code>INTERNAL_ERROR</code>: An internal error occured.</p>
* </li>
* <li>
* <p>
* <code>VALIDATION_ERROR</code> - The metric data failed validation.</p>
* <code>VALIDATION_ERROR</code>: The metric data failed validation.</p>
* </li>
* <li>
* <p>
* <code>CONFLICT_ERROR</code> - Multiple requests attempted to modify the same data simultaneously.</p>
* <code>CONFLICT_ERROR</code>: Multiple requests attempted to modify the same data
* simultaneously.</p>
* </li>
* </ul>
*/
Expand All @@ -79,7 +81,7 @@ export interface BatchPutMetricsError {

export interface BatchPutMetricsResponse {
/**
* <p>Any errors that occur when inserting metric data will appear in this.</p>
* <p>Lists any errors that occur when inserting metric data.</p>
*/
Errors?: BatchPutMetricsError[];
}
Expand Down
98 changes: 49 additions & 49 deletions codegen/sdk-codegen/aws-models/sagemaker-metrics.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@
"target": "com.amazonaws.sagemakermetrics#BatchPutMetricsResponse"
},
"traits": {
"smithy.api#documentation": "<p>Used to ingest training metrics into SageMaker which can be visualized in SageMaker Studio and\n retrieved with the <code>GetMetrics</code> API.\n </p>",
"smithy.api#documentation": "<p>Used to ingest training metrics into SageMaker. These metrics can be visualized in SageMaker Studio and\n retrieved with the <code>GetMetrics</code> API.\n </p>",
"smithy.api#http": {
"method": "PUT",
"uri": "/BatchPutMetrics",
Expand All @@ -52,7 +52,7 @@
"Code": {
"target": "com.amazonaws.sagemakermetrics#PutMetricsErrorCode",
"traits": {
"smithy.api#documentation": "<p>The error code of an error that occured when attempting to put metrics.</p>\n <ul>\n <li>\n <p>\n <code>METRIC_LIMIT_EXCEEDED</code> - The max amount of metrics per resource has been exceeded.</p>\n </li>\n <li>\n <p>\n <code>INTERNAL_ERROR</code> - An internal error occured.</p>\n </li>\n <li>\n <p>\n <code>VALIDATION_ERROR</code> - The metric data failed validation.</p>\n </li>\n <li>\n <p>\n <code>CONFLICT_ERROR</code> - Multiple requests attempted to modify the same data simultaneously.</p>\n </li>\n </ul>"
"smithy.api#documentation": "<p>The error code of an error that occured when attempting to put metrics.</p>\n <ul>\n <li>\n <p>\n <code>METRIC_LIMIT_EXCEEDED</code>: The maximum amount of metrics per resource is\n exceeded.</p>\n </li>\n <li>\n <p>\n <code>INTERNAL_ERROR</code>: An internal error occured.</p>\n </li>\n <li>\n <p>\n <code>VALIDATION_ERROR</code>: The metric data failed validation.</p>\n </li>\n <li>\n <p>\n <code>CONFLICT_ERROR</code>: Multiple requests attempted to modify the same data\n simultaneously.</p>\n </li>\n </ul>"
}
},
"MetricIndex": {
Expand Down Expand Up @@ -85,7 +85,7 @@
"TrialComponentName": {
"target": "com.amazonaws.sagemakermetrics#ExperimentEntityName",
"traits": {
"smithy.api#documentation": "<p>The name of Trial Component to associate the metrics with.</p>",
"smithy.api#documentation": "<p>The name of the Trial Component to associate with the metrics.</p>",
"smithy.api#required": {}
}
},
Expand All @@ -104,7 +104,7 @@
"Errors": {
"target": "com.amazonaws.sagemakermetrics#BatchPutMetricsErrorList",
"traits": {
"smithy.api#documentation": "<p>Any errors that occur when inserting metric data will appear in this.</p>"
"smithy.api#documentation": "<p>Lists any errors that occur when inserting metric data.</p>"
}
}
}
Expand Down Expand Up @@ -183,14 +183,14 @@
"Timestamp": {
"target": "com.amazonaws.sagemakermetrics#Timestamp",
"traits": {
"smithy.api#documentation": "<p>The time when the metric was recorded.</p>",
"smithy.api#documentation": "<p>The time that the metric was recorded.</p>",
"smithy.api#required": {}
}
},
"Step": {
"target": "com.amazonaws.sagemakermetrics#Step",
"traits": {
"smithy.api#documentation": "<p>Metric step (aka Epoch).\n </p>"
"smithy.api#documentation": "<p>The metric step (epoch).\n </p>"
}
},
"Value": {
Expand Down Expand Up @@ -551,8 +551,8 @@
},
"params": {
"UseFIPS": true,
"UseDualStack": true,
"Region": "us-gov-east-1"
"Region": "us-gov-east-1",
"UseDualStack": true
}
},
{
Expand All @@ -564,8 +564,8 @@
},
"params": {
"UseFIPS": true,
"UseDualStack": false,
"Region": "us-gov-east-1"
"Region": "us-gov-east-1",
"UseDualStack": false
}
},
{
Expand All @@ -577,8 +577,8 @@
},
"params": {
"UseFIPS": false,
"UseDualStack": true,
"Region": "us-gov-east-1"
"Region": "us-gov-east-1",
"UseDualStack": true
}
},
{
Expand All @@ -590,8 +590,8 @@
},
"params": {
"UseFIPS": false,
"UseDualStack": false,
"Region": "us-gov-east-1"
"Region": "us-gov-east-1",
"UseDualStack": false
}
},
{
Expand All @@ -603,8 +603,8 @@
},
"params": {
"UseFIPS": true,
"UseDualStack": true,
"Region": "cn-north-1"
"Region": "cn-north-1",
"UseDualStack": true
}
},
{
Expand All @@ -616,8 +616,8 @@
},
"params": {
"UseFIPS": true,
"UseDualStack": false,
"Region": "cn-north-1"
"Region": "cn-north-1",
"UseDualStack": false
}
},
{
Expand All @@ -629,8 +629,8 @@
},
"params": {
"UseFIPS": false,
"UseDualStack": true,
"Region": "cn-north-1"
"Region": "cn-north-1",
"UseDualStack": true
}
},
{
Expand All @@ -642,8 +642,8 @@
},
"params": {
"UseFIPS": false,
"UseDualStack": false,
"Region": "cn-north-1"
"Region": "cn-north-1",
"UseDualStack": false
}
},
{
Expand All @@ -653,8 +653,8 @@
},
"params": {
"UseFIPS": true,
"UseDualStack": true,
"Region": "us-iso-east-1"
"Region": "us-iso-east-1",
"UseDualStack": true
}
},
{
Expand All @@ -666,8 +666,8 @@
},
"params": {
"UseFIPS": true,
"UseDualStack": false,
"Region": "us-iso-east-1"
"Region": "us-iso-east-1",
"UseDualStack": false
}
},
{
Expand All @@ -677,8 +677,8 @@
},
"params": {
"UseFIPS": false,
"UseDualStack": true,
"Region": "us-iso-east-1"
"Region": "us-iso-east-1",
"UseDualStack": true
}
},
{
Expand All @@ -690,8 +690,8 @@
},
"params": {
"UseFIPS": false,
"UseDualStack": false,
"Region": "us-iso-east-1"
"Region": "us-iso-east-1",
"UseDualStack": false
}
},
{
Expand All @@ -703,8 +703,8 @@
},
"params": {
"UseFIPS": true,
"UseDualStack": true,
"Region": "us-east-1"
"Region": "us-east-1",
"UseDualStack": true
}
},
{
Expand All @@ -716,8 +716,8 @@
},
"params": {
"UseFIPS": true,
"UseDualStack": false,
"Region": "us-east-1"
"Region": "us-east-1",
"UseDualStack": false
}
},
{
Expand All @@ -729,8 +729,8 @@
},
"params": {
"UseFIPS": false,
"UseDualStack": true,
"Region": "us-east-1"
"Region": "us-east-1",
"UseDualStack": true
}
},
{
Expand All @@ -742,8 +742,8 @@
},
"params": {
"UseFIPS": false,
"UseDualStack": false,
"Region": "us-east-1"
"Region": "us-east-1",
"UseDualStack": false
}
},
{
Expand All @@ -753,8 +753,8 @@
},
"params": {
"UseFIPS": true,
"UseDualStack": true,
"Region": "us-isob-east-1"
"Region": "us-isob-east-1",
"UseDualStack": true
}
},
{
Expand All @@ -766,8 +766,8 @@
},
"params": {
"UseFIPS": true,
"UseDualStack": false,
"Region": "us-isob-east-1"
"Region": "us-isob-east-1",
"UseDualStack": false
}
},
{
Expand All @@ -777,8 +777,8 @@
},
"params": {
"UseFIPS": false,
"UseDualStack": true,
"Region": "us-isob-east-1"
"Region": "us-isob-east-1",
"UseDualStack": true
}
},
{
Expand All @@ -790,8 +790,8 @@
},
"params": {
"UseFIPS": false,
"UseDualStack": false,
"Region": "us-isob-east-1"
"Region": "us-isob-east-1",
"UseDualStack": false
}
},
{
Expand All @@ -803,8 +803,8 @@
},
"params": {
"UseFIPS": false,
"UseDualStack": false,
"Region": "us-east-1",
"UseDualStack": false,
"Endpoint": "https://example.com"
}
},
Expand All @@ -815,8 +815,8 @@
},
"params": {
"UseFIPS": true,
"UseDualStack": false,
"Region": "us-east-1",
"UseDualStack": false,
"Endpoint": "https://example.com"
}
},
Expand All @@ -827,8 +827,8 @@
},
"params": {
"UseFIPS": false,
"UseDualStack": true,
"Region": "us-east-1",
"UseDualStack": true,
"Endpoint": "https://example.com"
}
}
Expand Down

0 comments on commit 09e09ff

Please sign in to comment.