Skip to content

Commit 74e14de

Browse files
humanzzlaurenyu
authored andcommitted
Update README running tests section (#246)
Clarify what's needed to run unit and integration tests
1 parent 8812053 commit 74e14de

File tree

1 file changed

+13
-6
lines changed

1 file changed

+13
-6
lines changed

README.rst

Lines changed: 13 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -64,19 +64,26 @@ http://aws.amazon.com/apache2.0/
6464
Running tests
6565
~~~~~~~~~~~~~
6666

67-
SageMaker Python SDK uses tox for running Python tests. You can run the tests by running tox:
67+
SageMaker Python SDK has unit tests and integration tests.
6868

69-
::
70-
71-
tox
69+
**Unit tests**
7270

73-
Tests are defined in ``tests/`` and includes unit and integ tests. If you just want to run unit tests, then you can issue:
71+
tox is a prerequisite for running unit tests so you need to make sure you have it installed. To run the unit tests:
7472

7573
::
7674

7775
tox tests/unit
7876

79-
To just run integ tests, issue the following command:
77+
**Integrations tests**
78+
79+
To be able to run the integration tests, the following prerequisites must be met
80+
81+
1. Access to an AWS account to run the tests on
82+
2. Make the AWS account credentials available to boto3 clients used in the tests
83+
3. Ensure the AWS account has an IAM role named :code:`SageMakerRole`
84+
4. Ensure the libraries mentioned in setup.py extra_require for test are installed which can be achieved using :code:`pip install --upgrade .[test]`
85+
86+
You can run integ tests by issuing the following command:
8087

8188
::
8289

0 commit comments

Comments
 (0)