Skip to content

Commit e522048

Browse files
author
Ben Mansheim
authored
Docs style magic
1 parent 0465c8c commit e522048

File tree

1 file changed

+17
-6
lines changed

1 file changed

+17
-6
lines changed

README.md

Lines changed: 17 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,31 +1,42 @@
11
# AnimalRecognitionDemo
22

3-
This demo combines several [Redis](https://redis.io) Data structures and [Redis Modules](https://redis.io/topics/modules-intro) to filter a stream of images that contain cats. It utilises Redis Streams for capturing the input video stream:`all`. [RedisGears](https://oss.redislabs.com/redisgears/) will process this stream and will call [RedisAI](https://oss.redislabs.com/redisai/) for image classification with MobilenetV2. In case the stream contains cats, it will forward the images to a stream:`cats`.
3+
This demo combines several [Redis](https://redis.io) data structures and [Redis Modules](https://redis.io/topics/modules-intro)
4+
to process a stream of images and filter out the images that contain cats.
5+
6+
It uses:
7+
8+
* Redis Streams to capture the input video stream: `all`
9+
* [RedisGears](https://oss.redislabs.com/redisgears/) to process this stream
10+
* [RedisAI](https://oss.redislabs.com/redisai/) to classify the images with MobilenetV2
11+
12+
It forwards the images that contain cats to a stream: `cats`
413

514
## Architecture
615
![Architecture](/architecture.png)
716

8-
917
## Requirements
1018
Docker and Python 2
1119

1220
## Running the Demo
21+
To run the demo:
1322
```
1423
$ git clone https://github.com/RedisGears/AnimalRecognitionDemo.git
1524
$ cd AnimalRecognitionDemo
1625
# If you don't have it already, install https://git-lfs.github.com/
1726
$ git lfs install && git lfs fetch && git lfs checkout
1827
$ docker-compose up
1928
```
20-
Open a second terminal for the video capturing.
29+
Open a second terminal for the video capturing:
2130
```
2231
$ pip install -r camera/requirements.txt
2332
$ python camera/read_camera.py
2433
```
2534

2635
## UI
27-
* On `http://localhost:3000` you will be able to see all the captured frames
28-
* On `http://localhost:3001` you will see only cats
36+
* `http://localhost:3000` shows all the captured frames
37+
* `http://localhost:3001` shows only the framse with cats
2938

3039
## Limitations
31-
This demo aimed at ease of setup and is hence heavily relying on docker. Better performance and a higher FPS can be achieved by runninng this demo outside docker. To control the FPS, look [here](https://github.com/RedisGears/AnimalRecognitionDemo/blob/master/app/gear.py#L53)
40+
This demo is designed to be easy to setup, so it relies heavily on docker.
41+
You can get better performance and a higher FPS by runninng this demo outside docker.
42+
To control the FPS, edit the [gear.py](https://github.com/RedisGears/AnimalRecognitionDemo/blob/master/app/gear.py#L53) file.

0 commit comments

Comments
 (0)