Skip to content

Update README running tests section #246

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Jun 21, 2018
Merged

Update README running tests section #246

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
759e863
Update README running tests section
humanzz Jun 21, 2018
4ef9251
Add details to README's test instructions
humanzz Jun 21, 2018
a077491
Merge branch 'master' into patch-1
laurenyu Jun 21, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 13 additions & 6 deletions README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,19 +64,26 @@ http://aws.amazon.com/apache2.0/
Running tests
~~~~~~~~~~~~~

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

::

tox
**Unit tests**

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

::

tox tests/unit

To just run integ tests, issue the following command:
**Integrations tests**

To be able to run the integration tests, the following prerequisites must be met

1. Access to an AWS account to run the tests on
2. Make the AWS account credentials available to boto3 clients used in the tests
3. Ensure the AWS account has an IAM role named :code:`SageMakerRole`
4. Ensure the libraries mentioned in setup.py extra_require for test are installed which can be achieved using :code:`pip install --upgrade .[test]`

You can run integ tests by issuing the following command:

::

Expand Down