From 5e558126d6f867fb38a33b15658215e729341852 Mon Sep 17 00:00:00 2001
From: Pramod Raghavendra Jayathirth <pramod.rj07@gmail.com>
Date: Mon, 10 Jan 2022 11:02:42 -0800
Subject: [PATCH] Add documentation to run unit tests

update the README.md with the commands to run unit tests
---
 README.md | 26 +++++++++++++++++++++-----
 1 file changed, 21 insertions(+), 5 deletions(-)

diff --git a/README.md b/README.md
index 07e1605..da52a4d 100644
--- a/README.md
+++ b/README.md
@@ -25,10 +25,11 @@ inclusive pull requests to foster a healthier open source community.
         - [Annotate](#annotate)
         - [Feature Vector Creation](#feature-vector-creation)
     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
 
@@ -53,7 +54,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
@@ -161,6 +162,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
+python -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