Skip to content

Commit a815279

Browse files
andremoellerjesterhazy
authored andcommitted
Improve new dev experience in README (aws#674)
* Improve new dev experience in README * Update README.rst
1 parent c2d9cc8 commit a815279

File tree

2 files changed

+23
-9
lines changed

2 files changed

+23
-9
lines changed

CHANGELOG.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@ CHANGELOG
1414
* doc-fix: move overview content in main README into sphynx project
1515
* bug-fix: pass accelerator_type in ``deploy`` for REST API TFS ``Model``
1616
* doc-fix: move content from tf/README.rst into sphynx project
17+
* doc-fix: Improve new developer experience in README
1718

1819
1.18.3.post1
1920
============

README.rst

Lines changed: 22 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -97,9 +97,16 @@ Running tests
9797

9898
SageMaker Python SDK has unit tests and integration tests.
9999

100+
You can install the libraries needed to run the tests by running :code:`pip install --upgrade .[test]` or, for Zsh users: :code:`pip install --upgrade .\[test\]`
101+
100102
**Unit tests**
101103

102-
tox is a prerequisite for running unit tests so you need to make sure you have it installed. To run the unit tests:
104+
105+
We run unit tests with tox, which is a program that lets you run unit tests for multiple Python versions, and also make sure the
106+
code fits our style guidelines. We run tox with Python 2.7 and 3.6, so to run unit tests
107+
with the same configuration we do, you'll need to have interpreters for Python 2.7 and Python 3.6 installed.
108+
109+
To run the unit tests with tox, run:
103110

104111
::
105112

@@ -109,23 +116,29 @@ tox is a prerequisite for running unit tests so you need to make sure you have i
109116

110117
To run the integration tests, the following prerequisites must be met
111118

112-
1. Access to an AWS account to run the tests on
113-
2. AWS account credentials available to boto3 clients used in the tests
114-
3. The AWS account has an IAM role named :code:`SageMakerRole`
115-
4. The libraries listed in the ``extras_require`` object in ``setup.py`` for ``test`` are installed.
116-
You can do this by running the following command: :code:`pip install --upgrade .[test]`
119+
1. AWS account credentials are available in the environment for the boto3 client to use.
120+
2. The AWS account has an IAM role named :code:`SageMakerRole` with the AmazonSageMakerFullAccess policy attached.
121+
122+
We recommend selectively running just those integration tests you'd like to run. You can filter by individual test function names with:
123+
124+
::
125+
126+
pytest -k 'test_i_care_about'
127+
117128

118-
You can run integ tests by issuing the following command:
129+
You can also run all of the integration tests by running the following command, which runs them in sequence, which may take a while:
119130

120131
::
121132

122133
pytest tests/integ
123134

124-
You can also filter by individual test function names (usable with any of the previous commands):
135+
136+
You can also run them in parallel:
125137

126138
::
127139

128-
pytest -k 'test_i_care_about'
140+
pytest -n auto tests/integ
141+
129142

130143
Building Sphinx docs
131144
~~~~~~~~~~~~~~~~~~~~

0 commit comments

Comments
 (0)