Skip to content

docs: update feature store dataset builder docs #3683

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 6 commits into from
Mar 1, 2023
Merged

docs: update feature store dataset builder docs #3683

merged 6 commits into from
Mar 1, 2023

Conversation

patrickmcarlos
Copy link
Contributor

@patrickmcarlos patrickmcarlos commented Feb 24, 2023 •
edited
Loading

Issue #, if available:

Description of changes:

  • Improves API reference for the DatasetBuilder class
  • Adds brief user guide for using Offline Store SDK / Databuilder class in Feature Store docs

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 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.

@patrickmcarlos patrickmcarlos changed the title dnm: Patmcar update dataset builder docs docs: update feature store dataset builder docs Feb 27, 2023
@patrickmcarlos patrickmcarlos marked this pull request as ready for review February 27, 2023 23:14
@patrickmcarlos patrickmcarlos requested a review from a team as a code owner February 27, 2023 23:14
@patrickmcarlos patrickmcarlos requested review from claytonparnell and removed request for a team February 27, 2023 23:14
@patrickmcarlos patrickmcarlos force-pushed the patmcar-update-dataset-builder-docs branch 2 times, most recently from 871c0dd to 4650423 Compare February 28, 2023 22:19
@patrickmcarlos patrickmcarlos force-pushed the patmcar-update-dataset-builder-docs branch from 4650423 to 8e02543 Compare March 1, 2023 17:17
claytonparnell
claytonparnell reviewed Mar 1, 2023
View reviewed changes
Copy link
Collaborator

@claytonparnell claytonparnell left a comment •
edited
Loading

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-unit-tests
  • Commit ID: 8e02543
  • Result: FAILED
  • Build Logs (available for 30 days)

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

claytonparnell
claytonparnell reviewed Mar 1, 2023
View reviewed changes
Copy link
Collaborator

@claytonparnell claytonparnell left a comment •
edited
Loading

Choose a reason for hiding this comment

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

/bot run pr

@sagemaker-bot
Copy link
Collaborator

AWS CodeBuild CI Report

  • CodeBuild project: sagemaker-python-sdk-unit-tests
  • Commit ID: ee59a0d
  • 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: 6bc91ce
  • 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: 6bc91ce
  • 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 Mar 1, 2023 •
edited
Loading

Codecov Report

Merging #3683 (6bc91ce) into master (2e44a2c) will decrease coverage by 0.79%.
The diff coverage is n/a.

@@            Coverage Diff             @@
##           master    #3683      +/-   ##
==========================================
- Coverage   89.74%   88.96%   -0.79%     
==========================================
  Files         968      227     -741     
  Lines       91124    22537   -68587     
==========================================
- Hits        81780    20049   -61731     
+ Misses       9344     2488    -6856
Impacted Files Coverage Δ
src/sagemaker/feature_store/dataset_builder.py 87.05% <ø> (ø)
...-packages/sagemaker/utilities/search_expression.py
...thon3.9/site-packages/sagemaker/jumpstart/cache.py
....7/site-packages/sagemaker/experiments/__init__.py
...on3.9/site-packages/sagemaker/jumpstart/filters.py
...b/python3.9/site-packages/sagemaker/local/utils.py
...s/sagemaker/tensorflow/training_compiler/config.py
...agemaker/async_inference/async_inference_config.py
...on3.10/site-packages/sagemaker/chainer/__init__.py
...ib/python3.7/site-packages/sagemaker/model_uris.py
... and 1186 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: 6bc91ce
  • 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: 6bc91ce
  • 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: 6bc91ce
  • 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: 6bc91ce
  • 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: 6bc91ce
  • Result: SUCCEEDED
  • Build Logs (available for 30 days)

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

@claytonparnell claytonparnell merged commit e913520 into aws:master Mar 1, 2023
JoseJuan98 pushed a commit to JoseJuan98/sagemaker-python-sdk that referenced this pull request Mar 4, 2023
@patrickmcarlos @JoseJuan98
documentation: update feature store dataset builder docs (aws#3683)
9589b92 
* updates docstrings for datasetbuilder members

* feature store user guide updates

* update to chain code snippet, updates api ref link

* update description to be before code

* removes trailing whitespace

* remove whitespace from user guide
nmadan pushed a commit to nmadan/sagemaker-python-sdk that referenced this pull request Apr 18, 2023
@patrickmcarlos
documentation: update feature store dataset builder docs (aws#3683)
aaedb91 
* updates docstrings for datasetbuilder members

* feature store user guide updates

* update to chain code snippet, updates api ref link

* update description to be before code

* removes trailing whitespace

* remove whitespace from user guide
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@claytonparnell claytonparnell claytonparnell approved these changes

Assignees

@claytonparnell claytonparnell

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@patrickmcarlos @sagemaker-bot @codecov-commenter @claytonparnell