Skip to content

fix: Correct SageMaker Clarify API docstrings by changing JSONPath to JMESPath #3511

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 1 commit into from
Dec 16, 2022
Merged

fix: Correct SageMaker Clarify API docstrings by changing JSONPath to JMESPath #3511

merged 1 commit into from
Dec 16, 2022

Conversation

xgchena
Copy link
Contributor

@xgchena xgchena commented Dec 7, 2022

Issue #, if available:

https://tiny.amazon.com/l78gdtmh

Description of changes:

SageMaker Clarify API (including the Clarify Model Monitor API) docstrings use term JSONPath, but actually the SageMaker Clarify processing container expects JMESPath expression.

The commit corrects the term to avoid customer confusion. No code change, only updates to docstrings.

Testing done:

Merge Checklist

General

  • I have read the CONTRIBUTING doc
  • I certify that the changes I am introducing will be backward compatible, and I have discussed concerns about this, if any, with the Python SDK team
  • I used the commit message format described in CONTRIBUTING
  • I have passed the region in to all S3 and STS clients that I've initialized as part of this change.
  • I have updated any necessary documentation, including READMEs and API docs (if appropriate)

Tests

  • I have added tests that prove my fix is effective or that my feature works (if appropriate)
  • I have added unit and/or integration tests as appropriate to ensure backward compatibility of the changes
  • I have checked that my tests are not configured for a specific region or account (if appropriate)
  • I have used unique_name_from_base to create resource names in integ tests (if appropriate)

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

@xgchena xgchena requested a review from a team as a code owner December 7, 2022 03:24
@xgchena xgchena requested review from knikure and removed request for a team December 7, 2022 03:24
@sagemaker-bot
Copy link
Collaborator

AWS CodeBuild CI Report

  • CodeBuild project: sagemaker-python-sdk-unit-tests
  • Commit ID: 24ff71d
  • Result: FAILED
  • Build Logs (available for 30 days)

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

@sagemaker-bot
Copy link
Collaborator

AWS CodeBuild CI Report

  • CodeBuild project: sagemaker-python-sdk-local-mode-tests
  • Commit ID: 24ff71d
  • Result: SUCCEEDED
  • Build Logs (available for 30 days)

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

@sagemaker-bot
Copy link
Collaborator

AWS CodeBuild CI Report

  • CodeBuild project: sagemaker-python-sdk-slow-tests
  • Commit ID: 24ff71d
  • Result: FAILED
  • Build Logs (available for 30 days)

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

@sagemaker-bot
Copy link
Collaborator

AWS CodeBuild CI Report

  • CodeBuild project: sagemaker-python-sdk-pr
  • Commit ID: 24ff71d
  • Result: SUCCEEDED
  • Build Logs (available for 30 days)

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

@sagemaker-bot
Copy link
Collaborator

AWS CodeBuild CI Report

  • CodeBuild project: sagemaker-python-sdk-notebook-tests
  • Commit ID: 24ff71d
  • Result: SUCCEEDED
  • Build Logs (available for 30 days)

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

@sagemaker-bot
Copy link
Collaborator

AWS CodeBuild CI Report

  • CodeBuild project: sagemaker-python-sdk-unit-tests
  • Commit ID: 0b860d5
  • Result: FAILED
  • Build Logs (available for 30 days)

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

@codecov-commenter
Copy link

codecov-commenter commented Dec 10, 2022 •
edited
Loading

Codecov Report

Merging #3511 (ddf4474) into master (1fa2377) will decrease coverage by 0.29%.
The diff coverage is 87.55%.

@@            Coverage Diff             @@
##           master    #3511      +/-   ##
==========================================
- Coverage   89.17%   88.87%   -0.30%     
==========================================
  Files         204      213       +9     
  Lines       18979    20568    +1589     
==========================================
+ Hits        16924    18280    +1356     
- Misses       2055     2288     +233
Impacted Files Coverage Δ
src/sagemaker/feature_store/feature_group.py 76.52% <ø> (ø)
src/sagemaker/huggingface/model.py 89.87% <ø> (ø)
src/sagemaker/pipeline.py 85.33% <ø> (ø)
src/sagemaker/sklearn/model.py 92.98% <ø> (-1.76%) ⬇️
src/sagemaker/sparkml/model.py 100.00% <ø> (ø)
src/sagemaker/workflow/clarify_check_step.py 96.91% <ø> (ø)
...sagemaker/workflow/monitor_batch_transform_step.py 0.00% <0.00%> (ø)
src/sagemaker/xgboost/model.py 96.36% <ø> (-1.82%) ⬇️
...agemaker/model_monitor/clarify_model_monitoring.py 89.84% <27.58%> (-5.09%) ⬇️
src/sagemaker/transformer.py 85.41% <40.62%> (-9.07%) ⬇️
... and 58 more

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

@sagemaker-bot
Copy link
Collaborator

AWS CodeBuild CI Report

  • CodeBuild project: sagemaker-python-sdk-slow-tests
  • Commit ID: 0b860d5
  • Result: FAILED
  • Build Logs (available for 30 days)

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

@sagemaker-bot
Copy link
Collaborator

AWS CodeBuild CI Report

  • CodeBuild project: sagemaker-python-sdk-local-mode-tests
  • Commit ID: 0b860d5
  • Result: SUCCEEDED
  • Build Logs (available for 30 days)

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

@xgchena
fix: Correct Clarify API docstrings by changing JSONPath to JMESPath
ddf4474 
SageMaker Clarify API docstrings use term JSONPath, but actually the
Clarify processing container expects JMESPath expression. The commit
corrects the term to avoid customer confusion.
@sagemaker-bot
Copy link
Collaborator

AWS CodeBuild CI Report

  • CodeBuild project: sagemaker-python-sdk-pr
  • Commit ID: ddf4474
  • Result: SUCCEEDED
  • Build Logs (available for 30 days)

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

@sagemaker-bot
Copy link
Collaborator

AWS CodeBuild CI Report

  • CodeBuild project: sagemaker-python-sdk-unit-tests
  • Commit ID: ddf4474
  • Result: SUCCEEDED
  • Build Logs (available for 30 days)

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

@sagemaker-bot
Copy link
Collaborator

AWS CodeBuild CI Report

  • CodeBuild project: sagemaker-python-sdk-local-mode-tests
  • Commit ID: ddf4474
  • Result: SUCCEEDED
  • Build Logs (available for 30 days)

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

@sagemaker-bot
Copy link
Collaborator

AWS CodeBuild CI Report

  • CodeBuild project: sagemaker-python-sdk-slow-tests
  • Commit ID: ddf4474
  • Result: FAILED
  • Build Logs (available for 30 days)

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

@sagemaker-bot
Copy link
Collaborator

AWS CodeBuild CI Report

  • CodeBuild project: sagemaker-python-sdk-notebook-tests
  • Commit ID: ddf4474
  • Result: SUCCEEDED
  • Build Logs (available for 30 days)

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

@xgchena
Copy link
Contributor Author

xgchena commented Dec 13, 2022

AWS CodeBuild CI Report
CodeBuild project: sagemaker-python-sdk-slow-tests
Commit ID: ddf4474
Result: FAILED
Build Logs (available for 30 days)

Regarding this failure, I bet it is not caused by this PR which only updates doc strings.

@knikure knikure self-assigned this Dec 13, 2022
xiaoyi-cheng
xiaoyi-cheng approved these changes Dec 14, 2022
View reviewed changes
Copy link
Contributor

@xiaoyi-cheng xiaoyi-cheng left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm

knikure
knikure reviewed Dec 14, 2022
View reviewed changes
Copy link
Contributor

@knikure knikure left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

/bot run slow-tests

@sagemaker-bot
Copy link
Collaborator

AWS CodeBuild CI Report

  • CodeBuild project: sagemaker-python-sdk-slow-tests
  • Commit ID: ddf4474
  • Result: FAILED
  • Build Logs (available for 30 days)

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

@knikure knikure merged commit 53108b6 into aws:master Dec 16, 2022
claytonparnell pushed a commit to claytonparnell/sagemaker-python-sdk that referenced this pull request Dec 16, 2022
@xgchena @claytonparnell
fix: Correct SageMaker Clarify API docstrings by changing JSONPath to…
864b517 
… JMESPath (aws#3511)
@xgchena xgchena deleted the correct-clarify-doc-jsonpath-should-be-jmespath branch December 16, 2022 22:27
mufaddal-rohawala pushed a commit to mufaddal-rohawala/sagemaker-python-sdk that referenced this pull request Dec 19, 2022
@xgchena @mufiAmazon
fix: Correct SageMaker Clarify API docstrings by changing JSONPath to…
2112d92 
… JMESPath (aws#3511)
mufaddal-rohawala pushed a commit that referenced this pull request Dec 20, 2022
@xgchena @mufiAmazon
fix: Correct SageMaker Clarify API docstrings by changing JSONPath to…
5d92ee5 
… JMESPath (#3511)
JoseJuan98 pushed a commit to JoseJuan98/sagemaker-python-sdk that referenced this pull request Mar 4, 2023
@xgchena @JoseJuan98
fix: Correct SageMaker Clarify API docstrings by changing JSONPath to…
372c1bd 
… JMESPath (aws#3511)
nmadan pushed a commit to nmadan/sagemaker-python-sdk that referenced this pull request Apr 18, 2023
@xgchena
fix: Correct SageMaker Clarify API docstrings by changing JSONPath to…
1641fbb 
… JMESPath (aws#3511)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@xiaoyi-cheng xiaoyi-cheng xiaoyi-cheng approved these changes

@knikure knikure knikure approved these changes

Assignees

@knikure knikure

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@xgchena @sagemaker-bot @codecov-commenter @xiaoyi-cheng @knikure