Skip to content

Commit 21b326e

Browse files
author
Andre Moeller
committed
Improve new dev experience in README
1 parent dc70fd6 commit 21b326e

File tree

2 files changed

+13
-7
lines changed

2 files changed

+13
-7
lines changed

CHANGELOG.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@ CHANGELOG
1313
* doc-fix: remove duplicate content from mxnet/README.rst
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``
16+
* doc-fix: Improve new developer experience in README
1617

1718
1.18.3.post1
1819
============

README.rst

Lines changed: 12 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -97,9 +97,13 @@ 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+
To run the unit tests, you'll need to have interpreters for Python 2.7 and Python 3.5 installed.
105+
106+
To run the unit tests with tox, run:
103107

104108
::
105109

@@ -112,20 +116,21 @@ To run the integration tests, the following prerequisites must be met
112116
1. Access to an AWS account to run the tests on
113117
2. AWS account credentials available to boto3 clients used in the tests
114118
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]`
117119

118-
You can run integ tests by issuing the following command:
120+
We recommend selectively running just those integration tests you'd like to run. You can filter by individual test function names with:
119121

120122
::
121123

122-
pytest tests/integ
124+
pytest -k 'test_i_care_about'
125+
123126

124-
You can also filter by individual test function names (usable with any of the previous commands):
127+
You can also run all of the integration tests by running the following command, but they run sequentially, so they'll take a long time to finish:
125128

126129
::
127130

128-
pytest -k 'test_i_care_about'
131+
pytest tests/integ
132+
133+
129134

130135
Building Sphinx docs
131136
~~~~~~~~~~~~~~~~~~~~

0 commit comments

Comments
 (0)