search

aws / sagemaker-python-sdk

A library for training and deploying machine learning models on Amazon SageMaker
https://sagemaker.readthedocs.io/
Apache License 2.0
2.1k stars 1.14k forks source link

v2 documentation incorrectly states "Deprecated" #1839

Closed iyerr3 closed 4 years ago

iyerr3 commented 4 years ago

What did you find confusing? Please describe. Multiple issues are being reported for XGBoost functions for the changed functionality with retrieving images. The documentation states that get_image_uri (and many other functions) have been deprecated. However, these functions have actually been removed in v2 and fail when used. (See definition of deprecation)

Describe how documentation can be improved Update the v2 documentation to clearly state that the breaking change functionality have been removed. Additionally, examples of how a v1 function call can be replaced with equivalent v2 function call would be helpful for the transition.

metrizable commented 4 years ago

Hello @iyerr3 ,

Thank you for using Amazon SageMaker.

Thank you for the suggestion on use of the word deprecated in the documentation.

The get_image_uri reference issue included proposed, alternative syntax and related pull requests. Deprecation warnings were brought into the v1 code according to the v2 planning issue where the community could track dates and progress and provide input. In the readthedocs, you'll find reference and links to the new method and syntax for how the v1 function call can be replaced with the v2 function call. Additionally, released with v2 is an automated upgrade tool you can apply to your code to transform v1 code to v2 compliant code.

We are always re-evaluating our backlog of features based on customer requests, so we appreciate the feedback on this change.

Let us know if there is anything else we can be an assistance of.

iyerr3 commented 4 years ago

👍 Thanks, Eric.