Skip to content

Commit 0d1a3f8

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

File tree

2 files changed

+22
-9
lines changed

2 files changed

+22
-9
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: 21 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -97,9 +97,15 @@ 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. This will
105+
let you run 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.
107+
108+
To run the unit tests with tox, run:
103109

104110
::
105111

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

110116
To run the integration tests, the following prerequisites must be met
111117

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]`
118+
1. AWS account credentials are available in the environment for the boto3 client to use.
119+
2. The AWS account has an IAM role named :code:`SageMakerRole` with the AmazonSageMakerFullAccess policy attached.
117120

118-
You can run integ tests by issuing the following command:
121+
We recommend selectively running just those integration tests you'd like to run. You can filter by individual test function names with:
122+
123+
::
124+
125+
pytest -k 'test_i_care_about'
126+
127+
128+
You can also run all of the integration tests by running the following command, which runs them in sequence, which may take a while:
119129

120130
::
121131

122132
pytest tests/integ
123133

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

126137
::
127138

128-
pytest -k 'test_i_care_about'
139+
pytest -n auto tests/integ
140+
129141

130142
Building Sphinx docs
131143
~~~~~~~~~~~~~~~~~~~~

0 commit comments

Comments
 (0)