Skip to content

documentation: fix documentation for input types in estimator.fit#2685

Merged
ahsan-z-khan merged 9 commits into
aws:masterfrom
ajberdy:training-inputs-doc-fix
Oct 24, 2021
Merged

documentation: fix documentation for input types in estimator.fit#2685
ahsan-z-khan merged 9 commits into
aws:masterfrom
ajberdy:training-inputs-doc-fix

Conversation

@ajberdy
Copy link
Copy Markdown
Contributor

@ajberdy ajberdy commented Oct 4, 2021

Issue #, if available:

Description of changes:

  • There are four types that estimator.fit accepts for input data, documentation still said three (probably from before FileSystemInput was supported)
  • FileSystemInput is defined in inputs.py, not in session.py.

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

shreyapandit
shreyapandit previously approved these changes Oct 4, 2021
@sagemaker-bot
Copy link
Copy Markdown
Collaborator

AWS CodeBuild CI Report

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

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

@ajberdy
Copy link
Copy Markdown
Contributor Author

ajberdy commented Oct 5, 2021

Additionally, I think it's likely that

* (dict[str, str] or dict[str, sagemaker.inputs.TrainingInput]) If using multiple
       channels for training data, you can specify a dict mapping channel names to
       strings or :func:`~sagemaker.inputs.TrainingInput` objects.

should be changed to

* (dict[str, str] or dict[str, sagemaker.inputs.TrainingInput] or dict[str, sagemaker.inputs.FileSystemInput]) 
       If using multiple channels for training data, you can specify a dict mapping channel names 
       to strings or :func:`~sagemaker.inputs.TrainingInput` objects or 
       :func:`~sagemaker.inputs.FileSystemInput` objects.

ahsan-z-khan
ahsan-z-khan previously approved these changes Oct 5, 2021
@sagemaker-bot
Copy link
Copy Markdown
Collaborator

AWS CodeBuild CI Report

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

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

@sagemaker-bot
Copy link
Copy Markdown
Collaborator

AWS CodeBuild CI Report

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

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

@sagemaker-bot
Copy link
Copy Markdown
Collaborator

AWS CodeBuild CI Report

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

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

@sagemaker-bot
Copy link
Copy Markdown
Collaborator

AWS CodeBuild CI Report

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

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

@sagemaker-bot
Copy link
Copy Markdown
Collaborator

AWS CodeBuild CI Report

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

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

@sagemaker-bot
Copy link
Copy Markdown
Collaborator

AWS CodeBuild CI Report

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

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

@sagemaker-bot
Copy link
Copy Markdown
Collaborator

AWS CodeBuild CI Report

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

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

@ahsan-z-khan ahsan-z-khan merged commit beb4e21 into aws:master Oct 24, 2021
EthanShouhanCheng pushed a commit to SissiChenxy/sagemaker-python-sdk that referenced this pull request Jan 11, 2022
…s#2685)

* documentation: fix documentation for input types in estimator.fit

* documentation: add fourth input type to type list for inputs in doc string

* update type options for values in dict input

Co-authored-by: Ahsan Khan <[email protected]>
Co-authored-by: Jeniya Tabassum <[email protected]>
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