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 20, 2022
1 parent 42b4243 commit 2353db0
Showing 1 changed file with 12 additions and 2 deletions.
14 changes: 12 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ create isolated Python environment is recommended for this project.

2. Set up ML Conversational Analytic Tool in a virtualenv
```python
python3 -m venv virtualenv-ml-conversational
python -m venv virtualenv-ml-conversational
```

3. Activate the virtualenv
Expand All @@ -70,6 +70,17 @@ create isolated Python environment is recommended for this project.
```python
pip install -r requirements.txt
```
#### Testing
6. Run all unit tests
```python
cd ml-conversational-analytic-tool
python -m unittest discover -s tests
```
7. Run an individual unit test
```python
cd ml-conversational-analytic-tool
python -m unittest tests/<file_name>
```

The libraries used within the project are available in the [requirements.txt](./requirements.txt).

Expand Down Expand Up @@ -160,7 +171,6 @@ 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!

## Documentation

Auto-generated API documentation can be found in
Expand Down

0 comments on commit 2353db0

Please sign in to comment.