Skip to content

documentation: update first-party algorithms and structural updates #3300

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 3 commits into from
Aug 17, 2022
Merged

documentation: update first-party algorithms and structural updates #3300

merged 3 commits into from
Aug 17, 2022

Conversation

ragdhall
Copy link
Contributor

Issue #, if available:

Description of changes: Update First-Party Algorithms to Built-In Algorithms. Change structure of first-party algorithms to arrange by data type. Changes are according to the discussion in this doc: https://quip-amazon.com/4LBNADovHMck/SDK-Update#temp:C:PRT6b604a5f6b034bbeabcf72962

Testing done:

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-notebook-tests
  • Commit ID: b631cd5
  • 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-unit-tests
  • Commit ID: b631cd5
  • 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: b631cd5
  • 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: b631cd5
  • 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: b631cd5
  • 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: df7154c
  • 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-unit-tests
  • Commit ID: 9649201
  • 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 Aug 16, 2022 •
edited
Loading

Codecov Report

Merging #3300 (9649201) into master (38b4916) will decrease coverage by 0.37%.
The diff coverage is 95.95%.

@@            Coverage Diff             @@
##           master    #3300      +/-   ##
==========================================
- Coverage   89.40%   89.03%   -0.38%     
==========================================
  Files         848      203     -645     
  Lines       72563    18313   -54250     
==========================================
- Hits        64877    16305   -48572     
+ Misses       7686     2008    -5678
Impacted Files Coverage Δ
src/sagemaker/jumpstart/types.py 94.37% <0.00%> (ø)
src/sagemaker/processing.py 94.33% <ø> (ø)
...agemaker/serverless/serverless_inference_config.py 100.00% <ø> (ø)
src/sagemaker/transformer.py 94.47% <ø> (ø)
src/sagemaker/workflow/step_collections.py 93.87% <ø> (ø)
src/sagemaker/job.py 90.00% <75.00%> (-0.55%) ⬇️
src/sagemaker/tensorflow/estimator.py 92.18% <75.00%> (-0.56%) ⬇️
src/sagemaker/estimator.py 89.24% <76.47%> (-0.35%) ⬇️
src/sagemaker/chainer/model.py 96.49% <88.88%> (-1.07%) ⬇️
src/sagemaker/mxnet/model.py 98.41% <90.00%> (+2.04%) ⬆️
... and 705 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-pr
  • Commit ID: 9649201
  • 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: 9649201
  • 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: 9649201
  • 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: 9649201
  • Result: SUCCEEDED
  • Build Logs (available for 30 days)

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

bencrabtree
bencrabtree suggested changes Aug 16, 2022
View reviewed changes
Copy link
Collaborator

@bencrabtree bencrabtree left a comment

Choose a reason for hiding this comment

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

Looks good overall, just make sure that all codebuilds are passing

doc/algorithms/index.rst
@@ -1,20 +1,15 @@
######################
First-Party Algorithms
Built-in Algorithms
######################
Copy link
Collaborator

Choose a reason for hiding this comment

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

I'm pretty sure you need the #'s to be the same length as the text. That is probably one of the reasons why your codebuild is failing.

Copy link
Contributor Author

@ragdhall ragdhall Aug 16, 2022 •
edited
Loading

Choose a reason for hiding this comment

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

I think it needs to be the same or longer in length. make html as well as tox -e twine,sphinx pass locally. The build errors seem unrelated to the PR changes.

Copy link
Collaborator

@bencrabtree bencrabtree Aug 16, 2022 •
edited
Loading

Choose a reason for hiding this comment

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

sounds good to me, thanks for the clarification

@BasilBeirouti BasilBeirouti merged commit 6e5d247 into aws:master Aug 17, 2022
JoseJuan98 pushed a commit to JoseJuan98/sagemaker-python-sdk that referenced this pull request Mar 4, 2023
@ragdhall @JoseJuan98
documentation: update first-party algorithms and structural updates (a…
f927652 
…ws#3300)

* documentation: update first-party algorithms and structural updates

* documentation: minor style changes to pass codebuild

* documentation: more minor edits

Co-authored-by: Raghav Dhall <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@bencrabtree bencrabtree bencrabtree requested changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@ragdhall @sagemaker-bot @codecov-commenter @bencrabtree @BasilBeirouti