Skip to content

Commit

Permalink
update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
sthanhng committed Jan 11, 2019
1 parent 1a7e5a0 commit 423a916
Showing 1 changed file with 25 additions and 7 deletions.
32 changes: 25 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,18 +19,38 @@ OpenCV `dnn` module supports running inference on pre-trained deep learning mode

## Prerequisites

* tensorflow
* Tensorflow
* opencv-python
* opencv-contrib-python
* numpy
* Numpy
* Keras
* Matplotlib
* Pillow

Install the required packages by running the following command:
Development for this project will be isolated in Python virtual environment. This allows us to experiment with different versions of dependencies.

There are many ways to install `virtual environment (virtualenv)`, see the [Python Virtual Environments: A Primer](https://realpython.com/python-virtual-environments-a-primer/) guide for different platforms, but here are a couple:

- For Ubuntu
```bash
$ pip install -r requirements.txt
$ pip install virtualenv
```

- For Mac
```bash
$ pip install --upgrade virtualenv
```

Create a Python 3.6 virtual environment for this project and activate the virtualenv:
```bash
$ virtualenv -p python3.6 yoloface
$ source ./yoloface/bin/activate
```

**Note:** This repositoty works on Python 3.x. Using Python virtual environment is highly recommended.
Next, install the dependencies for the this project:
```bash
$ pip install -r requirements.txt
```

## Usage

Expand Down Expand Up @@ -62,8 +82,6 @@ $ python yoloface.py --src 1 --output-dir outputs/

![Imgur](outputs/outside_000001_yoloface.jpg)

![Imgur](outputs/meeting_11_304_yoloface.jpg)

## License

This project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for more details.
Expand Down

0 comments on commit 423a916

Please sign in to comment.