feat(stepfunctions-tasks): add support for ModelClientConfig to SageMakerCreateTransformJob #11892

setu4993 · 2020-12-06T05:15:00Z

Noticed support for ModelClientConfig was missing from this particular type of job, so attempted to add it.

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license

gitpod-io · 2020-12-06T05:15:03Z

setu4993 · 2020-12-06T05:17:33Z

packages/@aws-cdk/aws-stepfunctions-tasks/lib/sagemaker/create-transform-job.ts

+  /**
+   * Configures the timeout and maximum number of retries for processing a transform job invocation.
+   *
+   * @default


No default value is specified on the API page or the description page for the ModelClientConfig.

I have observed that the default value for InvocationsMaxRetries is 3 in practice, and InvocationsTimeoutInSeconds is less than 1200 (not sure about the exact value), but could be wrong.

rather than Config, we use the suffix Options to specify a bag of properties within the CDK.
perhaps this property type should be called ModelClientOptions and the property modelClientOptions

I'd say that's the value we should document as the default text - if it's not documented we should deploy it and find out :)

setu4993 · 2020-12-06T22:41:58Z

@shivlaks : The tests are succeeding now and this PR is ready for review. Looking forward to your recommendations on making this better.

packages/@aws-cdk/aws-stepfunctions-tasks/lib/sagemaker/create-transform-job.ts

packages/@aws-cdk/aws-stepfunctions-tasks/lib/sagemaker/base-types.ts

shivlaks · 2020-12-09T05:59:39Z

packages/@aws-cdk/aws-stepfunctions-tasks/lib/sagemaker/create-transform-job.ts

+  /**
+   * Configures the timeout and maximum number of retries for processing a transform job invocation.
+   *
+   * @default


rather than Config, we use the suffix Options to specify a bag of properties within the CDK.
perhaps this property type should be called ModelClientOptions and the property modelClientOptions

shivlaks · 2020-12-09T06:00:13Z

packages/@aws-cdk/aws-stepfunctions-tasks/lib/sagemaker/create-transform-job.ts

+  /**
+   * Configures the timeout and maximum number of retries for processing a transform job invocation.
+   *
+   * @default


I'd say that's the value we should document as the default text - if it's not documented we should deploy it and find out :)

packages/@aws-cdk/aws-stepfunctions-tasks/lib/sagemaker/create-transform-job.ts

packages/@aws-cdk/aws-stepfunctions-tasks/README.md

packages/@aws-cdk/aws-stepfunctions-tasks/test/sagemaker/create-transform-job.test.ts

shivlaks · 2020-12-09T06:03:47Z

packages/@aws-cdk/aws-stepfunctions-tasks/lib/sagemaker/create-transform-job.ts

+   *
+   * @default
+   */
+  readonly modelClientConfig?: ModelClientConfig;


is it possible to specify this property through state input? (i.e. a string that says $.field - if so we might need an enum like class here. if not, you can disregard this comment.

setu4993 · 2020-12-10T06:58:56Z

Thanks for your feedback, @shivlaks! Will update the PR shortly with your recommendations.

…teTransformJob

Pull request has been modified.

shivlaks

@setu4993 thanks for the fast turnaround!! - couple of small suggestions.
take a look and let me know if you have any questions. we should be able to get this one merged soon :)

packages/@aws-cdk/aws-stepfunctions-tasks/lib/sagemaker/base-types.ts

shivlaks · 2020-12-10T18:52:45Z

packages/@aws-cdk/aws-stepfunctions-tasks/lib/sagemaker/create-transform-job.ts

+  private renderModelClientOptions(config: ModelClientOptions): { [key: string]: any } {
+    return {
+      ModelClientConfig: {
+        InvocationsMaxRetries: config.invocationsMaxRetries ?? 0,


i don't think we should explicitly set retries to zero. it feels like a bad default, we should let the service defaults take over (which I think is 3?)

0 is actually the default for retries. Typically, after the first try fails, the job fails. I just ran into it today and so had a chance to confirm it :).

How do you recommend we let the service defaults take over? The reason I added those was to avoid the case when one of invocationsMaxRetries or invocationsTimeout was set, but not both. That is the only case when it would get to this function. Maybe simply replace this with: InvocationsMaxRetries: config.invocationsMaxRetries? would do it?

~~Updated these to InvocationsMaxRetries: config.invocationsMaxRetries? and similar for the timeout. So, CDK doesn't set the default values but lets the service-level defaults take over.~~

Had to revert this because it was failing builds.

Would appreciate any recommendation you have on what to do here given 0 is the default at the service-level.

would it make sense to set it after some basic validation? - i.e. it exists, and is greater than 0? - otherwise, I think it should be fine if the service defaults are 0. wdyt?

Agree, it should also be < 3, so I can add validations for both > 0 and < 3 to it later today.

shivlaks · 2020-12-10T18:53:31Z

packages/@aws-cdk/aws-stepfunctions-tasks/lib/sagemaker/create-transform-job.ts

+    return {
+      ModelClientConfig: {
+        InvocationsMaxRetries: config.invocationsMaxRetries ?? 0,
+        InvocationsTimeoutInSeconds: config.invocationsTimeout?.toSeconds() ?? 300,


similar comment here, rather than explicitly setting one, we should fall back to the service defaults? If it's 300, we're only documenting that behaviour but not explicitly setting it

Makes sense. I was trying to avoid the corner case when only 1 of them is defined. I can update these values based on what I've observed from practice.

is 3 the limit on retries? I was just thinking the > 0 part for validation

Yes, 3 is the limit on the number of retries.

Valid Range: Minimum value of 0. Maximum value of 3.

Pull request has been modified.

setu4993 · 2020-12-11T07:30:47Z

@shivlaks : Updated the defaults based on what I observed over a couple batch transform jobs I had a chance to run today. The defaults appear to be 0 retries with 60 second timeout (same as for a SageMaker endpoint).

Docs from the endpoint page:

A customer's model containers must respond to requests within 60 seconds. The model itself can have a maximum processing time of 60 seconds before responding to invocations. If your model is going to take 50-60 seconds of processing time, the SDK socket timeout should be set to be 70 seconds.

…ent-config

setu4993 · 2020-12-15T04:25:58Z

packages/@aws-cdk/aws-stepfunctions-tasks/lib/sagemaker/create-transform-job.ts

+    const retries = config.invocationsMaxRetries;
+    if (retries? (retries < 0 || retries > 3): false) {
+      throw new RangeError(`invocationsMaxRetries should be between 0 and 3, not ${retries}.`);
+    }
+    const timeout = config.invocationsTimeout?.toSeconds();
+    if (timeout? (timeout < 1 || timeout > 3600): false) {
+      throw new RangeError(`invocationsTimeout should be between 1 and 3600 seconds, not ${timeout}.`);
+    }


Added validation for both the properties based on what is documented on the API page.

shivlaks

almost there! one last thing regarding tokens.
check out my comment and let me know if you have any questions there.

packages/@aws-cdk/aws-stepfunctions-tasks/lib/sagemaker/create-transform-job.ts

shivlaks · 2020-12-15T06:23:44Z

packages/@aws-cdk/aws-stepfunctions-tasks/lib/sagemaker/create-transform-job.ts

@@ -173,6 +181,23 @@ export class SageMakerCreateTransformJob extends sfn.TaskStateBase {
    };
  }

+  private renderModelClientOptions(config: ModelClientOptions): { [key: string]: any } {
+    const retries = config.invocationsMaxRetries;
+    if (retries? (retries < 0 || retries > 3): false) {


these values may be represented as tokens (i.e. if they're passed in as parameters to the stack). we can only validate if they're not tokens, so we would want to add a check that !Token.isUnResolved(retries) before proceeding with the check

checkout Token.isUnresolved in the repo for a few examples.
Same comment applies to the timeout.

Co-authored-by: Shiv Lakshminarayan <shivlaks@amazon.com>

Pull request has been modified.

shivlaks

@setu4993 thanks for contributing!!

mergify · 2020-12-15T18:06:09Z

Thank you for contributing! Your pull request will be updated from master and then merged automatically (do not update manually, and be sure to allow changes to be pushed to your fork).

…ent-config

aws-cdk-automation · 2020-12-15T18:40:57Z

AWS CodeBuild CI Report

CodeBuild project: AutoBuildProject6AEA49D1-qxepHUsryhcu
Commit ID: 1eee0da
Result: SUCCEEDED
Build Logs (available for 30 days)

Powered by github-codebuild-logs, available on the AWS Serverless Application Repository

mergify · 2020-12-15T18:48:22Z

Thank you for contributing! Your pull request will be updated from master and then merged automatically (do not update manually, and be sure to allow changes to be pushed to your fork).

setu4993 · 2020-12-15T19:03:32Z

Thanks for your support on this, @shivlaks!

…akerCreateTransformJob (aws#11892) Noticed support for [ModelClientConfig](https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateTransformJob.html#sagemaker-CreateTransformJob-request-ModelClientConfig) was missing from this particular type of job, so attempted to add it. ---- *By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*

github-actions bot added the @aws-cdk/aws-stepfunctions-tasks label Dec 6, 2020

github-actions bot assigned shivlaks Dec 6, 2020

setu4993 commented Dec 6, 2020

View reviewed changes

setu4993 commented Dec 7, 2020

View reviewed changes

packages/@aws-cdk/aws-stepfunctions-tasks/lib/sagemaker/create-transform-job.ts Show resolved Hide resolved

shivlaks previously requested changes Dec 9, 2020

View reviewed changes

shivlaks changed the title ~~feat(aws-stepfunctions-tasks): add support for ModelClientConfig to SageMakerCreateTransformJob~~ feat(stepfunctions-tasks): add support for ModelClientConfig to SageMakerCreateTransformJob Dec 9, 2020

setu4993 added 18 commits December 10, 2020 07:31

feat(aws-stepfunctions-tasks): add ModelClientConfig type

4155cda

feat(aws-stepfunctions-tasks): use ModelClientConfig in SageMakerCrea…

a565a56

…teTransformJob

test(aws-stepfunctions-tasks): add modelClientConfig to complex job test

5c75b74

docs(aws-stepfunctions-tasks): add modelClientConfig to readme example

072ec42

test(aws-stepfunctions-tasks): return number for invocationTimeout

94e716f

alphabetize import

2e4733f

use number for type instead any

c58b965

moving all render logic to render method

f7e26ad

handle optional args better

b2f78ba

handle optional config

2c8939f

fix parsing of modelClientConfig

4c92ae2

docs(aws-stepfunctions-tasks): fix incorrect references to training

89f4f1d

rename, fix comment, add default values

ceb0d92

rename modelClientConfig to modelClientOptions

85a5d76

set default values if they are not provided

de2d77d

update test with renamed var, use minutes instead for duration

b361a0d

rename method

a08d889

Add default values

1244b37

setu4993 force-pushed the feature/step-functions-transform-model-client-config branch from 281fa26 to 1244b37 Compare December 10, 2020 07:32

setu4993 requested a review from shivlaks December 10, 2020 08:06

shivlaks previously requested changes Dec 10, 2020

View reviewed changes

update with observed default values

fb5e260

setu4993 added 3 commits December 10, 2020 23:31

Merge branch 'master' into feature/step-functions-transform-model-cli…

ce88f4e

…ent-config

fixup

ff520da

Merge branch 'master' into feature/step-functions-transform-model-cli…

525f5a4

…ent-config

setu4993 requested a review from shivlaks December 14, 2020 07:18

setu4993 added 4 commits December 14, 2020 19:19

check range of invocationMaxRetries

bc824e8

remove newline, add missing ;

52d8cf3

validate timeout

a2080fc

only check lt, gt, skip =

079884e

setu4993 commented Dec 15, 2020

View reviewed changes

shivlaks previously requested changes Dec 15, 2020

View reviewed changes

use Error instead of RangeError

6fbcfcb

Co-authored-by: Shiv Lakshminarayan <shivlaks@amazon.com>

setu4993 added 3 commits December 15, 2020 07:59

rename config to options

c0260d2

replace RangeError with Error

46edddc

check if token can be resolved

fa68057

shivlaks approved these changes Dec 15, 2020

View reviewed changes

Merge branch 'master' into feature/step-functions-transform-model-cli…

1eee0da

…ent-config

mergify bot merged commit bf05092 into aws:master Dec 15, 2020

setu4993 deleted the feature/step-functions-transform-model-client-config branch December 15, 2020 19:03

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(stepfunctions-tasks): add support for ModelClientConfig to SageMakerCreateTransformJob #11892

feat(stepfunctions-tasks): add support for ModelClientConfig to SageMakerCreateTransformJob #11892

setu4993 commented Dec 6, 2020

gitpod-io bot commented Dec 6, 2020 •

edited

Loading

setu4993 Dec 6, 2020

shivlaks Dec 9, 2020

shivlaks Dec 9, 2020

setu4993 commented Dec 6, 2020

shivlaks Dec 9, 2020

shivlaks Dec 9, 2020

shivlaks Dec 9, 2020

setu4993 commented Dec 10, 2020

shivlaks left a comment

shivlaks Dec 10, 2020

setu4993 Dec 11, 2020

setu4993 Dec 11, 2020

setu4993 Dec 11, 2020 •

edited

Loading

shivlaks Dec 14, 2020

setu4993 Dec 14, 2020

shivlaks Dec 10, 2020

setu4993 Dec 11, 2020

shivlaks Dec 15, 2020

setu4993 Dec 15, 2020

setu4993 commented Dec 11, 2020

setu4993 Dec 15, 2020

shivlaks left a comment

shivlaks Dec 15, 2020

shivlaks left a comment

mergify bot commented Dec 15, 2020

aws-cdk-automation commented Dec 15, 2020

mergify bot commented Dec 15, 2020

setu4993 commented Dec 15, 2020

feat(stepfunctions-tasks): add support for ModelClientConfig to SageMakerCreateTransformJob #11892

feat(stepfunctions-tasks): add support for ModelClientConfig to SageMakerCreateTransformJob #11892

Conversation

setu4993 commented Dec 6, 2020

gitpod-io bot commented Dec 6, 2020 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

setu4993 commented Dec 6, 2020

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

setu4993 commented Dec 10, 2020

shivlaks left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

setu4993 Dec 11, 2020 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

setu4993 commented Dec 11, 2020

Choose a reason for hiding this comment

shivlaks left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

shivlaks left a comment

Choose a reason for hiding this comment

mergify bot commented Dec 15, 2020

aws-cdk-automation commented Dec 15, 2020

AWS CodeBuild CI Report

mergify bot commented Dec 15, 2020

setu4993 commented Dec 15, 2020

gitpod-io bot commented Dec 6, 2020 •

edited

Loading

setu4993 Dec 11, 2020 •

edited

Loading