You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: .github/PULL_REQUEST_TEMPLATE.md
+21-45Lines changed: 21 additions & 45 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -7,13 +7,13 @@
7
7
8
8
### Description
9
9
10
-
### Tests run
11
-
12
-
**NOTE: By default, docker builds are disabled. In order to build your container, please update dlc_developer_config.toml and specify the framework to build in "build_frameworks"**
13
-
-[ ] I have run builds/tests on commit <INSERTCOMMITID> for my changes.
10
+
### Tests Run
11
+
By default, docker image builds and tests are disabled. Two ways to run builds and tests:
12
+
1. Using dlc_developer_config.toml
13
+
2. Using this PR description (currently only supported for PyTorch, TensorFlow, vllm, and base images)
14
14
15
15
<details>
16
-
<summary>Confused on how to run tests? Try using the helper utility...</summary>
16
+
<summary>How to use the helper utility for updating dlc_developer_config.toml</summary>
17
17
18
18
Assuming your remote is called `origin` (you can find out more with `git remote -v`)...
19
19
@@ -28,50 +28,34 @@ Assuming your remote is called `origin` (you can find out more with `git remote
**NOTE: If you are creating a PR for a new framework version, please ensure success of the standard, rc, and efa sagemaker remote tests by updating the dlc_developer_config.toml file:**
34
-
<details>
35
-
<summary>Expand</summary>
36
31
32
+
**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:**
37
33
-[ ]`sagemaker_remote_tests = true`
38
34
-[ ]`sagemaker_efa_tests = true`
39
35
-[ ]`sagemaker_rc_tests = true`
40
-
41
-
**Additionally, please run the sagemaker local tests in at least one revision:**
42
36
-[ ]`sagemaker_local_tests = true`
43
-
44
37
</details>
45
38
46
-
### Formatting
47
-
-[ ] I have run `black -l 100` on my code (formatting tool: https://black.readthedocs.io/en/stable/getting_started.html)
48
-
49
-
### DLC image/dockerfile
50
-
51
-
#### Builds to Execute
52
39
<details>
53
-
<summary>Expand</summary>
54
-
55
-
Fill out the template and click the checkbox of the builds you'd like to execute
56
-
57
-
*Note: Replace with <X.Y> with the major.minor framework version (i.e. 2.2) you would like to start.*
58
-
59
-
-[ ] build_pytorch_training_<X.Y>_sm
60
-
-[ ] build_pytorch_training_<X.Y>_ec2
61
-
62
-
-[ ] build_pytorch_inference_<X.Y>_sm
63
-
-[ ] build_pytorch_inference_<X.Y>_ec2
64
-
-[ ] build_pytorch_inference_<X.Y>_graviton
40
+
<summary>How to use PR description</summary>
41
+
Use the code block below to uncomment commands and run the PR CodeBuild jobs. There are two commands available:
- If this line is commented out, dlc_developer_config.toml will be used.
46
+
-`# /tests <test_list>`
47
+
- e.g.: `# /tests sanity security ec2`
48
+
- 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`.
68
49
69
-
-[ ] build_tensorflow_inference_<X.Y>_sm
70
-
-[ ] build_tensorflow_inference_<X.Y>_ec2
71
-
-[ ] build_tensorflow_inference_<X.Y>_graviton
72
50
</details>
73
51
74
-
### Additional context
52
+
```
53
+
# /buildspec <buildspec_path>
54
+
# /tests <test_list>
55
+
```
56
+
57
+
### Formatting
58
+
-[ ] I have run `black -l 100` on my code (formatting tool: https://black.readthedocs.io/en/stable/getting_started.html)
75
59
76
60
### PR Checklist
77
61
<details>
@@ -84,14 +68,6 @@ Fill out the template and click the checkbox of the builds you'd like to execute
84
68
-[ ] (If applicable) I've documented below the tests I've run on the DLC image
85
69
-[ ] (If applicable) I've reviewed the licenses of updated and new binaries and their dependencies to make sure all licenses are on the Apache Software Foundation Third Party License Policy Category A or Category B license list. See [https://www.apache.org/legal/resolved.html](https://www.apache.org/legal/resolved.html).
86
70
-[ ] (If applicable) I've scanned the updated and new binaries to make sure they do not have vulnerabilities associated with them.
87
-
88
-
#### NEURON/GRAVITON Testing Checklist
89
-
* When creating a PR:
90
-
-[ ] I've modified `dlc_developer_config.toml` in my PR branch by setting `neuron_mode = true` or `graviton_mode = true`
91
-
92
-
#### Benchmark Testing Checklist
93
-
* When creating a PR:
94
-
-[ ] I've modified `dlc_developer_config.toml` in my PR branch by setting `ec2_benchmark_tests = true` or `sagemaker_benchmark_tests = true`
0 commit comments