Skip to content

documentation: Changed method description per AWS request #3098

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.

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

Merged
merged 1 commit into from
May 27, 2022

Conversation

p-nanimal
Copy link
Contributor

Description of changes: Changed the metric default for methods run_pre_training_bias, run_post_training_bias, run_bias per service team's request
From:
– Selector of a subset of potential metrics: [..]. Defaults to computing all.
To:
– Selector of a subset of potential metrics: [..]. Defaults to str "all" to run all metrics if left unspecified.
Testing done:
Modification is in the comments section only. Will wait for the RTD doc CI to pass.

Merge Checklist

Put an x in the boxes that apply. You can also fill these out after creating the PR. If you're unsure about any of them, don't hesitate to ask. We're here to help! This is simply a reminder of what we are going to look for before merging your pull request.

General

  • I have read the CONTRIBUTING doc
  • I certify that the changes I am introducing will be backword 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.

@sagemaker-bot
Copy link
Collaborator

AWS CodeBuild CI Report

  • CodeBuild project: sagemaker-python-sdk-unit-tests
  • Commit ID: 800f7f8
  • 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-pr
  • Commit ID: 800f7f8
  • 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: 800f7f8
  • Result: SUCCEEDED
  • 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 May 9, 2022

Codecov Report

Merging #3098 (800f7f8) into master (5b8eb10) will decrease coverage by 0.07%.
The diff coverage is n/a.

@@            Coverage Diff             @@
##           master    #3098      +/-   ##
==========================================
- Coverage   89.58%   89.51%   -0.08%     
==========================================
  Files        1043      199     -844     
  Lines       86761    17177   -69584     
==========================================
- Hits        77727    15376   -62351     
+ Misses       9034     1801    -7233     
Impacted Files Coverage Δ
src/sagemaker/clarify.py 95.41% <ø> (ø)
...n3.8/site-packages/sagemaker/workflow/fail_step.py
....9/site-packages/sagemaker/jumpstart/parameters.py
...ython3.6/site-packages/sagemaker/lineage/_utils.py
...n3.7/site-packages/sagemaker/sklearn/processing.py
...n3.7/site-packages/sagemaker/wrangler/ingestion.py
.../python3.6/site-packages/sagemaker/cli/__init__.py
...n3.8/site-packages/sagemaker/tensorflow/serving.py
...lib/python3.8/site-packages/sagemaker/vpc_utils.py
...lib/python3.7/site-packages/sagemaker/predictor.py
... and 836 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 5b8eb10...800f7f8. Read the comment docs.

@sagemaker-bot
Copy link
Collaborator

AWS CodeBuild CI Report

  • CodeBuild project: sagemaker-python-sdk-notebook-tests
  • Commit ID: 800f7f8
  • 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: 800f7f8
  • 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-slow-tests
  • Commit ID: 800f7f8
  • Result: FAILED
  • Build Logs (available for 30 days)

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

@navinsoni navinsoni changed the title Documentation: Changed method description per AWS request documentation: Changed method description per AWS request May 27, 2022
@navinsoni navinsoni merged commit 621e70e into aws:master May 27, 2022
@p-nanimal p-nanimal deleted the nanimal-clarify-doc-update branch May 27, 2022 19:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants