Skip to content

sagemaker.session.s3_input or sagemaker.inputs.s3_input? #1798

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

Closed
dz902 opened this issue Aug 3, 2020 · 1 comment
Closed

sagemaker.session.s3_input or sagemaker.inputs.s3_input? #1798

dz902 opened this issue Aug 3, 2020 · 1 comment

Comments

@dz902
Copy link

dz902 commented Aug 3, 2020

What did you find confusing? Please describe.
sagemaker.session.s3_input() or sagemaker.inputs.s3_input()?

While I found no code using the latter, it is the only document entry. s3_input is not listed in the Session page where I would expect it.

Describe how documentation can be improved
I'm not sure whether this is a convention of Python docs but it is confusing. If it is to be used as sagemaker.session.s3_input() then it should be documented as such.

I also found the use of sess = sagemaker.Session() but in the docs it is sagemaker.session.Session().

To save another issue, I also found from sagemaker.amazon.amazon_estimator import get_image_uri in official examples but that function was not documented.

These are quite confusing for SageMaker new comers. Hope these can be fixed somehow.

Thanks!

@ajaykarpur
Copy link
Contributor

Thanks for bringing this to our attention, @dz902. We're actually planning on consolidating and renaming this functionality in Python SDK v2, which will be released soon.

Please let us know if you'd like any additional information or clarification.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants