Skip to content

Commit c3d3509

Browse files
committed
Modify: README - Updated README.md
1 parent fe0f4a9 commit c3d3509

File tree

1 file changed

+29
-13
lines changed

1 file changed

+29
-13
lines changed

README.md

Lines changed: 29 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -11,28 +11,43 @@ Because sometimes, you have folders full of badly named pictures, and you want t
1111

1212
# Prerequisites & installation
1313

14-
You need Docker installed, and you need to pull the DeepDetect image.
14+
You need DeepDetect installed, the easiest way is using docker:
1515
```
1616
docker pull beniz/deepdetect_cpu
17+
docker run -d -p 8080:8080 -v /path/to/images:/path/to/images beniz/deepdetect_cpu
1718
```
1819

19-
First download the latest release from https://github.com/CorentinB/DeepSort/releases
20-
Make it executable with:
20+
PLEASE NOTE THAT THE PATH IN THE HOST SHOULD BE THE SAME IN THE CONTAINER!
21+
Example:
2122
```
22-
chmod +x deepsort
23+
docker run -d -p 8080:8080 -v /home/corentin/Images:/home/corentin/Images beniz/deepdetect_cpu
2324
```
2425

25-
You also need your local 8080 port to not be mapped already.
26-
27-
# Usage
26+
If you prefeer using DeepDetect without Docker, refeer to the official documentation here:
27+
https://github.com/jolibrain/deepdetect/blob/master/README.md
28+
You'll find how to install it without Docker.
2829

29-
Just input a folder, and it will recursively rename all the pictures the following way:
30+
Then, download the latest DeepSort release from https://github.com/CorentinB/DeepSort/releases
31+
Unzip your release, rename it `deepsort` and make it executable with:
3032
```
31-
identified-image-class_hash.ext
32-
```
33-
To start the tagging:
33+
chmod +x deepsort
3434
```
35-
./deepsort FOLDER
35+
36+
# Usage
37+
38+
Right now, DeepSort doesnt support a lot of different parameters, you're obliged to fill two of them:
39+
`--url` or `-u` that correspond to the URL of your DeepDetect server.
40+
`--input` or `-i` that correspond to your local folder full of images.
41+
42+
For more informations, refeer to the helper:
43+
```./deepsort --help
44+
usage: deepsort [-h|--help] -u|--url "<value>" -i|--input "<value>"
45+
AI powered image tagger backed by DeepDetect
46+
Arguments:
47+
48+
-h --help Print help information
49+
-u --url URL of your DeepDetect instance (i.e: http://localhost:8080)
50+
-i --input Your input folder.
3651
```
3752

3853
# (Really really quick) Benchmark
@@ -41,6 +56,7 @@ Tested on 605 files, it took 11m18s on an i7 7700K.
4156

4257
# Todo list
4358

44-
- [ ] Getting docker out of the loop (each user install his own DeepDetect)
59+
- [X] Getting docker out of the loop (each user install his own DeepDetect)
4560
- [ ] ResNet 50 integration
4661
- [ ] XMP metadata writing
62+
- [ ] GPU support

0 commit comments

Comments
 (0)