Skip to content

documentation: add dataset_definition to processing page #2589

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 3 commits into from
Aug 24, 2021

Conversation

tuliocasagrande
Copy link
Contributor

@tuliocasagrande tuliocasagrande commented Aug 20, 2021

Issue #, if available:
PR #2456 fixed dataset_definition.inputs path to corretly link the classes in the documentation:

  • sagemaker.dataset_definition.inputs.S3Input
  • sagemaker.dataset_definition.inputs.DatasetDefinition
  • sagemaker.dataset_definition.inputs.AthenaDatasetDefinition
  • sagemaker.dataset_definition.inputs.RedshiftDatasetDefinition

However, the aforementioned classes are still missing on the documentation.

Description of changes:
Added sagemaker.dataset_definition.inputs to sphinx's automodule.
I also took the opportunity to fix the link for sagemaker.inputs as well.

Testing done:

I built sphinx doc locally, using instructions from the README, and verified that the links are working properly.

From https://sagemaker.readthedocs.io/en/stable/api/training/processing.html#sagemaker.processing.ProcessingInput:
Screen Shot 2021-08-20 at 19 47 18
From https://sagemaker.readthedocs.io/en/stable/api/training/estimators.html#sagemaker.estimator.EstimatorBase.fit:
Screen Shot 2021-08-20 at 19 49 45

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 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 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: fe77550
  • Result: FAILED
  • Build Logs (available for 30 days)

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

@tuliocasagrande tuliocasagrande marked this pull request as draft August 20, 2021 18:01
@tuliocasagrande
Copy link
Contributor Author

I'm testing with instructions described here:
https://github.com/tuliocasagrande/sagemaker-python-sdk/tree/master#building-sphinx-docs

But I'm getting some issues:

Warning, treated as error:
.../sagemaker/dataset_definition/inputs.py:docstring of
sagemaker.dataset_definition.inputs.RedshiftDatasetDefinition.cluster_id:1:duplicate object description of
sagemaker.dataset_definition.inputs.RedshiftDatasetDefinition.cluster_id,
other instance in api/training/processing, use :noindex: for one of them
make: *** [html] Error 2

I'm investigating on sphinx documentation why it's getting duplicated reference/index.

@sagemaker-bot
Copy link
Collaborator

AWS CodeBuild CI Report

  • CodeBuild project: sagemaker-python-sdk-unit-tests
  • Commit ID: 1ed8d5c
  • 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: 47743cc
  • Result: SUCCEEDED
  • Build Logs (available for 30 days)

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

@tuliocasagrande
Copy link
Contributor Author

Found the issue! Sphinx was interpreting attributes from the class and from parent (ApiObject) as duplicates.

@tuliocasagrande tuliocasagrande marked this pull request as ready for review August 20, 2021 22:57
@shreyapandit shreyapandit merged commit 5c4a557 into aws:master Aug 24, 2021
@tuliocasagrande tuliocasagrande deleted the patch-1 branch August 25, 2021 19:46
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.

4 participants