doc: fix TF requirements.txt documentation - #1526

Merged
laurenyu merged 1 commit into
aws:masterfrom
laurenyu:tf-req
May 26, 2020
Merged

doc: fix TF requirements.txt documentation#1526
laurenyu merged 1 commit into
aws:masterfrom
laurenyu:tf-req

Conversation

@laurenyu

@laurenyulaurenyu commented May 26, 2020

Copy link
Copy Markdown
Contributor

Issue #, if available:

Description of changes:
follow-up to #1512 - TF script mode support for requirements.txt for versions before TF 1.15.2 with Python 3.7 and TF 2.2 was a bit of a fluke rather than intended behavior, as indicated by #839. However, it doesn't work consistently, which I verified by trying it out with the TF 1.14 image. This PR is to change the documentation to go with what we "officially recommended" at the time, which was the shell script workaround.

Testing done:
here's what I did to make sure that the shell script workaround works for TF 1.14:

$ cat src/entry.sh
python -m pip install -r requirements.txt
python hello.py
$ cat src/requirements.txt
pyfiglet
$ cat src/hello.py
from pyfiglet import Figlet
print(Figlet().renderText('hello').strip())
$ cat run.py
from sagemaker.tensorflow import TensorFlow
tf = TensorFlow(
entry_point='entry.sh',
source_dir='src',
framework_version='1.14',
py_version='py3',
role='SageMakerRole',
train_instance_type='local',
train_instance_count=1,
)
tf.fit()
$ python run.py

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 any/all 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.

@laurenyu
laurenyu requested a review from ajaykarpurMay 26, 2020 16:48
@sagemaker-bot

sagemaker-bot commented May 26, 2020

Copy link
Copy Markdown
Collaborator

AWS CodeBuild CI Report

  • Result: SUCCEEDED
  • Build Logs (available for 30 days)

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

@sagemaker-bot

sagemaker-bot commented May 26, 2020

Copy link
Copy Markdown
Collaborator

AWS CodeBuild CI Report

  • Result: SUCCEEDED
  • Build Logs (available for 30 days)

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

@sagemaker-bot

sagemaker-bot commented May 26, 2020

Copy link
Copy Markdown
Collaborator

AWS CodeBuild CI Report

  • Result: SUCCEEDED
  • Build Logs (available for 30 days)

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

@sagemaker-bot

sagemaker-bot commented May 26, 2020

Copy link
Copy Markdown
Collaborator

AWS CodeBuild CI Report

  • Result: SUCCEEDED
  • Build Logs (available for 30 days)

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

@laurenyu
laurenyu merged commit 8ebbb71 into aws:masterMay 26, 2020
@laurenyu
laurenyu deleted the tf-req branch May 26, 2020 17:02
pintaoz-aws pushed a commit that referenced this pull request Dec 4, 2024
@schinmayee@pintaoz-aws
Feature: Support Neuron training recipes. (#1526)
13e10c9
pintaoz-aws pushed a commit that referenced this pull request Dec 4, 2024
@schinmayee@pintaoz-aws
Usage docs for training recipes (#1630)
3bce287
* Feature: Support GPU training recipes with Sagemaker Python SDK (#1516)
* v0 estimator for launching kandinksy training
* code cleanup
* option to over-ride git repos for kandinsky for testing purposes
* update dependencies
* update comment
* formatting fixes
* style fixes
* code cleanup
* Add warning messages for ingored arguments
* cleanup, address comments
* fix
* clone launcher repo only if necessary
* add a cleanup method to call after fit
* fix docstring
* fix warning
* cleanup update
* fix
* code style fix
* rename cleanup method for clarity
* missed change
* move cleanup to when object is destroyed
* add unit tests
* formatting fix
* removing tests which don't work as recipe repos are private
* removing tests which don't work as recipe repos are private
* resolve comments
* resolve comments
* Feature: Support Neuron training recipes. (#1526)
* Feature: Resolve recipes correctly before launching (#1529)
* fix to work with launcher recipes
* fix suffix for temp file
* fix path and error message
* fix for recipes from launcher
* resolve recipes correctly
* fix imports
* reformat message to avoid code-doc test issue
* code style fix
* code style fix
* code style fix
* code style fix
* code style fix
* code style fix
* code style fix
* code style fix
* code style fix
* doc formatting
* check if resolver exists before registering
* Feature: Add unit tests for recipes and minor bug fixes. (#1532)
* basic checks and unit test for recipes
* More testing for recipes. Move recipe overrides to top before accessing any recipe fields.
* check that we use customer provided image uri if it is set
* reformat
* test fixes
* update git urls for recipes
* revert to ssh git urls for recipes
* Feature: Move image uris and git repos for training recipes to json (#1547)
* Update MANIFEST.in so that wheel builds correctly (#1563)
* Remove default values for fields in recipe_overrides and fix recipe path. (#1566)
* add optional source dir for recipes, copy training code and requirements to source dir
* diff names for recipe file and local script option
* format and add unit test
* make entry point script and recipe file temp files that can be gced
* formatting and fix
* test fix
* test fixes
* format fix
* break function up because it is too long
* fixes
* fix
* fix
* remove references to launcher and adapter dir as we copy out everything needed into source dir
* reformat
* copy all directory contents for trainium as there is more than one source file
* fix
* fix
* remove debugging message
* Change default source directory to current, add option to specify source dir (#1593)
* update to public uris for hyperpod recipe repos and smp image
* fixes
* remove debug copies
* change caps for env vars
* skip some tests for now
* format
* neuron json for retrieving images
* update training_recipes.json
* add unit test
* reformat
* fix long line
* add source dir check when using training recipe
* adding more regions
* reformat
* doc update
* doc update
* doc update
* doc update
* fix capitalization issues
* fix capitalization issues
* doc check issue
pintaoz-aws pushed a commit that referenced this pull request Dec 4, 2024
@schinmayee@pintaoz-aws
Feature: Support Neuron training recipes. (#1526)
560052f
pintaoz-aws pushed a commit that referenced this pull request Dec 4, 2024
@schinmayee@pintaoz-aws
Usage docs for training recipes (#1630)
efc9aa8
* Feature: Support GPU training recipes with Sagemaker Python SDK (#1516)
* v0 estimator for launching kandinksy training
* code cleanup
* option to over-ride git repos for kandinsky for testing purposes
* update dependencies
* update comment
* formatting fixes
* style fixes
* code cleanup
* Add warning messages for ingored arguments
* cleanup, address comments
* fix
* clone launcher repo only if necessary
* add a cleanup method to call after fit
* fix docstring
* fix warning
* cleanup update
* fix
* code style fix
* rename cleanup method for clarity
* missed change
* move cleanup to when object is destroyed
* add unit tests
* formatting fix
* removing tests which don't work as recipe repos are private
* removing tests which don't work as recipe repos are private
* resolve comments
* resolve comments
* Feature: Support Neuron training recipes. (#1526)
* Feature: Resolve recipes correctly before launching (#1529)
* fix to work with launcher recipes
* fix suffix for temp file
* fix path and error message
* fix for recipes from launcher
* resolve recipes correctly
* fix imports
* reformat message to avoid code-doc test issue
* code style fix
* code style fix
* code style fix
* code style fix
* code style fix
* code style fix
* code style fix
* code style fix
* code style fix
* doc formatting
* check if resolver exists before registering
* Feature: Add unit tests for recipes and minor bug fixes. (#1532)
* basic checks and unit test for recipes
* More testing for recipes. Move recipe overrides to top before accessing any recipe fields.
* check that we use customer provided image uri if it is set
* reformat
* test fixes
* update git urls for recipes
* revert to ssh git urls for recipes
* Feature: Move image uris and git repos for training recipes to json (#1547)
* Update MANIFEST.in so that wheel builds correctly (#1563)
* Remove default values for fields in recipe_overrides and fix recipe path. (#1566)
* add optional source dir for recipes, copy training code and requirements to source dir
* diff names for recipe file and local script option
* format and add unit test
* make entry point script and recipe file temp files that can be gced
* formatting and fix
* test fix
* test fixes
* format fix
* break function up because it is too long
* fixes
* fix
* fix
* remove references to launcher and adapter dir as we copy out everything needed into source dir
* reformat
* copy all directory contents for trainium as there is more than one source file
* fix
* fix
* remove debugging message
* Change default source directory to current, add option to specify source dir (#1593)
* update to public uris for hyperpod recipe repos and smp image
* fixes
* remove debug copies
* change caps for env vars
* skip some tests for now
* format
* neuron json for retrieving images
* update training_recipes.json
* add unit test
* reformat
* fix long line
* add source dir check when using training recipe
* adding more regions
* reformat
* doc update
* doc update
* doc update
* doc update
* fix capitalization issues
* fix capitalization issues
* doc check issue
Evan-W-ang added a commit to Evan-W-ang/sagemaker-python-sdk that referenced this pull request Jun 8, 2026
@Evan-W-ang
doc: fix TF requirements.txt documentation (aws#1526)
05d0c8f
Evan-W-ang added a commit to Evan-W-ang/sagemaker-python-sdk that referenced this pull request Jun 8, 2026
@Evan-W-ang
Feature: Support Neuron training recipes. (aws#1526)
4886606
Evan-W-ang added a commit to Evan-W-ang/sagemaker-python-sdk that referenced this pull request Jun 8, 2026
@Evan-W-ang
Usage docs for training recipes (aws#1630)
6a64501
* Feature: Support GPU training recipes with Sagemaker Python SDK (aws#1516)
* v0 estimator for launching kandinksy training
* code cleanup
* option to over-ride git repos for kandinsky for testing purposes
* update dependencies
* update comment
* formatting fixes
* style fixes
* code cleanup
* Add warning messages for ingored arguments
* cleanup, address comments
* fix
* clone launcher repo only if necessary
* add a cleanup method to call after fit
* fix docstring
* fix warning
* cleanup update
* fix
* code style fix
* rename cleanup method for clarity
* missed change
* move cleanup to when object is destroyed
* add unit tests
* formatting fix
* removing tests which don't work as recipe repos are private
* removing tests which don't work as recipe repos are private
* resolve comments
* resolve comments
* Feature: Support Neuron training recipes. (aws#1526)
* Feature: Resolve recipes correctly before launching (aws#1529)
* fix to work with launcher recipes
* fix suffix for temp file
* fix path and error message
* fix for recipes from launcher
* resolve recipes correctly
* fix imports
* reformat message to avoid code-doc test issue
* code style fix
* code style fix
* code style fix
* code style fix
* code style fix
* code style fix
* code style fix
* code style fix
* code style fix
* doc formatting
* check if resolver exists before registering
* Feature: Add unit tests for recipes and minor bug fixes. (aws#1532)
* basic checks and unit test for recipes
* More testing for recipes. Move recipe overrides to top before accessing any recipe fields.
* check that we use customer provided image uri if it is set
* reformat
* test fixes
* update git urls for recipes
* revert to ssh git urls for recipes
* Feature: Move image uris and git repos for training recipes to json (aws#1547)
* Update MANIFEST.in so that wheel builds correctly (aws#1563)
* Remove default values for fields in recipe_overrides and fix recipe path. (aws#1566)
* add optional source dir for recipes, copy training code and requirements to source dir
* diff names for recipe file and local script option
* format and add unit test
* make entry point script and recipe file temp files that can be gced
* formatting and fix
* test fix
* test fixes
* format fix
* break function up because it is too long
* fixes
* fix
* fix
* remove references to launcher and adapter dir as we copy out everything needed into source dir
* reformat
* copy all directory contents for trainium as there is more than one source file
* fix
* fix
* remove debugging message
* Change default source directory to current, add option to specify source dir (aws#1593)
* update to public uris for hyperpod recipe repos and smp image
* fixes
* remove debug copies
* change caps for env vars
* skip some tests for now
* format
* neuron json for retrieving images
* update training_recipes.json
* add unit test
* reformat
* fix long line
* add source dir check when using training recipe
* adding more regions
* reformat
* doc update
* doc update
* doc update
* doc update
* fix capitalization issues
* fix capitalization issues
* doc check issue
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

1 more reviewer
@ajaykarpurajaykarpurajaykarpur approved these changes
Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@laurenyu@sagemaker-bot@ajaykarpur
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all 
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '

Skip to content
doc: fix TF requirements.txt documentation - #1526
Merged
laurenyu merged 1 commit into
aws:masterfrom 
laurenyu:tf-req
May 26, 2020
Merged
doc: fix TF requirements.txt documentation#1526
laurenyu merged 1 commit into
aws:masterfrom 
laurenyu:tf-req
Conversation
@laurenyu
@laurenyulaurenyu
commented
May 26, 2020

Copy link


Copy Markdown

Contributor
Issue #, if available:
Description of changes:

follow-up to #1512 - TF script mode support for requirements.txt for versions before TF 1.15.2 with Python 3.7 and TF 2.2 was a bit of a fluke rather than intended behavior, as indicated by #839. However, it doesn't work consistently, which I verified by trying it out with the TF 1.14 image. This PR is to change the documentation to go with what we "officially recommended" at the time, which was the shell script workaround.
Testing done:

here's what I did to make sure that the shell script workaround works for TF 1.14:
$ cat src/entry.sh
python -m pip install -r requirements.txt
python hello.py
$ cat src/requirements.txt
pyfiglet
$ cat src/hello.py
from pyfiglet import Figlet
print(Figlet().renderText('hello').strip())
$ cat run.py
from sagemaker.tensorflow import TensorFlow
tf = TensorFlow(
entry_point='entry.sh',
source_dir='src',
framework_version='1.14',
py_version='py3',
role='SageMakerRole',
train_instance_type='local',
train_instance_count=1,
)
tf.fit()
$ python run.py

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 any/all 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.
@laurenyu
laurenyu
requested a review
from ajaykarpurMay 26, 2020 16:48
@sagemaker-bot
sagemaker-bot
commented
May 26, 2020

Copy link


Copy Markdown

Collaborator
AWS CodeBuild CI Report
  • Result: SUCCEEDED
  • Build Logs (available for 30 days)
Powered by github-codebuild-logs, available on the AWS Serverless Application Repository
@sagemaker-bot
sagemaker-bot
commented
May 26, 2020

Copy link


Copy Markdown

Collaborator
AWS CodeBuild CI Report
  • Result: SUCCEEDED
  • Build Logs (available for 30 days)
Powered by github-codebuild-logs, available on the AWS Serverless Application Repository
@sagemaker-bot
sagemaker-bot
commented
May 26, 2020

Copy link


Copy Markdown

Collaborator
AWS CodeBuild CI Report
  • Result: SUCCEEDED
  • Build Logs (available for 30 days)
Powered by github-codebuild-logs, available on the AWS Serverless Application Repository
@sagemaker-bot
sagemaker-bot
commented
May 26, 2020

Copy link


Copy Markdown

Collaborator
AWS CodeBuild CI Report
  • Result: SUCCEEDED
  • Build Logs (available for 30 days)
Powered by github-codebuild-logs, available on the AWS Serverless Application Repository
@laurenyu
laurenyu
merged commit 8ebbb71
into
aws:masterMay 26, 2020
@laurenyu
laurenyu
deleted the

tf-req

branch
May 26, 2020 17:02
pintaoz-aws pushed a commit
that referenced
this pull request
Dec 4, 2024
@schinmayee@pintaoz-aws
Feature: Support Neuron training recipes. (#1526)
13e10c9
pintaoz-aws pushed a commit
that referenced
this pull request
Dec 4, 2024
@schinmayee@pintaoz-aws
Usage docs for training recipes (#1630)
3bce287
* Feature: Support GPU training recipes with Sagemaker Python SDK (#1516)
* v0 estimator for launching kandinksy training
* code cleanup
* option to over-ride git repos for kandinsky for testing purposes
* update dependencies
* update comment
* formatting fixes
* style fixes
* code cleanup
* Add warning messages for ingored arguments
* cleanup, address comments
* fix
* clone launcher repo only if necessary
* add a cleanup method to call after fit
* fix docstring
* fix warning
* cleanup update
* fix
* code style fix
* rename cleanup method for clarity
* missed change
* move cleanup to when object is destroyed
* add unit tests
* formatting fix
* removing tests which don't work as recipe repos are private
* removing tests which don't work as recipe repos are private
* resolve comments
* resolve comments
* Feature: Support Neuron training recipes. (#1526)
* Feature: Resolve recipes correctly before launching (#1529)
* fix to work with launcher recipes
* fix suffix for temp file
* fix path and error message
* fix for recipes from launcher
* resolve recipes correctly
* fix imports
* reformat message to avoid code-doc test issue
* code style fix
* code style fix
* code style fix
* code style fix
* code style fix
* code style fix
* code style fix
* code style fix
* code style fix
* doc formatting
* check if resolver exists before registering
* Feature: Add unit tests for recipes and minor bug fixes. (#1532)
* basic checks and unit test for recipes
* More testing for recipes. Move recipe overrides to top before accessing any recipe fields.
* check that we use customer provided image uri if it is set
* reformat
* test fixes
* update git urls for recipes
* revert to ssh git urls for recipes
* Feature: Move image uris and git repos for training recipes to json (#1547)
* Update MANIFEST.in so that wheel builds correctly (#1563)
* Remove default values for fields in recipe_overrides and fix recipe path. (#1566)
* add optional source dir for recipes, copy training code and requirements to source dir
* diff names for recipe file and local script option
* format and add unit test
* make entry point script and recipe file temp files that can be gced
* formatting and fix
* test fix
* test fixes
* format fix
* break function up because it is too long
* fixes
* fix
* fix
* remove references to launcher and adapter dir as we copy out everything needed into source dir
* reformat
* copy all directory contents for trainium as there is more than one source file
* fix
* fix
* remove debugging message
* Change default source directory to current, add option to specify source dir (#1593)
* update to public uris for hyperpod recipe repos and smp image
* fixes
* remove debug copies
* change caps for env vars
* skip some tests for now
* format
* neuron json for retrieving images
* update training_recipes.json
* add unit test
* reformat
* fix long line
* add source dir check when using training recipe
* adding more regions
* reformat
* doc update
* doc update
* doc update
* doc update
* fix capitalization issues
* fix capitalization issues
* doc check issue
pintaoz-aws pushed a commit
that referenced
this pull request
Dec 4, 2024
@schinmayee@pintaoz-aws
Feature: Support Neuron training recipes. (#1526)
560052f
pintaoz-aws pushed a commit
that referenced
this pull request
Dec 4, 2024
@schinmayee@pintaoz-aws
Usage docs for training recipes (#1630)
efc9aa8
* Feature: Support GPU training recipes with Sagemaker Python SDK (#1516)
* v0 estimator for launching kandinksy training
* code cleanup
* option to over-ride git repos for kandinsky for testing purposes
* update dependencies
* update comment
* formatting fixes
* style fixes
* code cleanup
* Add warning messages for ingored arguments
* cleanup, address comments
* fix
* clone launcher repo only if necessary
* add a cleanup method to call after fit
* fix docstring
* fix warning
* cleanup update
* fix
* code style fix
* rename cleanup method for clarity
* missed change
* move cleanup to when object is destroyed
* add unit tests
* formatting fix
* removing tests which don't work as recipe repos are private
* removing tests which don't work as recipe repos are private
* resolve comments
* resolve comments
* Feature: Support Neuron training recipes. (#1526)
* Feature: Resolve recipes correctly before launching (#1529)
* fix to work with launcher recipes
* fix suffix for temp file
* fix path and error message
* fix for recipes from launcher
* resolve recipes correctly
* fix imports
* reformat message to avoid code-doc test issue
* code style fix
* code style fix
* code style fix
* code style fix
* code style fix
* code style fix
* code style fix
* code style fix
* code style fix
* doc formatting
* check if resolver exists before registering
* Feature: Add unit tests for recipes and minor bug fixes. (#1532)
* basic checks and unit test for recipes
* More testing for recipes. Move recipe overrides to top before accessing any recipe fields.
* check that we use customer provided image uri if it is set
* reformat
* test fixes
* update git urls for recipes
* revert to ssh git urls for recipes
* Feature: Move image uris and git repos for training recipes to json (#1547)
* Update MANIFEST.in so that wheel builds correctly (#1563)
* Remove default values for fields in recipe_overrides and fix recipe path. (#1566)
* add optional source dir for recipes, copy training code and requirements to source dir
* diff names for recipe file and local script option
* format and add unit test
* make entry point script and recipe file temp files that can be gced
* formatting and fix
* test fix
* test fixes
* format fix
* break function up because it is too long
* fixes
* fix
* fix
* remove references to launcher and adapter dir as we copy out everything needed into source dir
* reformat
* copy all directory contents for trainium as there is more than one source file
* fix
* fix
* remove debugging message
* Change default source directory to current, add option to specify source dir (#1593)
* update to public uris for hyperpod recipe repos and smp image
* fixes
* remove debug copies
* change caps for env vars
* skip some tests for now
* format
* neuron json for retrieving images
* update training_recipes.json
* add unit test
* reformat
* fix long line
* add source dir check when using training recipe
* adding more regions
* reformat
* doc update
* doc update
* doc update
* doc update
* fix capitalization issues
* fix capitalization issues
* doc check issue
Evan-W-ang added a commit
to Evan-W-ang/sagemaker-python-sdk
that referenced
this pull request
Jun 8, 2026
@Evan-W-ang
doc: fix TF requirements.txt documentation (aws#1526)
05d0c8f
Evan-W-ang added a commit
to Evan-W-ang/sagemaker-python-sdk
that referenced
this pull request
Jun 8, 2026
@Evan-W-ang
Feature: Support Neuron training recipes. (aws#1526)
4886606
Evan-W-ang added a commit
to Evan-W-ang/sagemaker-python-sdk
that referenced
this pull request
Jun 8, 2026
@Evan-W-ang
Usage docs for training recipes (aws#1630)
6a64501
* Feature: Support GPU training recipes with Sagemaker Python SDK (aws#1516)
* v0 estimator for launching kandinksy training
* code cleanup
* option to over-ride git repos for kandinsky for testing purposes
* update dependencies
* update comment
* formatting fixes
* style fixes
* code cleanup
* Add warning messages for ingored arguments
* cleanup, address comments
* fix
* clone launcher repo only if necessary
* add a cleanup method to call after fit
* fix docstring
* fix warning
* cleanup update
* fix
* code style fix
* rename cleanup method for clarity
* missed change
* move cleanup to when object is destroyed
* add unit tests
* formatting fix
* removing tests which don't work as recipe repos are private
* removing tests which don't work as recipe repos are private
* resolve comments
* resolve comments
* Feature: Support Neuron training recipes. (aws#1526)
* Feature: Resolve recipes correctly before launching (aws#1529)
* fix to work with launcher recipes
* fix suffix for temp file
* fix path and error message
* fix for recipes from launcher
* resolve recipes correctly
* fix imports
* reformat message to avoid code-doc test issue
* code style fix
* code style fix
* code style fix
* code style fix
* code style fix
* code style fix
* code style fix
* code style fix
* code style fix
* doc formatting
* check if resolver exists before registering
* Feature: Add unit tests for recipes and minor bug fixes. (aws#1532)
* basic checks and unit test for recipes
* More testing for recipes. Move recipe overrides to top before accessing any recipe fields.
* check that we use customer provided image uri if it is set
* reformat
* test fixes
* update git urls for recipes
* revert to ssh git urls for recipes
* Feature: Move image uris and git repos for training recipes to json (aws#1547)
* Update MANIFEST.in so that wheel builds correctly (aws#1563)
* Remove default values for fields in recipe_overrides and fix recipe path. (aws#1566)
* add optional source dir for recipes, copy training code and requirements to source dir
* diff names for recipe file and local script option
* format and add unit test
* make entry point script and recipe file temp files that can be gced
* formatting and fix
* test fix
* test fixes
* format fix
* break function up because it is too long
* fixes
* fix
* fix
* remove references to launcher and adapter dir as we copy out everything needed into source dir
* reformat
* copy all directory contents for trainium as there is more than one source file
* fix
* fix
* remove debugging message
* Change default source directory to current, add option to specify source dir (aws#1593)
* update to public uris for hyperpod recipe repos and smp image
* fixes
* remove debug copies
* change caps for env vars
* skip some tests for now
* format
* neuron json for retrieving images
* update training_recipes.json
* add unit test
* reformat
* fix long line
* add source dir check when using training recipe
* adding more regions
* reformat
* doc update
* doc update
* doc update
* doc update
* fix capitalization issues
* fix capitalization issues
* doc check issue
Sign up for freeto join this conversation on GitHub.
Already have an account?
Sign in to comment

Reviewers


1 more reviewer

@ajaykarpurajaykarpurajaykarpur approved these changes
Reviewers whose approvals may not affect merge requirements

Assignees


No one assigned


Labels


None yet


Projects


None yet


Milestone


No milestone


Development

Successfully merging this pull request may close these issues.

3 participants

@laurenyu@sagemaker-bot@ajaykarpur

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix");
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
doc: fix TF requirements.txt documentation - #1526
Merged
laurenyu merged 1 commit into
aws:masterfrom 
laurenyu:tf-req
May 26, 2020
Merged
doc: fix TF requirements.txt documentation#1526
laurenyu merged 1 commit into
aws:masterfrom 
laurenyu:tf-req
Conversation
@laurenyu
@laurenyulaurenyu
commented
May 26, 2020

Copy link


Copy Markdown

Contributor
Issue #, if available:
Description of changes:

follow-up to #1512 - TF script mode support for requirements.txt for versions before TF 1.15.2 with Python 3.7 and TF 2.2 was a bit of a fluke rather than intended behavior, as indicated by #839. However, it doesn't work consistently, which I verified by trying it out with the TF 1.14 image. This PR is to change the documentation to go with what we "officially recommended" at the time, which was the shell script workaround.
Testing done:

here's what I did to make sure that the shell script workaround works for TF 1.14:
$ cat src/entry.sh
python -m pip install -r requirements.txt
python hello.py
$ cat src/requirements.txt
pyfiglet
$ cat src/hello.py
from pyfiglet import Figlet
print(Figlet().renderText('hello').strip())
$ cat run.py
from sagemaker.tensorflow import TensorFlow
tf = TensorFlow(
entry_point='entry.sh',
source_dir='src',
framework_version='1.14',
py_version='py3',
role='SageMakerRole',
train_instance_type='local',
train_instance_count=1,
)
tf.fit()
$ python run.py

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 any/all 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.
@laurenyu
laurenyu
requested a review
from ajaykarpurMay 26, 2020 16:48
@sagemaker-bot
sagemaker-bot
commented
May 26, 2020

Copy link


Copy Markdown

Collaborator
AWS CodeBuild CI Report
  • Result: SUCCEEDED
  • Build Logs (available for 30 days)
Powered by github-codebuild-logs, available on the AWS Serverless Application Repository
@sagemaker-bot
sagemaker-bot
commented
May 26, 2020

Copy link


Copy Markdown

Collaborator
AWS CodeBuild CI Report
  • Result: SUCCEEDED
  • Build Logs (available for 30 days)
Powered by github-codebuild-logs, available on the AWS Serverless Application Repository
@sagemaker-bot
sagemaker-bot
commented
May 26, 2020

Copy link


Copy Markdown

Collaborator
AWS CodeBuild CI Report
  • Result: SUCCEEDED
  • Build Logs (available for 30 days)
Powered by github-codebuild-logs, available on the AWS Serverless Application Repository
@sagemaker-bot
sagemaker-bot
commented
May 26, 2020

Copy link


Copy Markdown

Collaborator
AWS CodeBuild CI Report
  • Result: SUCCEEDED
  • Build Logs (available for 30 days)
Powered by github-codebuild-logs, available on the AWS Serverless Application Repository
@laurenyu
laurenyu
merged commit 8ebbb71
into
aws:masterMay 26, 2020
@laurenyu
laurenyu
deleted the

tf-req

branch
May 26, 2020 17:02
pintaoz-aws pushed a commit
that referenced
this pull request
Dec 4, 2024
@schinmayee@pintaoz-aws
Feature: Support Neuron training recipes. (#1526)
13e10c9
pintaoz-aws pushed a commit
that referenced
this pull request
Dec 4, 2024
@schinmayee@pintaoz-aws
Usage docs for training recipes (#1630)
3bce287
* Feature: Support GPU training recipes with Sagemaker Python SDK (#1516)
* v0 estimator for launching kandinksy training
* code cleanup
* option to over-ride git repos for kandinsky for testing purposes
* update dependencies
* update comment
* formatting fixes
* style fixes
* code cleanup
* Add warning messages for ingored arguments
* cleanup, address comments
* fix
* clone launcher repo only if necessary
* add a cleanup method to call after fit
* fix docstring
* fix warning
* cleanup update
* fix
* code style fix
* rename cleanup method for clarity
* missed change
* move cleanup to when object is destroyed
* add unit tests
* formatting fix
* removing tests which don't work as recipe repos are private
* removing tests which don't work as recipe repos are private
* resolve comments
* resolve comments
* Feature: Support Neuron training recipes. (#1526)
* Feature: Resolve recipes correctly before launching (#1529)
* fix to work with launcher recipes
* fix suffix for temp file
* fix path and error message
* fix for recipes from launcher
* resolve recipes correctly
* fix imports
* reformat message to avoid code-doc test issue
* code style fix
* code style fix
* code style fix
* code style fix
* code style fix
* code style fix
* code style fix
* code style fix
* code style fix
* doc formatting
* check if resolver exists before registering
* Feature: Add unit tests for recipes and minor bug fixes. (#1532)
* basic checks and unit test for recipes
* More testing for recipes. Move recipe overrides to top before accessing any recipe fields.
* check that we use customer provided image uri if it is set
* reformat
* test fixes
* update git urls for recipes
* revert to ssh git urls for recipes
* Feature: Move image uris and git repos for training recipes to json (#1547)
* Update MANIFEST.in so that wheel builds correctly (#1563)
* Remove default values for fields in recipe_overrides and fix recipe path. (#1566)
* add optional source dir for recipes, copy training code and requirements to source dir
* diff names for recipe file and local script option
* format and add unit test
* make entry point script and recipe file temp files that can be gced
* formatting and fix
* test fix
* test fixes
* format fix
* break function up because it is too long
* fixes
* fix
* fix
* remove references to launcher and adapter dir as we copy out everything needed into source dir
* reformat
* copy all directory contents for trainium as there is more than one source file
* fix
* fix
* remove debugging message
* Change default source directory to current, add option to specify source dir (#1593)
* update to public uris for hyperpod recipe repos and smp image
* fixes
* remove debug copies
* change caps for env vars
* skip some tests for now
* format
* neuron json for retrieving images
* update training_recipes.json
* add unit test
* reformat
* fix long line
* add source dir check when using training recipe
* adding more regions
* reformat
* doc update
* doc update
* doc update
* doc update
* fix capitalization issues
* fix capitalization issues
* doc check issue
pintaoz-aws pushed a commit
that referenced
this pull request
Dec 4, 2024
@schinmayee@pintaoz-aws
Feature: Support Neuron training recipes. (#1526)
560052f
pintaoz-aws pushed a commit
that referenced
this pull request
Dec 4, 2024
@schinmayee@pintaoz-aws
Usage docs for training recipes (#1630)
efc9aa8
* Feature: Support GPU training recipes with Sagemaker Python SDK (#1516)
* v0 estimator for launching kandinksy training
* code cleanup
* option to over-ride git repos for kandinsky for testing purposes
* update dependencies
* update comment
* formatting fixes
* style fixes
* code cleanup
* Add warning messages for ingored arguments
* cleanup, address comments
* fix
* clone launcher repo only if necessary
* add a cleanup method to call after fit
* fix docstring
* fix warning
* cleanup update
* fix
* code style fix
* rename cleanup method for clarity
* missed change
* move cleanup to when object is destroyed
* add unit tests
* formatting fix
* removing tests which don't work as recipe repos are private
* removing tests which don't work as recipe repos are private
* resolve comments
* resolve comments
* Feature: Support Neuron training recipes. (#1526)
* Feature: Resolve recipes correctly before launching (#1529)
* fix to work with launcher recipes
* fix suffix for temp file
* fix path and error message
* fix for recipes from launcher
* resolve recipes correctly
* fix imports
* reformat message to avoid code-doc test issue
* code style fix
* code style fix
* code style fix
* code style fix
* code style fix
* code style fix
* code style fix
* code style fix
* code style fix
* doc formatting
* check if resolver exists before registering
* Feature: Add unit tests for recipes and minor bug fixes. (#1532)
* basic checks and unit test for recipes
* More testing for recipes. Move recipe overrides to top before accessing any recipe fields.
* check that we use customer provided image uri if it is set
* reformat
* test fixes
* update git urls for recipes
* revert to ssh git urls for recipes
* Feature: Move image uris and git repos for training recipes to json (#1547)
* Update MANIFEST.in so that wheel builds correctly (#1563)
* Remove default values for fields in recipe_overrides and fix recipe path. (#1566)
* add optional source dir for recipes, copy training code and requirements to source dir
* diff names for recipe file and local script option
* format and add unit test
* make entry point script and recipe file temp files that can be gced
* formatting and fix
* test fix
* test fixes
* format fix
* break function up because it is too long
* fixes
* fix
* fix
* remove references to launcher and adapter dir as we copy out everything needed into source dir
* reformat
* copy all directory contents for trainium as there is more than one source file
* fix
* fix
* remove debugging message
* Change default source directory to current, add option to specify source dir (#1593)
* update to public uris for hyperpod recipe repos and smp image
* fixes
* remove debug copies
* change caps for env vars
* skip some tests for now
* format
* neuron json for retrieving images
* update training_recipes.json
* add unit test
* reformat
* fix long line
* add source dir check when using training recipe
* adding more regions
* reformat
* doc update
* doc update
* doc update
* doc update
* fix capitalization issues
* fix capitalization issues
* doc check issue
Evan-W-ang added a commit
to Evan-W-ang/sagemaker-python-sdk
that referenced
this pull request
Jun 8, 2026
@Evan-W-ang
doc: fix TF requirements.txt documentation (aws#1526)
05d0c8f
Evan-W-ang added a commit
to Evan-W-ang/sagemaker-python-sdk
that referenced
this pull request
Jun 8, 2026
@Evan-W-ang
Feature: Support Neuron training recipes. (aws#1526)
4886606
Evan-W-ang added a commit
to Evan-W-ang/sagemaker-python-sdk
that referenced
this pull request
Jun 8, 2026
@Evan-W-ang
Usage docs for training recipes (aws#1630)
6a64501
* Feature: Support GPU training recipes with Sagemaker Python SDK (aws#1516)
* v0 estimator for launching kandinksy training
* code cleanup
* option to over-ride git repos for kandinsky for testing purposes
* update dependencies
* update comment
* formatting fixes
* style fixes
* code cleanup
* Add warning messages for ingored arguments
* cleanup, address comments
* fix
* clone launcher repo only if necessary
* add a cleanup method to call after fit
* fix docstring
* fix warning
* cleanup update
* fix
* code style fix
* rename cleanup method for clarity
* missed change
* move cleanup to when object is destroyed
* add unit tests
* formatting fix
* removing tests which don't work as recipe repos are private
* removing tests which don't work as recipe repos are private
* resolve comments
* resolve comments
* Feature: Support Neuron training recipes. (aws#1526)
* Feature: Resolve recipes correctly before launching (aws#1529)
* fix to work with launcher recipes
* fix suffix for temp file
* fix path and error message
* fix for recipes from launcher
* resolve recipes correctly
* fix imports
* reformat message to avoid code-doc test issue
* code style fix
* code style fix
* code style fix
* code style fix
* code style fix
* code style fix
* code style fix
* code style fix
* code style fix
* doc formatting
* check if resolver exists before registering
* Feature: Add unit tests for recipes and minor bug fixes. (aws#1532)
* basic checks and unit test for recipes
* More testing for recipes. Move recipe overrides to top before accessing any recipe fields.
* check that we use customer provided image uri if it is set
* reformat
* test fixes
* update git urls for recipes
* revert to ssh git urls for recipes
* Feature: Move image uris and git repos for training recipes to json (aws#1547)
* Update MANIFEST.in so that wheel builds correctly (aws#1563)
* Remove default values for fields in recipe_overrides and fix recipe path. (aws#1566)
* add optional source dir for recipes, copy training code and requirements to source dir
* diff names for recipe file and local script option
* format and add unit test
* make entry point script and recipe file temp files that can be gced
* formatting and fix
* test fix
* test fixes
* format fix
* break function up because it is too long
* fixes
* fix
* fix
* remove references to launcher and adapter dir as we copy out everything needed into source dir
* reformat
* copy all directory contents for trainium as there is more than one source file
* fix
* fix
* remove debugging message
* Change default source directory to current, add option to specify source dir (aws#1593)
* update to public uris for hyperpod recipe repos and smp image
* fixes
* remove debug copies
* change caps for env vars
* skip some tests for now
* format
* neuron json for retrieving images
* update training_recipes.json
* add unit test
* reformat
* fix long line
* add source dir check when using training recipe
* adding more regions
* reformat
* doc update
* doc update
* doc update
* doc update
* fix capitalization issues
* fix capitalization issues
* doc check issue
Sign up for freeto join this conversation on GitHub.
Already have an account?
Sign in to comment

Reviewers


1 more reviewer

@ajaykarpurajaykarpurajaykarpur approved these changes
Reviewers whose approvals may not affect merge requirements

Assignees


No one assigned


Labels


None yet


Projects


None yet


Milestone


No milestone


Development

Successfully merging this pull request may close these issues.

3 participants

@laurenyu@sagemaker-bot@ajaykarpur

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms");
}
} catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
doc: fix TF requirements.txt documentation - #1526
Merged
laurenyu merged 1 commit into
aws:masterfrom 
laurenyu:tf-req
May 26, 2020
Merged
doc: fix TF requirements.txt documentation#1526
laurenyu merged 1 commit into
aws:masterfrom 
laurenyu:tf-req
Conversation
@laurenyu
@laurenyulaurenyu
commented
May 26, 2020

Copy link


Copy Markdown

Contributor
Issue #, if available:
Description of changes:

follow-up to #1512 - TF script mode support for requirements.txt for versions before TF 1.15.2 with Python 3.7 and TF 2.2 was a bit of a fluke rather than intended behavior, as indicated by #839. However, it doesn't work consistently, which I verified by trying it out with the TF 1.14 image. This PR is to change the documentation to go with what we "officially recommended" at the time, which was the shell script workaround.
Testing done:

here's what I did to make sure that the shell script workaround works for TF 1.14:
$ cat src/entry.sh
python -m pip install -r requirements.txt
python hello.py
$ cat src/requirements.txt
pyfiglet
$ cat src/hello.py
from pyfiglet import Figlet
print(Figlet().renderText('hello').strip())
$ cat run.py
from sagemaker.tensorflow import TensorFlow
tf = TensorFlow(
entry_point='entry.sh',
source_dir='src',
framework_version='1.14',
py_version='py3',
role='SageMakerRole',
train_instance_type='local',
train_instance_count=1,
)
tf.fit()
$ python run.py

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 any/all 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.
@laurenyu
laurenyu
requested a review
from ajaykarpurMay 26, 2020 16:48
@sagemaker-bot
sagemaker-bot
commented
May 26, 2020

Copy link


Copy Markdown

Collaborator
AWS CodeBuild CI Report
  • Result: SUCCEEDED
  • Build Logs (available for 30 days)
Powered by github-codebuild-logs, available on the AWS Serverless Application Repository
@sagemaker-bot
sagemaker-bot
commented
May 26, 2020

Copy link


Copy Markdown

Collaborator
AWS CodeBuild CI Report
  • Result: SUCCEEDED
  • Build Logs (available for 30 days)
Powered by github-codebuild-logs, available on the AWS Serverless Application Repository
@sagemaker-bot
sagemaker-bot
commented
May 26, 2020

Copy link


Copy Markdown

Collaborator
AWS CodeBuild CI Report
  • Result: SUCCEEDED
  • Build Logs (available for 30 days)
Powered by github-codebuild-logs, available on the AWS Serverless Application Repository
@sagemaker-bot
sagemaker-bot
commented
May 26, 2020

Copy link


Copy Markdown

Collaborator
AWS CodeBuild CI Report
  • Result: SUCCEEDED
  • Build Logs (available for 30 days)
Powered by github-codebuild-logs, available on the AWS Serverless Application Repository
@laurenyu
laurenyu
merged commit 8ebbb71
into
aws:masterMay 26, 2020
@laurenyu
laurenyu
deleted the

tf-req

branch
May 26, 2020 17:02
pintaoz-aws pushed a commit
that referenced
this pull request
Dec 4, 2024
@schinmayee@pintaoz-aws
Feature: Support Neuron training recipes. (#1526)
13e10c9
pintaoz-aws pushed a commit
that referenced
this pull request
Dec 4, 2024
@schinmayee@pintaoz-aws
Usage docs for training recipes (#1630)
3bce287
* Feature: Support GPU training recipes with Sagemaker Python SDK (#1516)
* v0 estimator for launching kandinksy training
* code cleanup
* option to over-ride git repos for kandinsky for testing purposes
* update dependencies
* update comment
* formatting fixes
* style fixes
* code cleanup
* Add warning messages for ingored arguments
* cleanup, address comments
* fix
* clone launcher repo only if necessary
* add a cleanup method to call after fit
* fix docstring
* fix warning
* cleanup update
* fix
* code style fix
* rename cleanup method for clarity
* missed change
* move cleanup to when object is destroyed
* add unit tests
* formatting fix
* removing tests which don't work as recipe repos are private
* removing tests which don't work as recipe repos are private
* resolve comments
* resolve comments
* Feature: Support Neuron training recipes. (#1526)
* Feature: Resolve recipes correctly before launching (#1529)
* fix to work with launcher recipes
* fix suffix for temp file
* fix path and error message
* fix for recipes from launcher
* resolve recipes correctly
* fix imports
* reformat message to avoid code-doc test issue
* code style fix
* code style fix
* code style fix
* code style fix
* code style fix
* code style fix
* code style fix
* code style fix
* code style fix
* doc formatting
* check if resolver exists before registering
* Feature: Add unit tests for recipes and minor bug fixes. (#1532)
* basic checks and unit test for recipes
* More testing for recipes. Move recipe overrides to top before accessing any recipe fields.
* check that we use customer provided image uri if it is set
* reformat
* test fixes
* update git urls for recipes
* revert to ssh git urls for recipes
* Feature: Move image uris and git repos for training recipes to json (#1547)
* Update MANIFEST.in so that wheel builds correctly (#1563)
* Remove default values for fields in recipe_overrides and fix recipe path. (#1566)
* add optional source dir for recipes, copy training code and requirements to source dir
* diff names for recipe file and local script option
* format and add unit test
* make entry point script and recipe file temp files that can be gced
* formatting and fix
* test fix
* test fixes
* format fix
* break function up because it is too long
* fixes
* fix
* fix
* remove references to launcher and adapter dir as we copy out everything needed into source dir
* reformat
* copy all directory contents for trainium as there is more than one source file
* fix
* fix
* remove debugging message
* Change default source directory to current, add option to specify source dir (#1593)
* update to public uris for hyperpod recipe repos and smp image
* fixes
* remove debug copies
* change caps for env vars
* skip some tests for now
* format
* neuron json for retrieving images
* update training_recipes.json
* add unit test
* reformat
* fix long line
* add source dir check when using training recipe
* adding more regions
* reformat
* doc update
* doc update
* doc update
* doc update
* fix capitalization issues
* fix capitalization issues
* doc check issue
pintaoz-aws pushed a commit
that referenced
this pull request
Dec 4, 2024
@schinmayee@pintaoz-aws
Feature: Support Neuron training recipes. (#1526)
560052f
pintaoz-aws pushed a commit
that referenced
this pull request
Dec 4, 2024
@schinmayee@pintaoz-aws
Usage docs for training recipes (#1630)
efc9aa8
* Feature: Support GPU training recipes with Sagemaker Python SDK (#1516)
* v0 estimator for launching kandinksy training
* code cleanup
* option to over-ride git repos for kandinsky for testing purposes
* update dependencies
* update comment
* formatting fixes
* style fixes
* code cleanup
* Add warning messages for ingored arguments
* cleanup, address comments
* fix
* clone launcher repo only if necessary
* add a cleanup method to call after fit
* fix docstring
* fix warning
* cleanup update
* fix
* code style fix
* rename cleanup method for clarity
* missed change
* move cleanup to when object is destroyed
* add unit tests
* formatting fix
* removing tests which don't work as recipe repos are private
* removing tests which don't work as recipe repos are private
* resolve comments
* resolve comments
* Feature: Support Neuron training recipes. (#1526)
* Feature: Resolve recipes correctly before launching (#1529)
* fix to work with launcher recipes
* fix suffix for temp file
* fix path and error message
* fix for recipes from launcher
* resolve recipes correctly
* fix imports
* reformat message to avoid code-doc test issue
* code style fix
* code style fix
* code style fix
* code style fix
* code style fix
* code style fix
* code style fix
* code style fix
* code style fix
* doc formatting
* check if resolver exists before registering
* Feature: Add unit tests for recipes and minor bug fixes. (#1532)
* basic checks and unit test for recipes
* More testing for recipes. Move recipe overrides to top before accessing any recipe fields.
* check that we use customer provided image uri if it is set
* reformat
* test fixes
* update git urls for recipes
* revert to ssh git urls for recipes
* Feature: Move image uris and git repos for training recipes to json (#1547)
* Update MANIFEST.in so that wheel builds correctly (#1563)
* Remove default values for fields in recipe_overrides and fix recipe path. (#1566)
* add optional source dir for recipes, copy training code and requirements to source dir
* diff names for recipe file and local script option
* format and add unit test
* make entry point script and recipe file temp files that can be gced
* formatting and fix
* test fix
* test fixes
* format fix
* break function up because it is too long
* fixes
* fix
* fix
* remove references to launcher and adapter dir as we copy out everything needed into source dir
* reformat
* copy all directory contents for trainium as there is more than one source file
* fix
* fix
* remove debugging message
* Change default source directory to current, add option to specify source dir (#1593)
* update to public uris for hyperpod recipe repos and smp image
* fixes
* remove debug copies
* change caps for env vars
* skip some tests for now
* format
* neuron json for retrieving images
* update training_recipes.json
* add unit test
* reformat
* fix long line
* add source dir check when using training recipe
* adding more regions
* reformat
* doc update
* doc update
* doc update
* doc update
* fix capitalization issues
* fix capitalization issues
* doc check issue
Evan-W-ang added a commit
to Evan-W-ang/sagemaker-python-sdk
that referenced
this pull request
Jun 8, 2026
@Evan-W-ang
doc: fix TF requirements.txt documentation (aws#1526)
05d0c8f
Evan-W-ang added a commit
to Evan-W-ang/sagemaker-python-sdk
that referenced
this pull request
Jun 8, 2026
@Evan-W-ang
Feature: Support Neuron training recipes. (aws#1526)
4886606
Evan-W-ang added a commit
to Evan-W-ang/sagemaker-python-sdk
that referenced
this pull request
Jun 8, 2026
@Evan-W-ang
Usage docs for training recipes (aws#1630)
6a64501
* Feature: Support GPU training recipes with Sagemaker Python SDK (aws#1516)
* v0 estimator for launching kandinksy training
* code cleanup
* option to over-ride git repos for kandinsky for testing purposes
* update dependencies
* update comment
* formatting fixes
* style fixes
* code cleanup
* Add warning messages for ingored arguments
* cleanup, address comments
* fix
* clone launcher repo only if necessary
* add a cleanup method to call after fit
* fix docstring
* fix warning
* cleanup update
* fix
* code style fix
* rename cleanup method for clarity
* missed change
* move cleanup to when object is destroyed
* add unit tests
* formatting fix
* removing tests which don't work as recipe repos are private
* removing tests which don't work as recipe repos are private
* resolve comments
* resolve comments
* Feature: Support Neuron training recipes. (aws#1526)
* Feature: Resolve recipes correctly before launching (aws#1529)
* fix to work with launcher recipes
* fix suffix for temp file
* fix path and error message
* fix for recipes from launcher
* resolve recipes correctly
* fix imports
* reformat message to avoid code-doc test issue
* code style fix
* code style fix
* code style fix
* code style fix
* code style fix
* code style fix
* code style fix
* code style fix
* code style fix
* doc formatting
* check if resolver exists before registering
* Feature: Add unit tests for recipes and minor bug fixes. (aws#1532)
* basic checks and unit test for recipes
* More testing for recipes. Move recipe overrides to top before accessing any recipe fields.
* check that we use customer provided image uri if it is set
* reformat
* test fixes
* update git urls for recipes
* revert to ssh git urls for recipes
* Feature: Move image uris and git repos for training recipes to json (aws#1547)
* Update MANIFEST.in so that wheel builds correctly (aws#1563)
* Remove default values for fields in recipe_overrides and fix recipe path. (aws#1566)
* add optional source dir for recipes, copy training code and requirements to source dir
* diff names for recipe file and local script option
* format and add unit test
* make entry point script and recipe file temp files that can be gced
* formatting and fix
* test fix
* test fixes
* format fix
* break function up because it is too long
* fixes
* fix
* fix
* remove references to launcher and adapter dir as we copy out everything needed into source dir
* reformat
* copy all directory contents for trainium as there is more than one source file
* fix
* fix
* remove debugging message
* Change default source directory to current, add option to specify source dir (aws#1593)
* update to public uris for hyperpod recipe repos and smp image
* fixes
* remove debug copies
* change caps for env vars
* skip some tests for now
* format
* neuron json for retrieving images
* update training_recipes.json
* add unit test
* reformat
* fix long line
* add source dir check when using training recipe
* adding more regions
* reformat
* doc update
* doc update
* doc update
* doc update
* fix capitalization issues
* fix capitalization issues
* doc check issue
Sign up for freeto join this conversation on GitHub.
Already have an account?
Sign in to comment

Reviewers


1 more reviewer

@ajaykarpurajaykarpurajaykarpur approved these changes
Reviewers whose approvals may not affect merge requirements

Assignees


No one assigned


Labels


None yet


Projects


None yet


Milestone


No milestone


Development

Successfully merging this pull request may close these issues.

3 participants

@laurenyu@sagemaker-bot@ajaykarpur

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links");
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '

Skip to content
doc: fix TF requirements.txt documentation - #1526
Merged
laurenyu merged 1 commit into
aws:masterfrom 
laurenyu:tf-req
May 26, 2020
Merged
doc: fix TF requirements.txt documentation#1526
laurenyu merged 1 commit into
aws:masterfrom 
laurenyu:tf-req
Conversation
@laurenyu
@laurenyulaurenyu
commented
May 26, 2020

Copy link


Copy Markdown

Contributor
Issue #, if available:
Description of changes:

follow-up to #1512 - TF script mode support for requirements.txt for versions before TF 1.15.2 with Python 3.7 and TF 2.2 was a bit of a fluke rather than intended behavior, as indicated by #839. However, it doesn't work consistently, which I verified by trying it out with the TF 1.14 image. This PR is to change the documentation to go with what we "officially recommended" at the time, which was the shell script workaround.
Testing done:

here's what I did to make sure that the shell script workaround works for TF 1.14:
$ cat src/entry.sh
python -m pip install -r requirements.txt
python hello.py
$ cat src/requirements.txt
pyfiglet
$ cat src/hello.py
from pyfiglet import Figlet
print(Figlet().renderText('hello').strip())
$ cat run.py
from sagemaker.tensorflow import TensorFlow
tf = TensorFlow(
entry_point='entry.sh',
source_dir='src',
framework_version='1.14',
py_version='py3',
role='SageMakerRole',
train_instance_type='local',
train_instance_count=1,
)
tf.fit()
$ python run.py

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 any/all 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.
@laurenyu
laurenyu
requested a review
from ajaykarpurMay 26, 2020 16:48
@sagemaker-bot
sagemaker-bot
commented
May 26, 2020

Copy link


Copy Markdown

Collaborator
AWS CodeBuild CI Report
  • Result: SUCCEEDED
  • Build Logs (available for 30 days)
Powered by github-codebuild-logs, available on the AWS Serverless Application Repository
@sagemaker-bot
sagemaker-bot
commented
May 26, 2020

Copy link


Copy Markdown

Collaborator
AWS CodeBuild CI Report
  • Result: SUCCEEDED
  • Build Logs (available for 30 days)
Powered by github-codebuild-logs, available on the AWS Serverless Application Repository
@sagemaker-bot
sagemaker-bot
commented
May 26, 2020

Copy link


Copy Markdown

Collaborator
AWS CodeBuild CI Report
  • Result: SUCCEEDED
  • Build Logs (available for 30 days)
Powered by github-codebuild-logs, available on the AWS Serverless Application Repository
@sagemaker-bot
sagemaker-bot
commented
May 26, 2020

Copy link


Copy Markdown

Collaborator
AWS CodeBuild CI Report
  • Result: SUCCEEDED
  • Build Logs (available for 30 days)
Powered by github-codebuild-logs, available on the AWS Serverless Application Repository
@laurenyu
laurenyu
merged commit 8ebbb71
into
aws:masterMay 26, 2020
@laurenyu
laurenyu
deleted the

tf-req

branch
May 26, 2020 17:02
pintaoz-aws pushed a commit
that referenced
this pull request
Dec 4, 2024
@schinmayee@pintaoz-aws
Feature: Support Neuron training recipes. (#1526)
13e10c9
pintaoz-aws pushed a commit
that referenced
this pull request
Dec 4, 2024
@schinmayee@pintaoz-aws
Usage docs for training recipes (#1630)
3bce287
* Feature: Support GPU training recipes with Sagemaker Python SDK (#1516)
* v0 estimator for launching kandinksy training
* code cleanup
* option to over-ride git repos for kandinsky for testing purposes
* update dependencies
* update comment
* formatting fixes
* style fixes
* code cleanup
* Add warning messages for ingored arguments
* cleanup, address comments
* fix
* clone launcher repo only if necessary
* add a cleanup method to call after fit
* fix docstring
* fix warning
* cleanup update
* fix
* code style fix
* rename cleanup method for clarity
* missed change
* move cleanup to when object is destroyed
* add unit tests
* formatting fix
* removing tests which don't work as recipe repos are private
* removing tests which don't work as recipe repos are private
* resolve comments
* resolve comments
* Feature: Support Neuron training recipes. (#1526)
* Feature: Resolve recipes correctly before launching (#1529)
* fix to work with launcher recipes
* fix suffix for temp file
* fix path and error message
* fix for recipes from launcher
* resolve recipes correctly
* fix imports
* reformat message to avoid code-doc test issue
* code style fix
* code style fix
* code style fix
* code style fix
* code style fix
* code style fix
* code style fix
* code style fix
* code style fix
* doc formatting
* check if resolver exists before registering
* Feature: Add unit tests for recipes and minor bug fixes. (#1532)
* basic checks and unit test for recipes
* More testing for recipes. Move recipe overrides to top before accessing any recipe fields.
* check that we use customer provided image uri if it is set
* reformat
* test fixes
* update git urls for recipes
* revert to ssh git urls for recipes
* Feature: Move image uris and git repos for training recipes to json (#1547)
* Update MANIFEST.in so that wheel builds correctly (#1563)
* Remove default values for fields in recipe_overrides and fix recipe path. (#1566)
* add optional source dir for recipes, copy training code and requirements to source dir
* diff names for recipe file and local script option
* format and add unit test
* make entry point script and recipe file temp files that can be gced
* formatting and fix
* test fix
* test fixes
* format fix
* break function up because it is too long
* fixes
* fix
* fix
* remove references to launcher and adapter dir as we copy out everything needed into source dir
* reformat
* copy all directory contents for trainium as there is more than one source file
* fix
* fix
* remove debugging message
* Change default source directory to current, add option to specify source dir (#1593)
* update to public uris for hyperpod recipe repos and smp image
* fixes
* remove debug copies
* change caps for env vars
* skip some tests for now
* format
* neuron json for retrieving images
* update training_recipes.json
* add unit test
* reformat
* fix long line
* add source dir check when using training recipe
* adding more regions
* reformat
* doc update
* doc update
* doc update
* doc update
* fix capitalization issues
* fix capitalization issues
* doc check issue
pintaoz-aws pushed a commit
that referenced
this pull request
Dec 4, 2024
@schinmayee@pintaoz-aws
Feature: Support Neuron training recipes. (#1526)
560052f
pintaoz-aws pushed a commit
that referenced
this pull request
Dec 4, 2024
@schinmayee@pintaoz-aws
Usage docs for training recipes (#1630)
efc9aa8
* Feature: Support GPU training recipes with Sagemaker Python SDK (#1516)
* v0 estimator for launching kandinksy training
* code cleanup
* option to over-ride git repos for kandinsky for testing purposes
* update dependencies
* update comment
* formatting fixes
* style fixes
* code cleanup
* Add warning messages for ingored arguments
* cleanup, address comments
* fix
* clone launcher repo only if necessary
* add a cleanup method to call after fit
* fix docstring
* fix warning
* cleanup update
* fix
* code style fix
* rename cleanup method for clarity
* missed change
* move cleanup to when object is destroyed
* add unit tests
* formatting fix
* removing tests which don't work as recipe repos are private
* removing tests which don't work as recipe repos are private
* resolve comments
* resolve comments
* Feature: Support Neuron training recipes. (#1526)
* Feature: Resolve recipes correctly before launching (#1529)
* fix to work with launcher recipes
* fix suffix for temp file
* fix path and error message
* fix for recipes from launcher
* resolve recipes correctly
* fix imports
* reformat message to avoid code-doc test issue
* code style fix
* code style fix
* code style fix
* code style fix
* code style fix
* code style fix
* code style fix
* code style fix
* code style fix
* doc formatting
* check if resolver exists before registering
* Feature: Add unit tests for recipes and minor bug fixes. (#1532)
* basic checks and unit test for recipes
* More testing for recipes. Move recipe overrides to top before accessing any recipe fields.
* check that we use customer provided image uri if it is set
* reformat
* test fixes
* update git urls for recipes
* revert to ssh git urls for recipes
* Feature: Move image uris and git repos for training recipes to json (#1547)
* Update MANIFEST.in so that wheel builds correctly (#1563)
* Remove default values for fields in recipe_overrides and fix recipe path. (#1566)
* add optional source dir for recipes, copy training code and requirements to source dir
* diff names for recipe file and local script option
* format and add unit test
* make entry point script and recipe file temp files that can be gced
* formatting and fix
* test fix
* test fixes
* format fix
* break function up because it is too long
* fixes
* fix
* fix
* remove references to launcher and adapter dir as we copy out everything needed into source dir
* reformat
* copy all directory contents for trainium as there is more than one source file
* fix
* fix
* remove debugging message
* Change default source directory to current, add option to specify source dir (#1593)
* update to public uris for hyperpod recipe repos and smp image
* fixes
* remove debug copies
* change caps for env vars
* skip some tests for now
* format
* neuron json for retrieving images
* update training_recipes.json
* add unit test
* reformat
* fix long line
* add source dir check when using training recipe
* adding more regions
* reformat
* doc update
* doc update
* doc update
* doc update
* fix capitalization issues
* fix capitalization issues
* doc check issue
Evan-W-ang added a commit
to Evan-W-ang/sagemaker-python-sdk
that referenced
this pull request
Jun 8, 2026
@Evan-W-ang
doc: fix TF requirements.txt documentation (aws#1526)
05d0c8f
Evan-W-ang added a commit
to Evan-W-ang/sagemaker-python-sdk
that referenced
this pull request
Jun 8, 2026
@Evan-W-ang
Feature: Support Neuron training recipes. (aws#1526)
4886606
Evan-W-ang added a commit
to Evan-W-ang/sagemaker-python-sdk
that referenced
this pull request
Jun 8, 2026
@Evan-W-ang
Usage docs for training recipes (aws#1630)
6a64501
* Feature: Support GPU training recipes with Sagemaker Python SDK (aws#1516)
* v0 estimator for launching kandinksy training
* code cleanup
* option to over-ride git repos for kandinsky for testing purposes
* update dependencies
* update comment
* formatting fixes
* style fixes
* code cleanup
* Add warning messages for ingored arguments
* cleanup, address comments
* fix
* clone launcher repo only if necessary
* add a cleanup method to call after fit
* fix docstring
* fix warning
* cleanup update
* fix
* code style fix
* rename cleanup method for clarity
* missed change
* move cleanup to when object is destroyed
* add unit tests
* formatting fix
* removing tests which don't work as recipe repos are private
* removing tests which don't work as recipe repos are private
* resolve comments
* resolve comments
* Feature: Support Neuron training recipes. (aws#1526)
* Feature: Resolve recipes correctly before launching (aws#1529)
* fix to work with launcher recipes
* fix suffix for temp file
* fix path and error message
* fix for recipes from launcher
* resolve recipes correctly
* fix imports
* reformat message to avoid code-doc test issue
* code style fix
* code style fix
* code style fix
* code style fix
* code style fix
* code style fix
* code style fix
* code style fix
* code style fix
* doc formatting
* check if resolver exists before registering
* Feature: Add unit tests for recipes and minor bug fixes. (aws#1532)
* basic checks and unit test for recipes
* More testing for recipes. Move recipe overrides to top before accessing any recipe fields.
* check that we use customer provided image uri if it is set
* reformat
* test fixes
* update git urls for recipes
* revert to ssh git urls for recipes
* Feature: Move image uris and git repos for training recipes to json (aws#1547)
* Update MANIFEST.in so that wheel builds correctly (aws#1563)
* Remove default values for fields in recipe_overrides and fix recipe path. (aws#1566)
* add optional source dir for recipes, copy training code and requirements to source dir
* diff names for recipe file and local script option
* format and add unit test
* make entry point script and recipe file temp files that can be gced
* formatting and fix
* test fix
* test fixes
* format fix
* break function up because it is too long
* fixes
* fix
* fix
* remove references to launcher and adapter dir as we copy out everything needed into source dir
* reformat
* copy all directory contents for trainium as there is more than one source file
* fix
* fix
* remove debugging message
* Change default source directory to current, add option to specify source dir (aws#1593)
* update to public uris for hyperpod recipe repos and smp image
* fixes
* remove debug copies
* change caps for env vars
* skip some tests for now
* format
* neuron json for retrieving images
* update training_recipes.json
* add unit test
* reformat
* fix long line
* add source dir check when using training recipe
* adding more regions
* reformat
* doc update
* doc update
* doc update
* doc update
* fix capitalization issues
* fix capitalization issues
* doc check issue
Sign up for freeto join this conversation on GitHub.
Already have an account?
Sign in to comment

Reviewers


1 more reviewer

@ajaykarpurajaykarpurajaykarpur approved these changes
Reviewers whose approvals may not affect merge requirements

Assignees


No one assigned


Labels


None yet


Projects


None yet


Milestone


No milestone


Development

Successfully merging this pull request may close these issues.

3 participants

@laurenyu@sagemaker-bot@ajaykarpur

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default");
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
doc: fix TF requirements.txt documentation - #1526
Merged
laurenyu merged 1 commit into
aws:masterfrom 
laurenyu:tf-req
May 26, 2020
Merged
doc: fix TF requirements.txt documentation#1526
laurenyu merged 1 commit into
aws:masterfrom 
laurenyu:tf-req
Conversation
@laurenyu
@laurenyulaurenyu
commented
May 26, 2020

Copy link


Copy Markdown

Contributor
Issue #, if available:
Description of changes:

follow-up to #1512 - TF script mode support for requirements.txt for versions before TF 1.15.2 with Python 3.7 and TF 2.2 was a bit of a fluke rather than intended behavior, as indicated by #839. However, it doesn't work consistently, which I verified by trying it out with the TF 1.14 image. This PR is to change the documentation to go with what we "officially recommended" at the time, which was the shell script workaround.
Testing done:

here's what I did to make sure that the shell script workaround works for TF 1.14:
$ cat src/entry.sh
python -m pip install -r requirements.txt
python hello.py
$ cat src/requirements.txt
pyfiglet
$ cat src/hello.py
from pyfiglet import Figlet
print(Figlet().renderText('hello').strip())
$ cat run.py
from sagemaker.tensorflow import TensorFlow
tf = TensorFlow(
entry_point='entry.sh',
source_dir='src',
framework_version='1.14',
py_version='py3',
role='SageMakerRole',
train_instance_type='local',
train_instance_count=1,
)
tf.fit()
$ python run.py

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 any/all 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.
@laurenyu
laurenyu
requested a review
from ajaykarpurMay 26, 2020 16:48
@sagemaker-bot
sagemaker-bot
commented
May 26, 2020

Copy link


Copy Markdown

Collaborator
AWS CodeBuild CI Report
  • Result: SUCCEEDED
  • Build Logs (available for 30 days)
Powered by github-codebuild-logs, available on the AWS Serverless Application Repository
@sagemaker-bot
sagemaker-bot
commented
May 26, 2020

Copy link


Copy Markdown

Collaborator
AWS CodeBuild CI Report
  • Result: SUCCEEDED
  • Build Logs (available for 30 days)
Powered by github-codebuild-logs, available on the AWS Serverless Application Repository
@sagemaker-bot
sagemaker-bot
commented
May 26, 2020

Copy link


Copy Markdown

Collaborator
AWS CodeBuild CI Report
  • Result: SUCCEEDED
  • Build Logs (available for 30 days)
Powered by github-codebuild-logs, available on the AWS Serverless Application Repository
@sagemaker-bot
sagemaker-bot
commented
May 26, 2020

Copy link


Copy Markdown

Collaborator
AWS CodeBuild CI Report
  • Result: SUCCEEDED
  • Build Logs (available for 30 days)
Powered by github-codebuild-logs, available on the AWS Serverless Application Repository
@laurenyu
laurenyu
merged commit 8ebbb71
into
aws:masterMay 26, 2020
@laurenyu
laurenyu
deleted the

tf-req

branch
May 26, 2020 17:02
pintaoz-aws pushed a commit
that referenced
this pull request
Dec 4, 2024
@schinmayee@pintaoz-aws
Feature: Support Neuron training recipes. (#1526)
13e10c9
pintaoz-aws pushed a commit
that referenced
this pull request
Dec 4, 2024
@schinmayee@pintaoz-aws
Usage docs for training recipes (#1630)
3bce287
* Feature: Support GPU training recipes with Sagemaker Python SDK (#1516)
* v0 estimator for launching kandinksy training
* code cleanup
* option to over-ride git repos for kandinsky for testing purposes
* update dependencies
* update comment
* formatting fixes
* style fixes
* code cleanup
* Add warning messages for ingored arguments
* cleanup, address comments
* fix
* clone launcher repo only if necessary
* add a cleanup method to call after fit
* fix docstring
* fix warning
* cleanup update
* fix
* code style fix
* rename cleanup method for clarity
* missed change
* move cleanup to when object is destroyed
* add unit tests
* formatting fix
* removing tests which don't work as recipe repos are private
* removing tests which don't work as recipe repos are private
* resolve comments
* resolve comments
* Feature: Support Neuron training recipes. (#1526)
* Feature: Resolve recipes correctly before launching (#1529)
* fix to work with launcher recipes
* fix suffix for temp file
* fix path and error message
* fix for recipes from launcher
* resolve recipes correctly
* fix imports
* reformat message to avoid code-doc test issue
* code style fix
* code style fix
* code style fix
* code style fix
* code style fix
* code style fix
* code style fix
* code style fix
* code style fix
* doc formatting
* check if resolver exists before registering
* Feature: Add unit tests for recipes and minor bug fixes. (#1532)
* basic checks and unit test for recipes
* More testing for recipes. Move recipe overrides to top before accessing any recipe fields.
* check that we use customer provided image uri if it is set
* reformat
* test fixes
* update git urls for recipes
* revert to ssh git urls for recipes
* Feature: Move image uris and git repos for training recipes to json (#1547)
* Update MANIFEST.in so that wheel builds correctly (#1563)
* Remove default values for fields in recipe_overrides and fix recipe path. (#1566)
* add optional source dir for recipes, copy training code and requirements to source dir
* diff names for recipe file and local script option
* format and add unit test
* make entry point script and recipe file temp files that can be gced
* formatting and fix
* test fix
* test fixes
* format fix
* break function up because it is too long
* fixes
* fix
* fix
* remove references to launcher and adapter dir as we copy out everything needed into source dir
* reformat
* copy all directory contents for trainium as there is more than one source file
* fix
* fix
* remove debugging message
* Change default source directory to current, add option to specify source dir (#1593)
* update to public uris for hyperpod recipe repos and smp image
* fixes
* remove debug copies
* change caps for env vars
* skip some tests for now
* format
* neuron json for retrieving images
* update training_recipes.json
* add unit test
* reformat
* fix long line
* add source dir check when using training recipe
* adding more regions
* reformat
* doc update
* doc update
* doc update
* doc update
* fix capitalization issues
* fix capitalization issues
* doc check issue
pintaoz-aws pushed a commit
that referenced
this pull request
Dec 4, 2024
@schinmayee@pintaoz-aws
Feature: Support Neuron training recipes. (#1526)
560052f
pintaoz-aws pushed a commit
that referenced
this pull request
Dec 4, 2024
@schinmayee@pintaoz-aws
Usage docs for training recipes (#1630)
efc9aa8
* Feature: Support GPU training recipes with Sagemaker Python SDK (#1516)
* v0 estimator for launching kandinksy training
* code cleanup
* option to over-ride git repos for kandinsky for testing purposes
* update dependencies
* update comment
* formatting fixes
* style fixes
* code cleanup
* Add warning messages for ingored arguments
* cleanup, address comments
* fix
* clone launcher repo only if necessary
* add a cleanup method to call after fit
* fix docstring
* fix warning
* cleanup update
* fix
* code style fix
* rename cleanup method for clarity
* missed change
* move cleanup to when object is destroyed
* add unit tests
* formatting fix
* removing tests which don't work as recipe repos are private
* removing tests which don't work as recipe repos are private
* resolve comments
* resolve comments
* Feature: Support Neuron training recipes. (#1526)
* Feature: Resolve recipes correctly before launching (#1529)
* fix to work with launcher recipes
* fix suffix for temp file
* fix path and error message
* fix for recipes from launcher
* resolve recipes correctly
* fix imports
* reformat message to avoid code-doc test issue
* code style fix
* code style fix
* code style fix
* code style fix
* code style fix
* code style fix
* code style fix
* code style fix
* code style fix
* doc formatting
* check if resolver exists before registering
* Feature: Add unit tests for recipes and minor bug fixes. (#1532)
* basic checks and unit test for recipes
* More testing for recipes. Move recipe overrides to top before accessing any recipe fields.
* check that we use customer provided image uri if it is set
* reformat
* test fixes
* update git urls for recipes
* revert to ssh git urls for recipes
* Feature: Move image uris and git repos for training recipes to json (#1547)
* Update MANIFEST.in so that wheel builds correctly (#1563)
* Remove default values for fields in recipe_overrides and fix recipe path. (#1566)
* add optional source dir for recipes, copy training code and requirements to source dir
* diff names for recipe file and local script option
* format and add unit test
* make entry point script and recipe file temp files that can be gced
* formatting and fix
* test fix
* test fixes
* format fix
* break function up because it is too long
* fixes
* fix
* fix
* remove references to launcher and adapter dir as we copy out everything needed into source dir
* reformat
* copy all directory contents for trainium as there is more than one source file
* fix
* fix
* remove debugging message
* Change default source directory to current, add option to specify source dir (#1593)
* update to public uris for hyperpod recipe repos and smp image
* fixes
* remove debug copies
* change caps for env vars
* skip some tests for now
* format
* neuron json for retrieving images
* update training_recipes.json
* add unit test
* reformat
* fix long line
* add source dir check when using training recipe
* adding more regions
* reformat
* doc update
* doc update
* doc update
* doc update
* fix capitalization issues
* fix capitalization issues
* doc check issue
Evan-W-ang added a commit
to Evan-W-ang/sagemaker-python-sdk
that referenced
this pull request
Jun 8, 2026
@Evan-W-ang
doc: fix TF requirements.txt documentation (aws#1526)
05d0c8f
Evan-W-ang added a commit
to Evan-W-ang/sagemaker-python-sdk
that referenced
this pull request
Jun 8, 2026
@Evan-W-ang
Feature: Support Neuron training recipes. (aws#1526)
4886606
Evan-W-ang added a commit
to Evan-W-ang/sagemaker-python-sdk
that referenced
this pull request
Jun 8, 2026
@Evan-W-ang
Usage docs for training recipes (aws#1630)
6a64501
* Feature: Support GPU training recipes with Sagemaker Python SDK (aws#1516)
* v0 estimator for launching kandinksy training
* code cleanup
* option to over-ride git repos for kandinsky for testing purposes
* update dependencies
* update comment
* formatting fixes
* style fixes
* code cleanup
* Add warning messages for ingored arguments
* cleanup, address comments
* fix
* clone launcher repo only if necessary
* add a cleanup method to call after fit
* fix docstring
* fix warning
* cleanup update
* fix
* code style fix
* rename cleanup method for clarity
* missed change
* move cleanup to when object is destroyed
* add unit tests
* formatting fix
* removing tests which don't work as recipe repos are private
* removing tests which don't work as recipe repos are private
* resolve comments
* resolve comments
* Feature: Support Neuron training recipes. (aws#1526)
* Feature: Resolve recipes correctly before launching (aws#1529)
* fix to work with launcher recipes
* fix suffix for temp file
* fix path and error message
* fix for recipes from launcher
* resolve recipes correctly
* fix imports
* reformat message to avoid code-doc test issue
* code style fix
* code style fix
* code style fix
* code style fix
* code style fix
* code style fix
* code style fix
* code style fix
* code style fix
* doc formatting
* check if resolver exists before registering
* Feature: Add unit tests for recipes and minor bug fixes. (aws#1532)
* basic checks and unit test for recipes
* More testing for recipes. Move recipe overrides to top before accessing any recipe fields.
* check that we use customer provided image uri if it is set
* reformat
* test fixes
* update git urls for recipes
* revert to ssh git urls for recipes
* Feature: Move image uris and git repos for training recipes to json (aws#1547)
* Update MANIFEST.in so that wheel builds correctly (aws#1563)
* Remove default values for fields in recipe_overrides and fix recipe path. (aws#1566)
* add optional source dir for recipes, copy training code and requirements to source dir
* diff names for recipe file and local script option
* format and add unit test
* make entry point script and recipe file temp files that can be gced
* formatting and fix
* test fix
* test fixes
* format fix
* break function up because it is too long
* fixes
* fix
* fix
* remove references to launcher and adapter dir as we copy out everything needed into source dir
* reformat
* copy all directory contents for trainium as there is more than one source file
* fix
* fix
* remove debugging message
* Change default source directory to current, add option to specify source dir (aws#1593)
* update to public uris for hyperpod recipe repos and smp image
* fixes
* remove debug copies
* change caps for env vars
* skip some tests for now
* format
* neuron json for retrieving images
* update training_recipes.json
* add unit test
* reformat
* fix long line
* add source dir check when using training recipe
* adding more regions
* reformat
* doc update
* doc update
* doc update
* doc update
* fix capitalization issues
* fix capitalization issues
* doc check issue
Sign up for freeto join this conversation on GitHub.
Already have an account?
Sign in to comment

Reviewers


1 more reviewer

@ajaykarpurajaykarpurajaykarpur approved these changes
Reviewers whose approvals may not affect merge requirements

Assignees


No one assigned


Labels


None yet


Projects


None yet


Milestone


No milestone


Development

Successfully merging this pull request may close these issues.

3 participants

@laurenyu@sagemaker-bot@ajaykarpur

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers");
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
doc: fix TF requirements.txt documentation - #1526
Merged
laurenyu merged 1 commit into
aws:masterfrom 
laurenyu:tf-req
May 26, 2020
Merged
doc: fix TF requirements.txt documentation#1526
laurenyu merged 1 commit into
aws:masterfrom 
laurenyu:tf-req
Conversation
@laurenyu
@laurenyulaurenyu
commented
May 26, 2020

Copy link


Copy Markdown

Contributor
Issue #, if available:
Description of changes:

follow-up to #1512 - TF script mode support for requirements.txt for versions before TF 1.15.2 with Python 3.7 and TF 2.2 was a bit of a fluke rather than intended behavior, as indicated by #839. However, it doesn't work consistently, which I verified by trying it out with the TF 1.14 image. This PR is to change the documentation to go with what we "officially recommended" at the time, which was the shell script workaround.
Testing done:

here's what I did to make sure that the shell script workaround works for TF 1.14:
$ cat src/entry.sh
python -m pip install -r requirements.txt
python hello.py
$ cat src/requirements.txt
pyfiglet
$ cat src/hello.py
from pyfiglet import Figlet
print(Figlet().renderText('hello').strip())
$ cat run.py
from sagemaker.tensorflow import TensorFlow
tf = TensorFlow(
entry_point='entry.sh',
source_dir='src',
framework_version='1.14',
py_version='py3',
role='SageMakerRole',
train_instance_type='local',
train_instance_count=1,
)
tf.fit()
$ python run.py

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 any/all 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.
@laurenyu
laurenyu
requested a review
from ajaykarpurMay 26, 2020 16:48
@sagemaker-bot
sagemaker-bot
commented
May 26, 2020

Copy link


Copy Markdown

Collaborator
AWS CodeBuild CI Report
  • Result: SUCCEEDED
  • Build Logs (available for 30 days)
Powered by github-codebuild-logs, available on the AWS Serverless Application Repository
@sagemaker-bot
sagemaker-bot
commented
May 26, 2020

Copy link


Copy Markdown

Collaborator
AWS CodeBuild CI Report
  • Result: SUCCEEDED
  • Build Logs (available for 30 days)
Powered by github-codebuild-logs, available on the AWS Serverless Application Repository
@sagemaker-bot
sagemaker-bot
commented
May 26, 2020

Copy link


Copy Markdown

Collaborator
AWS CodeBuild CI Report
  • Result: SUCCEEDED
  • Build Logs (available for 30 days)
Powered by github-codebuild-logs, available on the AWS Serverless Application Repository
@sagemaker-bot
sagemaker-bot
commented
May 26, 2020

Copy link


Copy Markdown

Collaborator
AWS CodeBuild CI Report
  • Result: SUCCEEDED
  • Build Logs (available for 30 days)
Powered by github-codebuild-logs, available on the AWS Serverless Application Repository
@laurenyu
laurenyu
merged commit 8ebbb71
into
aws:masterMay 26, 2020
@laurenyu
laurenyu
deleted the

tf-req

branch
May 26, 2020 17:02
pintaoz-aws pushed a commit
that referenced
this pull request
Dec 4, 2024
@schinmayee@pintaoz-aws
Feature: Support Neuron training recipes. (#1526)
13e10c9
pintaoz-aws pushed a commit
that referenced
this pull request
Dec 4, 2024
@schinmayee@pintaoz-aws
Usage docs for training recipes (#1630)
3bce287
* Feature: Support GPU training recipes with Sagemaker Python SDK (#1516)
* v0 estimator for launching kandinksy training
* code cleanup
* option to over-ride git repos for kandinsky for testing purposes
* update dependencies
* update comment
* formatting fixes
* style fixes
* code cleanup
* Add warning messages for ingored arguments
* cleanup, address comments
* fix
* clone launcher repo only if necessary
* add a cleanup method to call after fit
* fix docstring
* fix warning
* cleanup update
* fix
* code style fix
* rename cleanup method for clarity
* missed change
* move cleanup to when object is destroyed
* add unit tests
* formatting fix
* removing tests which don't work as recipe repos are private
* removing tests which don't work as recipe repos are private
* resolve comments
* resolve comments
* Feature: Support Neuron training recipes. (#1526)
* Feature: Resolve recipes correctly before launching (#1529)
* fix to work with launcher recipes
* fix suffix for temp file
* fix path and error message
* fix for recipes from launcher
* resolve recipes correctly
* fix imports
* reformat message to avoid code-doc test issue
* code style fix
* code style fix
* code style fix
* code style fix
* code style fix
* code style fix
* code style fix
* code style fix
* code style fix
* doc formatting
* check if resolver exists before registering
* Feature: Add unit tests for recipes and minor bug fixes. (#1532)
* basic checks and unit test for recipes
* More testing for recipes. Move recipe overrides to top before accessing any recipe fields.
* check that we use customer provided image uri if it is set
* reformat
* test fixes
* update git urls for recipes
* revert to ssh git urls for recipes
* Feature: Move image uris and git repos for training recipes to json (#1547)
* Update MANIFEST.in so that wheel builds correctly (#1563)
* Remove default values for fields in recipe_overrides and fix recipe path. (#1566)
* add optional source dir for recipes, copy training code and requirements to source dir
* diff names for recipe file and local script option
* format and add unit test
* make entry point script and recipe file temp files that can be gced
* formatting and fix
* test fix
* test fixes
* format fix
* break function up because it is too long
* fixes
* fix
* fix
* remove references to launcher and adapter dir as we copy out everything needed into source dir
* reformat
* copy all directory contents for trainium as there is more than one source file
* fix
* fix
* remove debugging message
* Change default source directory to current, add option to specify source dir (#1593)
* update to public uris for hyperpod recipe repos and smp image
* fixes
* remove debug copies
* change caps for env vars
* skip some tests for now
* format
* neuron json for retrieving images
* update training_recipes.json
* add unit test
* reformat
* fix long line
* add source dir check when using training recipe
* adding more regions
* reformat
* doc update
* doc update
* doc update
* doc update
* fix capitalization issues
* fix capitalization issues
* doc check issue
pintaoz-aws pushed a commit
that referenced
this pull request
Dec 4, 2024
@schinmayee@pintaoz-aws
Feature: Support Neuron training recipes. (#1526)
560052f
pintaoz-aws pushed a commit
that referenced
this pull request
Dec 4, 2024
@schinmayee@pintaoz-aws
Usage docs for training recipes (#1630)
efc9aa8
* Feature: Support GPU training recipes with Sagemaker Python SDK (#1516)
* v0 estimator for launching kandinksy training
* code cleanup
* option to over-ride git repos for kandinsky for testing purposes
* update dependencies
* update comment
* formatting fixes
* style fixes
* code cleanup
* Add warning messages for ingored arguments
* cleanup, address comments
* fix
* clone launcher repo only if necessary
* add a cleanup method to call after fit
* fix docstring
* fix warning
* cleanup update
* fix
* code style fix
* rename cleanup method for clarity
* missed change
* move cleanup to when object is destroyed
* add unit tests
* formatting fix
* removing tests which don't work as recipe repos are private
* removing tests which don't work as recipe repos are private
* resolve comments
* resolve comments
* Feature: Support Neuron training recipes. (#1526)
* Feature: Resolve recipes correctly before launching (#1529)
* fix to work with launcher recipes
* fix suffix for temp file
* fix path and error message
* fix for recipes from launcher
* resolve recipes correctly
* fix imports
* reformat message to avoid code-doc test issue
* code style fix
* code style fix
* code style fix
* code style fix
* code style fix
* code style fix
* code style fix
* code style fix
* code style fix
* doc formatting
* check if resolver exists before registering
* Feature: Add unit tests for recipes and minor bug fixes. (#1532)
* basic checks and unit test for recipes
* More testing for recipes. Move recipe overrides to top before accessing any recipe fields.
* check that we use customer provided image uri if it is set
* reformat
* test fixes
* update git urls for recipes
* revert to ssh git urls for recipes
* Feature: Move image uris and git repos for training recipes to json (#1547)
* Update MANIFEST.in so that wheel builds correctly (#1563)
* Remove default values for fields in recipe_overrides and fix recipe path. (#1566)
* add optional source dir for recipes, copy training code and requirements to source dir
* diff names for recipe file and local script option
* format and add unit test
* make entry point script and recipe file temp files that can be gced
* formatting and fix
* test fix
* test fixes
* format fix
* break function up because it is too long
* fixes
* fix
* fix
* remove references to launcher and adapter dir as we copy out everything needed into source dir
* reformat
* copy all directory contents for trainium as there is more than one source file
* fix
* fix
* remove debugging message
* Change default source directory to current, add option to specify source dir (#1593)
* update to public uris for hyperpod recipe repos and smp image
* fixes
* remove debug copies
* change caps for env vars
* skip some tests for now
* format
* neuron json for retrieving images
* update training_recipes.json
* add unit test
* reformat
* fix long line
* add source dir check when using training recipe
* adding more regions
* reformat
* doc update
* doc update
* doc update
* doc update
* fix capitalization issues
* fix capitalization issues
* doc check issue
Evan-W-ang added a commit
to Evan-W-ang/sagemaker-python-sdk
that referenced
this pull request
Jun 8, 2026
@Evan-W-ang
doc: fix TF requirements.txt documentation (aws#1526)
05d0c8f
Evan-W-ang added a commit
to Evan-W-ang/sagemaker-python-sdk
that referenced
this pull request
Jun 8, 2026
@Evan-W-ang
Feature: Support Neuron training recipes. (aws#1526)
4886606
Evan-W-ang added a commit
to Evan-W-ang/sagemaker-python-sdk
that referenced
this pull request
Jun 8, 2026
@Evan-W-ang
Usage docs for training recipes (aws#1630)
6a64501
* Feature: Support GPU training recipes with Sagemaker Python SDK (aws#1516)
* v0 estimator for launching kandinksy training
* code cleanup
* option to over-ride git repos for kandinsky for testing purposes
* update dependencies
* update comment
* formatting fixes
* style fixes
* code cleanup
* Add warning messages for ingored arguments
* cleanup, address comments
* fix
* clone launcher repo only if necessary
* add a cleanup method to call after fit
* fix docstring
* fix warning
* cleanup update
* fix
* code style fix
* rename cleanup method for clarity
* missed change
* move cleanup to when object is destroyed
* add unit tests
* formatting fix
* removing tests which don't work as recipe repos are private
* removing tests which don't work as recipe repos are private
* resolve comments
* resolve comments
* Feature: Support Neuron training recipes. (aws#1526)
* Feature: Resolve recipes correctly before launching (aws#1529)
* fix to work with launcher recipes
* fix suffix for temp file
* fix path and error message
* fix for recipes from launcher
* resolve recipes correctly
* fix imports
* reformat message to avoid code-doc test issue
* code style fix
* code style fix
* code style fix
* code style fix
* code style fix
* code style fix
* code style fix
* code style fix
* code style fix
* doc formatting
* check if resolver exists before registering
* Feature: Add unit tests for recipes and minor bug fixes. (aws#1532)
* basic checks and unit test for recipes
* More testing for recipes. Move recipe overrides to top before accessing any recipe fields.
* check that we use customer provided image uri if it is set
* reformat
* test fixes
* update git urls for recipes
* revert to ssh git urls for recipes
* Feature: Move image uris and git repos for training recipes to json (aws#1547)
* Update MANIFEST.in so that wheel builds correctly (aws#1563)
* Remove default values for fields in recipe_overrides and fix recipe path. (aws#1566)
* add optional source dir for recipes, copy training code and requirements to source dir
* diff names for recipe file and local script option
* format and add unit test
* make entry point script and recipe file temp files that can be gced
* formatting and fix
* test fix
* test fixes
* format fix
* break function up because it is too long
* fixes
* fix
* fix
* remove references to launcher and adapter dir as we copy out everything needed into source dir
* reformat
* copy all directory contents for trainium as there is more than one source file
* fix
* fix
* remove debugging message
* Change default source directory to current, add option to specify source dir (aws#1593)
* update to public uris for hyperpod recipe repos and smp image
* fixes
* remove debug copies
* change caps for env vars
* skip some tests for now
* format
* neuron json for retrieving images
* update training_recipes.json
* add unit test
* reformat
* fix long line
* add source dir check when using training recipe
* adding more regions
* reformat
* doc update
* doc update
* doc update
* doc update
* fix capitalization issues
* fix capitalization issues
* doc check issue
Sign up for freeto join this conversation on GitHub.
Already have an account?
Sign in to comment

Reviewers


1 more reviewer

@ajaykarpurajaykarpurajaykarpur approved these changes
Reviewers whose approvals may not affect merge requirements

Assignees


No one assigned


Labels


None yet


Projects


None yet


Milestone


No milestone


Development

Successfully merging this pull request may close these issues.

3 participants

@laurenyu@sagemaker-bot@ajaykarpur

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode");
}
} catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); }
})();
})();

Skip to content
doc: fix TF requirements.txt documentation - #1526
Merged
laurenyu merged 1 commit into
aws:masterfrom 
laurenyu:tf-req
May 26, 2020
Merged
doc: fix TF requirements.txt documentation#1526
laurenyu merged 1 commit into
aws:masterfrom 
laurenyu:tf-req
Conversation
@laurenyu
@laurenyulaurenyu
commented
May 26, 2020

Copy link


Copy Markdown

Contributor
Issue #, if available:
Description of changes:

follow-up to #1512 - TF script mode support for requirements.txt for versions before TF 1.15.2 with Python 3.7 and TF 2.2 was a bit of a fluke rather than intended behavior, as indicated by #839. However, it doesn't work consistently, which I verified by trying it out with the TF 1.14 image. This PR is to change the documentation to go with what we "officially recommended" at the time, which was the shell script workaround.
Testing done:

here's what I did to make sure that the shell script workaround works for TF 1.14:
$ cat src/entry.sh
python -m pip install -r requirements.txt
python hello.py
$ cat src/requirements.txt
pyfiglet
$ cat src/hello.py
from pyfiglet import Figlet
print(Figlet().renderText('hello').strip())
$ cat run.py
from sagemaker.tensorflow import TensorFlow
tf = TensorFlow(
entry_point='entry.sh',
source_dir='src',
framework_version='1.14',
py_version='py3',
role='SageMakerRole',
train_instance_type='local',
train_instance_count=1,
)
tf.fit()
$ python run.py

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 any/all 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.
@laurenyu
laurenyu
requested a review
from ajaykarpurMay 26, 2020 16:48
@sagemaker-bot
sagemaker-bot
commented
May 26, 2020

Copy link


Copy Markdown

Collaborator
AWS CodeBuild CI Report
  • Result: SUCCEEDED
  • Build Logs (available for 30 days)
Powered by github-codebuild-logs, available on the AWS Serverless Application Repository
@sagemaker-bot
sagemaker-bot
commented
May 26, 2020

Copy link


Copy Markdown

Collaborator
AWS CodeBuild CI Report
  • Result: SUCCEEDED
  • Build Logs (available for 30 days)
Powered by github-codebuild-logs, available on the AWS Serverless Application Repository
@sagemaker-bot
sagemaker-bot
commented
May 26, 2020

Copy link


Copy Markdown

Collaborator
AWS CodeBuild CI Report
  • Result: SUCCEEDED
  • Build Logs (available for 30 days)
Powered by github-codebuild-logs, available on the AWS Serverless Application Repository
@sagemaker-bot
sagemaker-bot
commented
May 26, 2020

Copy link


Copy Markdown

Collaborator
AWS CodeBuild CI Report
  • Result: SUCCEEDED
  • Build Logs (available for 30 days)
Powered by github-codebuild-logs, available on the AWS Serverless Application Repository
@laurenyu
laurenyu
merged commit 8ebbb71
into
aws:masterMay 26, 2020
@laurenyu
laurenyu
deleted the

tf-req

branch
May 26, 2020 17:02
pintaoz-aws pushed a commit
that referenced
this pull request
Dec 4, 2024
@schinmayee@pintaoz-aws
Feature: Support Neuron training recipes. (#1526)
13e10c9
pintaoz-aws pushed a commit
that referenced
this pull request
Dec 4, 2024
@schinmayee@pintaoz-aws
Usage docs for training recipes (#1630)
3bce287
* Feature: Support GPU training recipes with Sagemaker Python SDK (#1516)
* v0 estimator for launching kandinksy training
* code cleanup
* option to over-ride git repos for kandinsky for testing purposes
* update dependencies
* update comment
* formatting fixes
* style fixes
* code cleanup
* Add warning messages for ingored arguments
* cleanup, address comments
* fix
* clone launcher repo only if necessary
* add a cleanup method to call after fit
* fix docstring
* fix warning
* cleanup update
* fix
* code style fix
* rename cleanup method for clarity
* missed change
* move cleanup to when object is destroyed
* add unit tests
* formatting fix
* removing tests which don't work as recipe repos are private
* removing tests which don't work as recipe repos are private
* resolve comments
* resolve comments
* Feature: Support Neuron training recipes. (#1526)
* Feature: Resolve recipes correctly before launching (#1529)
* fix to work with launcher recipes
* fix suffix for temp file
* fix path and error message
* fix for recipes from launcher
* resolve recipes correctly
* fix imports
* reformat message to avoid code-doc test issue
* code style fix
* code style fix
* code style fix
* code style fix
* code style fix
* code style fix
* code style fix
* code style fix
* code style fix
* doc formatting
* check if resolver exists before registering
* Feature: Add unit tests for recipes and minor bug fixes. (#1532)
* basic checks and unit test for recipes
* More testing for recipes. Move recipe overrides to top before accessing any recipe fields.
* check that we use customer provided image uri if it is set
* reformat
* test fixes
* update git urls for recipes
* revert to ssh git urls for recipes
* Feature: Move image uris and git repos for training recipes to json (#1547)
* Update MANIFEST.in so that wheel builds correctly (#1563)
* Remove default values for fields in recipe_overrides and fix recipe path. (#1566)
* add optional source dir for recipes, copy training code and requirements to source dir
* diff names for recipe file and local script option
* format and add unit test
* make entry point script and recipe file temp files that can be gced
* formatting and fix
* test fix
* test fixes
* format fix
* break function up because it is too long
* fixes
* fix
* fix
* remove references to launcher and adapter dir as we copy out everything needed into source dir
* reformat
* copy all directory contents for trainium as there is more than one source file
* fix
* fix
* remove debugging message
* Change default source directory to current, add option to specify source dir (#1593)
* update to public uris for hyperpod recipe repos and smp image
* fixes
* remove debug copies
* change caps for env vars
* skip some tests for now
* format
* neuron json for retrieving images
* update training_recipes.json
* add unit test
* reformat
* fix long line
* add source dir check when using training recipe
* adding more regions
* reformat
* doc update
* doc update
* doc update
* doc update
* fix capitalization issues
* fix capitalization issues
* doc check issue
pintaoz-aws pushed a commit
that referenced
this pull request
Dec 4, 2024
@schinmayee@pintaoz-aws
Feature: Support Neuron training recipes. (#1526)
560052f
pintaoz-aws pushed a commit
that referenced
this pull request
Dec 4, 2024
@schinmayee@pintaoz-aws
Usage docs for training recipes (#1630)
efc9aa8
* Feature: Support GPU training recipes with Sagemaker Python SDK (#1516)
* v0 estimator for launching kandinksy training
* code cleanup
* option to over-ride git repos for kandinsky for testing purposes
* update dependencies
* update comment
* formatting fixes
* style fixes
* code cleanup
* Add warning messages for ingored arguments
* cleanup, address comments
* fix
* clone launcher repo only if necessary
* add a cleanup method to call after fit
* fix docstring
* fix warning
* cleanup update
* fix
* code style fix
* rename cleanup method for clarity
* missed change
* move cleanup to when object is destroyed
* add unit tests
* formatting fix
* removing tests which don't work as recipe repos are private
* removing tests which don't work as recipe repos are private
* resolve comments
* resolve comments
* Feature: Support Neuron training recipes. (#1526)
* Feature: Resolve recipes correctly before launching (#1529)
* fix to work with launcher recipes
* fix suffix for temp file
* fix path and error message
* fix for recipes from launcher
* resolve recipes correctly
* fix imports
* reformat message to avoid code-doc test issue
* code style fix
* code style fix
* code style fix
* code style fix
* code style fix
* code style fix
* code style fix
* code style fix
* code style fix
* doc formatting
* check if resolver exists before registering
* Feature: Add unit tests for recipes and minor bug fixes. (#1532)
* basic checks and unit test for recipes
* More testing for recipes. Move recipe overrides to top before accessing any recipe fields.
* check that we use customer provided image uri if it is set
* reformat
* test fixes
* update git urls for recipes
* revert to ssh git urls for recipes
* Feature: Move image uris and git repos for training recipes to json (#1547)
* Update MANIFEST.in so that wheel builds correctly (#1563)
* Remove default values for fields in recipe_overrides and fix recipe path. (#1566)
* add optional source dir for recipes, copy training code and requirements to source dir
* diff names for recipe file and local script option
* format and add unit test
* make entry point script and recipe file temp files that can be gced
* formatting and fix
* test fix
* test fixes
* format fix
* break function up because it is too long
* fixes
* fix
* fix
* remove references to launcher and adapter dir as we copy out everything needed into source dir
* reformat
* copy all directory contents for trainium as there is more than one source file
* fix
* fix
* remove debugging message
* Change default source directory to current, add option to specify source dir (#1593)
* update to public uris for hyperpod recipe repos and smp image
* fixes
* remove debug copies
* change caps for env vars
* skip some tests for now
* format
* neuron json for retrieving images
* update training_recipes.json
* add unit test
* reformat
* fix long line
* add source dir check when using training recipe
* adding more regions
* reformat
* doc update
* doc update
* doc update
* doc update
* fix capitalization issues
* fix capitalization issues
* doc check issue
Evan-W-ang added a commit
to Evan-W-ang/sagemaker-python-sdk
that referenced
this pull request
Jun 8, 2026
@Evan-W-ang
doc: fix TF requirements.txt documentation (aws#1526)
05d0c8f
Evan-W-ang added a commit
to Evan-W-ang/sagemaker-python-sdk
that referenced
this pull request
Jun 8, 2026
@Evan-W-ang
Feature: Support Neuron training recipes. (aws#1526)
4886606
Evan-W-ang added a commit
to Evan-W-ang/sagemaker-python-sdk
that referenced
this pull request
Jun 8, 2026
@Evan-W-ang
Usage docs for training recipes (aws#1630)
6a64501
* Feature: Support GPU training recipes with Sagemaker Python SDK (aws#1516)
* v0 estimator for launching kandinksy training
* code cleanup
* option to over-ride git repos for kandinsky for testing purposes
* update dependencies
* update comment
* formatting fixes
* style fixes
* code cleanup
* Add warning messages for ingored arguments
* cleanup, address comments
* fix
* clone launcher repo only if necessary
* add a cleanup method to call after fit
* fix docstring
* fix warning
* cleanup update
* fix
* code style fix
* rename cleanup method for clarity
* missed change
* move cleanup to when object is destroyed
* add unit tests
* formatting fix
* removing tests which don't work as recipe repos are private
* removing tests which don't work as recipe repos are private
* resolve comments
* resolve comments
* Feature: Support Neuron training recipes. (aws#1526)
* Feature: Resolve recipes correctly before launching (aws#1529)
* fix to work with launcher recipes
* fix suffix for temp file
* fix path and error message
* fix for recipes from launcher
* resolve recipes correctly
* fix imports
* reformat message to avoid code-doc test issue
* code style fix
* code style fix
* code style fix
* code style fix
* code style fix
* code style fix
* code style fix
* code style fix
* code style fix
* doc formatting
* check if resolver exists before registering
* Feature: Add unit tests for recipes and minor bug fixes. (aws#1532)
* basic checks and unit test for recipes
* More testing for recipes. Move recipe overrides to top before accessing any recipe fields.
* check that we use customer provided image uri if it is set
* reformat
* test fixes
* update git urls for recipes
* revert to ssh git urls for recipes
* Feature: Move image uris and git repos for training recipes to json (aws#1547)
* Update MANIFEST.in so that wheel builds correctly (aws#1563)
* Remove default values for fields in recipe_overrides and fix recipe path. (aws#1566)
* add optional source dir for recipes, copy training code and requirements to source dir
* diff names for recipe file and local script option
* format and add unit test
* make entry point script and recipe file temp files that can be gced
* formatting and fix
* test fix
* test fixes
* format fix
* break function up because it is too long
* fixes
* fix
* fix
* remove references to launcher and adapter dir as we copy out everything needed into source dir
* reformat
* copy all directory contents for trainium as there is more than one source file
* fix
* fix
* remove debugging message
* Change default source directory to current, add option to specify source dir (aws#1593)
* update to public uris for hyperpod recipe repos and smp image
* fixes
* remove debug copies
* change caps for env vars
* skip some tests for now
* format
* neuron json for retrieving images
* update training_recipes.json
* add unit test
* reformat
* fix long line
* add source dir check when using training recipe
* adding more regions
* reformat
* doc update
* doc update
* doc update
* doc update
* fix capitalization issues
* fix capitalization issues
* doc check issue
Sign up for freeto join this conversation on GitHub.
Already have an account?
Sign in to comment

Reviewers


1 more reviewer

@ajaykarpurajaykarpurajaykarpur approved these changes
Reviewers whose approvals may not affect merge requirements

Assignees


No one assigned


Labels


None yet


Projects


None yet


Milestone


No milestone


Development

Successfully merging this pull request may close these issues.

3 participants

@laurenyu@sagemaker-bot@ajaykarpur