Skip to content

Fix incorrect compute param example in SageMakerNotebookHook docstring#60247

Merged
vincbeck merged 13 commits into
apache:mainfrom
sagnjun-nam:fix/sagemaker-docstring
Jan 15, 2026
Merged

Fix incorrect compute param example in SageMakerNotebookHook docstring#60247
vincbeck merged 13 commits into
apache:mainfrom
sagnjun-nam:fix/sagemaker-docstring

Conversation

@sagnjun-nam
Copy link
Copy Markdown
Contributor

The compute parameter example in SageMakerNotebookHook and SageMakerNotebookOperator docstrings incorrectly shows image_uri as a direct field, but the SageMaker Unified Studio API expects image_details with either ecr_uri or image_name/image_version combination.

Reference: https://docs.aws.amazon.com/sagemaker-unified-studio/latest/userguide/remote-execution-apis.html#remote-start-execution


The compute parameter example incorrectly shows `image_uri` as a direct field,
but the SageMaker Unified Studio API expects `image_details` with either
`ecr_uri` or `image_name`/`image_version` combination.

Reference: https://docs.aws.amazon.com/sagemaker-unified-studio/latest/userguide/remote-execution-apis.html#remote-start-execution
The compute parameter example incorrectly shows `image_uri` as a direct field,
but the SageMaker Unified Studio API expects `image_details` with either
`ecr_uri` or `image_name`/`image_version` combination.

Reference: https://docs.aws.amazon.com/sagemaker-unified-studio/latest/userguide/remote-execution-apis.html#remote-start-execution
@sagnjun-nam sagnjun-nam requested a review from o-nikolas as a code owner January 8, 2026 00:40
@boring-cyborg boring-cyborg Bot added area:providers provider:amazon AWS/Amazon - related issues labels Jan 8, 2026
@boring-cyborg
Copy link
Copy Markdown

boring-cyborg Bot commented Jan 8, 2026

Congratulations on your first Pull Request and welcome to the Apache Airflow community! If you have any issues or are unsure about any anything please check our Contributors' Guide (https://github.com/apache/airflow/blob/main/contributing-docs/README.rst)
Here are some useful points:

  • Pay attention to the quality of your code (ruff, mypy and type annotations). Our prek-hooks will help you with that.
  • In case of a new feature add useful documentation (in docstrings or in docs/ directory). Adding a new operator? Check this short guide Consider adding an example DAG that shows how users should use it.
  • Consider using Breeze environment for testing locally, it's a heavy docker but it ships with a working Airflow and a lot of integrations.
  • Be patient and persistent. It might take some time to get a review or get the final approval from Committers.
  • Please follow ASF Code of Conduct for all communication including (but not limited to) comments on Pull Requests, Mailing list and Slack.
  • Be sure to read the Airflow Coding style.
  • Always keep your Pull Requests rebased, otherwise your build might fail due to changes not related to your commits.
    Apache Airflow is a community-driven project and together we are making it better 🚀.
    In case of doubts contact the developers at:
    Mailing List: dev@airflow.apache.org
    Slack: https://s.apache.org/airflow-slack

@eladkal eladkal requested a review from vincbeck January 9, 2026 12:02
Copy link
Copy Markdown
Contributor

@vincbeck vincbeck left a comment

Choose a reason for hiding this comment

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

Looks good to me but some tests need to be fixed

@sagnjun-nam sagnjun-nam requested a review from vincbeck January 13, 2026 00:37
@o-nikolas
Copy link
Copy Markdown
Contributor

Looks good to me but some tests need to be fixed

+1, sphinx gets very upset when there is indented code looking examples in the docs. I reckon this is why it was all on one line previously. Your PR for this fix doesn't necessarily need to include that reformatting. The easiest fix would be to just put it back to a single line.

@vincbeck vincbeck merged commit 98c9bc7 into apache:main Jan 15, 2026
88 checks passed
@boring-cyborg
Copy link
Copy Markdown

boring-cyborg Bot commented Jan 15, 2026

Awesome work, congrats on your first merged pull request! You are invited to check our Issue Tracker for additional contributions.

jason810496 pushed a commit to jason810496/airflow that referenced this pull request Jan 22, 2026
apache#60247)

* Fix incorrect compute param example in SageMakerNotebookHook docstring

The compute parameter example incorrectly shows `image_uri` as a direct field,
but the SageMaker Unified Studio API expects `image_details` with either
`ecr_uri` or `image_name`/`image_version` combination.

Reference: https://docs.aws.amazon.com/sagemaker-unified-studio/latest/userguide/remote-execution-apis.html#remote-start-execution

* Fix incorrect compute param example in SageMakerNotebookHook docstring

The compute parameter example incorrectly shows `image_uri` as a direct field,
but the SageMaker Unified Studio API expects `image_details` with either
`ecr_uri` or `image_name`/`image_version` combination.

Reference: https://docs.aws.amazon.com/sagemaker-unified-studio/latest/userguide/remote-execution-apis.html#remote-start-execution
jhgoebbert pushed a commit to jhgoebbert/airflow_Owen-CH-Leung that referenced this pull request Feb 8, 2026
apache#60247)

* Fix incorrect compute param example in SageMakerNotebookHook docstring

The compute parameter example incorrectly shows `image_uri` as a direct field,
but the SageMaker Unified Studio API expects `image_details` with either
`ecr_uri` or `image_name`/`image_version` combination.

Reference: https://docs.aws.amazon.com/sagemaker-unified-studio/latest/userguide/remote-execution-apis.html#remote-start-execution

* Fix incorrect compute param example in SageMakerNotebookHook docstring

The compute parameter example incorrectly shows `image_uri` as a direct field,
but the SageMaker Unified Studio API expects `image_details` with either
`ecr_uri` or `image_name`/`image_version` combination.

Reference: https://docs.aws.amazon.com/sagemaker-unified-studio/latest/userguide/remote-execution-apis.html#remote-start-execution
choo121600 pushed a commit to choo121600/airflow that referenced this pull request Feb 22, 2026
apache#60247)

* Fix incorrect compute param example in SageMakerNotebookHook docstring

The compute parameter example incorrectly shows `image_uri` as a direct field,
but the SageMaker Unified Studio API expects `image_details` with either
`ecr_uri` or `image_name`/`image_version` combination.

Reference: https://docs.aws.amazon.com/sagemaker-unified-studio/latest/userguide/remote-execution-apis.html#remote-start-execution

* Fix incorrect compute param example in SageMakerNotebookHook docstring

The compute parameter example incorrectly shows `image_uri` as a direct field,
but the SageMaker Unified Studio API expects `image_details` with either
`ecr_uri` or `image_name`/`image_version` combination.

Reference: https://docs.aws.amazon.com/sagemaker-unified-studio/latest/userguide/remote-execution-apis.html#remote-start-execution
Subham-KRLX pushed a commit to Subham-KRLX/airflow that referenced this pull request Mar 4, 2026
apache#60247)

* Fix incorrect compute param example in SageMakerNotebookHook docstring

The compute parameter example incorrectly shows `image_uri` as a direct field,
but the SageMaker Unified Studio API expects `image_details` with either
`ecr_uri` or `image_name`/`image_version` combination.

Reference: https://docs.aws.amazon.com/sagemaker-unified-studio/latest/userguide/remote-execution-apis.html#remote-start-execution

* Fix incorrect compute param example in SageMakerNotebookHook docstring

The compute parameter example incorrectly shows `image_uri` as a direct field,
but the SageMaker Unified Studio API expects `image_details` with either
`ecr_uri` or `image_name`/`image_version` combination.

Reference: https://docs.aws.amazon.com/sagemaker-unified-studio/latest/userguide/remote-execution-apis.html#remote-start-execution
Ankurdeewan pushed a commit to Ankurdeewan/airflow that referenced this pull request Mar 15, 2026
apache#60247)

* Fix incorrect compute param example in SageMakerNotebookHook docstring

The compute parameter example incorrectly shows `image_uri` as a direct field,
but the SageMaker Unified Studio API expects `image_details` with either
`ecr_uri` or `image_name`/`image_version` combination.

Reference: https://docs.aws.amazon.com/sagemaker-unified-studio/latest/userguide/remote-execution-apis.html#remote-start-execution

* Fix incorrect compute param example in SageMakerNotebookHook docstring

The compute parameter example incorrectly shows `image_uri` as a direct field,
but the SageMaker Unified Studio API expects `image_details` with either
`ecr_uri` or `image_name`/`image_version` combination.

Reference: https://docs.aws.amazon.com/sagemaker-unified-studio/latest/userguide/remote-execution-apis.html#remote-start-execution
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area:providers provider:amazon AWS/Amazon - related issues

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants