|
1 | | -## PR Checklist |
| 1 | +## Purpose |
2 | 2 |
|
3 | | -- [] I ran `pre-commit run --all-files` locally before creating this PR. (Read [DEVELOPMENT.md](https://github.com/aws/deep-learning-containers/blob/main/DEVELOPMENT.md) for details). |
| 3 | +## Test Plan |
| 4 | + |
| 5 | +## Test Result |
| 6 | + |
| 7 | +______________________________________________________________________ |
| 8 | + |
| 9 | +<details> |
| 10 | +<summary>Toggle if you are merging into master Branch</summary> |
| 11 | + |
| 12 | +By default, docker image builds and tests are disabled. Two ways to run builds and tests: |
| 13 | + |
| 14 | +1. Using dlc_developer_config.toml |
| 15 | +1. Using this PR description (currently only supported for PyTorch, TensorFlow, vllm, and base images) |
| 16 | + |
| 17 | +<details> |
| 18 | +<summary>How to use the helper utility for updating dlc_developer_config.toml</summary> |
| 19 | + |
| 20 | +Assuming your remote is called `origin` (you can find out more with `git remote -v`)... |
| 21 | + |
| 22 | +- Run default builds and tests for a particular buildspec - also commits and pushes changes to remote; Example: |
| 23 | + |
| 24 | +`python src/prepare_dlc_dev_environment.py -b </path/to/buildspec.yml> -cp origin` |
| 25 | + |
| 26 | +- Enable specific tests for a buildspec or set of buildspecs - also commits and pushes changes to remote; Example: |
| 27 | + |
| 28 | +`python src/prepare_dlc_dev_environment.py -b </path/to/buildspec.yml> -t sanity_tests -cp origin` |
4 | 29 |
|
5 | | -## Description |
| 30 | +- Restore TOML file when ready to merge |
6 | 31 |
|
7 | | -<!-- Briefly describe the changes in this PR --> |
| 32 | +`python src/prepare_dlc_dev_environment.py -rcp origin` |
8 | 33 |
|
9 | | -## Changes Made |
| 34 | +**NOTE: If you are creating a PR for a new framework version, please ensure success of the local, standard, rc, and efa sagemaker tests by updating the dlc_developer_config.toml file:** |
| 35 | + |
| 36 | +- [ ] `sagemaker_remote_tests = true` |
| 37 | +- [ ] `sagemaker_efa_tests = true` |
| 38 | +- [ ] `sagemaker_rc_tests = true` |
| 39 | +- [ ] `sagemaker_local_tests = true` |
| 40 | + |
| 41 | +</details> |
| 42 | + |
| 43 | +<details> |
| 44 | +<summary>How to use PR description</summary> |
| 45 | +Use the code block below to uncomment commands and run the PR CodeBuild jobs. There are two commands available: |
| 46 | + |
| 47 | +- `# /buildspec <buildspec_path>` |
| 48 | + - e.g.: `# /buildspec pytorch/training/buildspec.yml` |
| 49 | + - If this line is commented out, dlc_developer_config.toml will be used. |
| 50 | +- `# /tests <test_list>` |
| 51 | + - e.g.: `# /tests sanity security ec2` |
| 52 | + - If this line is commented out, it will run the default set of tests (same as the defaults in dlc_developer_config.toml): `sanity, security, ec2, ecs, eks, sagemaker, sagemaker-local`. |
| 53 | + |
| 54 | +</details> |
| 55 | + |
| 56 | +``` |
| 57 | +/buildspec vllm/buildspec.yml |
| 58 | +# /tests <test_list> |
| 59 | +``` |
| 60 | + |
| 61 | +</details> |
| 62 | + |
| 63 | +<details> |
| 64 | +<summary>Toggle if you are merging into main Branch</summary> |
| 65 | + |
| 66 | +## PR Checklist |
| 67 | + |
| 68 | +- [] I ran `pre-commit run --all-files` locally before creating this PR. (Read [DEVELOPMENT.md](https://github.com/aws/deep-learning-containers/blob/main/DEVELOPMENT.md) for details). |
10 | 69 |
|
11 | | -## Testing Done |
| 70 | +</details> |
0 commit comments