Skip to content

Commit

Permalink
Update commands and documentation in readme
Browse files Browse the repository at this point in the history
  • Loading branch information
anjus1313 committed Dec 10, 2024
1 parent 36d7f8f commit 1635391
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 3 deletions.
7 changes: 4 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -75,15 +75,16 @@ python -m src.Sample_Client.sample_bulk_upload_client --directory_paths <path_to

### Task 2: Find matching faces
```
python -m src.Sample_Client.sample_find_face_client --file_paths <path_to_image> --database_name <database_name>
python -m src.Sample_Client.sample_find_face_client --file_paths <path_to_image> --database_name <database_name> --similarity_threshold <similarity_threshold>
```
Note: The name of the database needs to be an existing database you wish to query.
> Note: The name of the database needs to be an existing database you wish to query.
> The default similarity threshold, 0.45 is used if no similarity threshold is provided.

_Run with Sample test image: (Requires absolute path of image)_

```
python -m src.Sample_Client.sample_find_face_client --file_paths <path_to_project>\resources\test_image.jpg --database_name test_database
python -m src.Sample_Client.sample_find_face_client --file_paths <path_to_project>\resources\test_image.jpg --database_name test_database --similarity_threshold 0.5
```

## Rescue-Box frontend
Expand Down
14 changes: 14 additions & 0 deletions src/app-info.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,20 @@ To populate a database with images, utilize the **Upload Images to Database** en

- **Database Name:** Choose the database to search within.

- **Similarity Threshold:** A threshold value to determine the minimum similarity score required for a match to be considered a positive match.

Default value provides a tradeoff between two things, it tries to ensure we find the right person when they are in the database while also avoiding saying we found someone when they aren't there. This setting can be adjusted depending on whether you want to focus more on finding as many matches as possible (decrease threshold) or being extra careful to avoid wrong ones (increase threshold).


**Guide to tuning threshold:**
- Increase the threshold value to narrow down the search to higher similarity faces.

**Sample case:** You could increase threshold if the search image is clear and up-to-date, so you can look for a match with a high degree of confidence.

- Decrese the threshold if you wish to broaden the search to include more variability in faces.

**Sample case:** You could decrease threshold if the search image is blurry or outdated, so you are open to some variability in the possible matches.

### Outputs

- Refer to the results section for the matches found within the database.

0 comments on commit 1635391

Please sign in to comment.