Skip to content

Commit

Permalink
Released version 0.2 to PyPI
Browse files Browse the repository at this point in the history
  • Loading branch information
madhawav committed Mar 18, 2021
1 parent 53fdd47 commit 7f34583
Show file tree
Hide file tree
Showing 3 changed files with 17 additions and 12 deletions.
4 changes: 2 additions & 2 deletions Readme.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# YOLO3-4-Py
[![PyPI Badge](https://img.shields.io/badge/PyPI-0.1.0-blue.svg)](https://pypi.org/project/yolo34py)
[![PyPI Badge](https://img.shields.io/badge/PyPI-0.1.0--gpu-blue.svg)](https://pypi.org/project/yolo34py-gpu)
[![PyPI Badge](https://img.shields.io/badge/PyPI-0.2.0-blue.svg)](https://pypi.org/project/yolo34py)
[![PyPI Badge](https://img.shields.io/badge/PyPI-0.2.0--gpu-blue.svg)](https://pypi.org/project/yolo34py-gpu)
[![Build Status](https://travis-ci.org/madhawav/YOLO3-4-Py.svg?branch=master)](https://travis-ci.org/madhawav/YOLO3-4-Py)

A Python wrapper on [Darknet](https://github.com/pjreddie/darknet). Compatible with latest [YOLO V3](https://pjreddie.com/darknet/yolo).
Expand Down
23 changes: 14 additions & 9 deletions src/pypi_readme.md
Original file line number Diff line number Diff line change
@@ -1,19 +1,19 @@
A Python wrapper on [pjreddie's](https://pjreddie.com/) implementation (authors' implementation) of [YOLO V3 Object Detector](https://pjreddie.com/darknet/yolo) on [Darknet](https://github.com/pjreddie/darknet).
Also compatible with other Darknet Object Detection models.
This wrapper is also compatible with other Darknet object detection models.

![OutputImage](https://raw.githubusercontent.com/madhawav/YOLO3-4-Py/master/doc/output.jpg)
Image source: http://absfreepic.com/free-photos/download/crowded-cars-on-street-4032x2272_48736.html

# Prerequisites
* Python 3.6+
* Linux x86-64 Operating System
* nVidia CUDA SDK (for GPU version only. Make sure nvcc is available in PATH variable.)
* NVIDIA CUDA SDK (for GPU version only. Make sure nvcc is available in PATH variable.)

# Sample Usage
Note: This sample code requires OpenCV with python bindings installed. (`pip3 install opencv-python==3.4.0`)

1) Create a directory to host sample code and navigate to it.
2) Download and execute [this script](https://github.com/madhawav/YOLO3-4-Py/blob/master/download_models.sh) to download model files.
2) Download and execute [this script](https://github.com/madhawav/YOLO3-4-Py/blob/master/tools/download_models.sh) to download model files.
3) Create sampleApp.py with following code. Specify SAMPLE_INPUT_IMAGE.
```python
from pydarknet import Detector, Image
Expand All @@ -26,38 +26,43 @@ Note: This sample code requires OpenCV with python bindings installed. (`pip3 in

results = net.detect(img_darknet)

for cat, score, bounds in results:
for category, score, bounds in results:
x, y, w, h = bounds
cv2.rectangle(img, (int(x - w / 2), int(y - h / 2)), (int(x + w / 2), int(y + h / 2)), (255, 0, 0), thickness=2)
cv2.putText(img,str(cat.decode("utf-8")),(int(x),int(y)),cv2.FONT_HERSHEY_COMPLEX,1,(255,255,0))
cv2.putText(img, category ,(int(x),int(y)),cv2.FONT_HERSHEY_COMPLEX,1,(255,255,0))

cv2.imshow("output", img)
cv2.waitKey(0)
```
4) Execute sampleApp.py `python sampleApp.py`.

# Installation
yolo34py comes in 2 variants, _CPU Only Version_ and _GPU Version_. Installation may take a while since it involves downloading and compiling of darknet.
yolo34py comes in 2 variants, _CPU Only Version_ and _GPU Version_.
Installation may take a while since it involves downloading and compiling darknet.

## __CPU Only Version__
This version is configured on darknet compiled with flag GPU = 0.
```bash
pip3 install requests # Used to download darknet
pip3 install cython
pip3 install numpy
pip3 install yolo34py
```

## GPU Version:
This version is configured on darknet compiled with flag GPU = 1.
```bash
pip3 install requests # Used to download darknet
pip3 install cython
pip3 install numpy
pip3 install yolo34py-gpu
```


# More Information
* For more details on yolo34py (This python wrapper):
- GitHub Repo: https://github.com/madhawav/YOLO3-4-Py
- This is the place to discuss about issues of yolo34py.
- GitHub: https://github.com/madhawav/YOLO3-4-Py
- This is the place to discuss issues of yolo34py.
- Your contributions are greatly appreciated.
* For more details on YOLO V3:
- Website from Authors: https://pjreddie.com/yolo
Expand All @@ -68,4 +73,4 @@ pip3 install yolo34py-gpu

# License
* yolo34py (this wrapper) is under [Apache License 2.0](https://github.com/madhawav/YOLO3-4-Py/blob/master/LICENSE).
* The version of darknet wrapped by yolo34py is [public domain](https://github.com/madhawav/darknet/blob/master/LICENSE).
* The version of darknet wrapped by yolo34py is in [public domain](https://github.com/madhawav/darknet/blob/master/LICENSE).
2 changes: 1 addition & 1 deletion src/setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -92,7 +92,7 @@
long_description=get_readme(),
long_description_content_type="text/markdown",
cmdclass=cmd_class,
version='0.2rc1',
version='0.2',
ext_modules=ext_modules,
platforms=["linux-x86_64"],
setup_requires=[
Expand Down

0 comments on commit 7f34583

Please sign in to comment.