Skip to content
This repository has been archived by the owner on Feb 20, 2023. It is now read-only.

Commit

Permalink
Add documentation to run unit tests
Browse files Browse the repository at this point in the history
update the README.md with the commands to run unit tests
  • Loading branch information
pramodrj07 committed Jan 14, 2022
1 parent 912a42c commit 502e2a3
Showing 1 changed file with 20 additions and 4 deletions.
24 changes: 20 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,10 +24,11 @@ inclusive pull requests to foster a healthier open source community.
- [Extract Raw Data from GitHub](#extract-raw-data-from-github)
- [Annotate](#annotate)
3. [Train models](#train-models)
4. [Documentation](#documentation)
5. [Blog Posts](#blog-posts)
6. [Contributing](#contributing)
7. [License](#license)
4. [Running tests](#running-tests)
5. [Documentation](#documentation)
6. [Blog Posts](#blog-posts)
7. [Contributing](#contributing)
8. [License](#license)

## Build and Run

Expand Down Expand Up @@ -148,6 +149,21 @@ Both `BaseCNN` and `BaseLSTM` also have prediction explanation mechanisms that c
If you have ideas on how to improve the framework to assess text conversation for constructive and inclusive
communication, we welcome your contributions!

## Running tests
### Run tests with a virtual environment
```python
python3 -m venv virtualenv-ml-conversational
```
### Running all the test unit tests
```python
cd ml-conversational-analytic-tool
python -m unittest discover -s tests
```
### Running individual unit tests
```python
cd ml-conversational-analytic-tool
python -m unittest tests/<file_name>
```
## Documentation

Auto-generated API documentation can be found in
Expand Down

0 comments on commit 502e2a3

Please sign in to comment.