Skip to content

Commit 3146556

Browse files
author
dbickson
committed
improving documentation
1 parent 39ef4c2 commit 3146556

File tree

1 file changed

+9
-2
lines changed

1 file changed

+9
-2
lines changed

RUN.md

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,8 +21,15 @@ The main function of fastdup is `run`. It works by extracting short feature vect
2121
The only mandatory argument is image_dir. Given an image directory it will compare all pairs of images and store the most similar ones in the output file output_similarity.
2222
2323
Parameters:
24-
input_dir (str): Location of the images directory (or videos). Mandatory.
25-
Alternatively, it is also possible to give a location of a file listing images full path, one image per row.
24+
input_dir (str): Location of the images/videos to analyze.
25+
- A local folder
26+
- A remote folder (s3 or minio starting with minio://)
27+
- A file containing absolute filenames each on its own row
28+
- A python list with absolute filenames
29+
We support jpg, jpeg, tiff, tif, giff, png, mp4, avi. In addition we support tar, tar.gz, tgz and zip files containing images.
30+
If you have other image extensions that are readable by opencv imread() you can give them in a file and then we do not check for the
31+
known extnsions.
32+
Note: it is not possible to mix compressed (videos or tars/zips) and regular images. Use the flag turi_param='tar_only=1' if you want to ignore images and run from compressed files in case your folders are mixed.
2633
2734
work_dir (str): Working directory for saving intermediate results and outputs. Default is local folder ('.').
2835

0 commit comments

Comments
 (0)