Skip to content

Commit

Permalink
Updated the ReadMe
Browse files Browse the repository at this point in the history
- Added a new sniffer gif
- Updated the coming soon section
- Added a hotkeys section
  • Loading branch information
2320sharon authored Apr 4, 2022
1 parent a48726c commit fb70610
Showing 1 changed file with 19 additions and 6 deletions.
25 changes: 19 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,22 @@
# Sniffer 🐕
<img src="https://user-images.githubusercontent.com/61564689/159071698-5332b923-1e98-4082-95a1-bbf5b04ce318.gif" align="right"


<img src="https://user-images.githubusercontent.com/61564689/161645555-2b59559a-68a8-47dc-b11c-24f4e9a244f6.gif" align="right"
alt="Sniffer Logo" width="560" height="450">

"Sniff out the good and bad imagery in your dataset."

- A python application for sorting through imagery.
- Only sorts jpgs in the `images` directory
- Saves the sorted jpgs in two directories called `good_images` and `bad_images` within the program's directory when `File Mode` is activated
- Saves the outputs as a csv into the programs current working directory when `CSV Mode` is activated


## Running the Program :computer:

- There are two ways to run the program, from the command line or from within a jupyter notebook.

#### Jupyter Notebook Method
#### Jupyter Notebook Method 🪐

1. `conda activate Sniffer`
2. `cd <location where you saved Sniffer>`
Expand All @@ -25,7 +29,17 @@
3. `panel serve Sniffer.ipynb`
4. Copy the local host text into your browser of choice `http://localhost:5006/Sniffer`

## Installation Guide

## How to Use Hotkeys ⌨️
I recommend using hotkeys in the [localhost](#command-prompt-method) version of Sniffer. Sometimes jupyter notebooks will create and delete cells when you type `a` and `d`. That being said hotkeys will still work in jupyter notebook.
### Sniffer's Hotkeys
`a` = good image
</br>
`d` = bad image
<br>
`s` = undo last action

## Installation Guide 🧰

1. `conda env create --file install/Sniffer.yaml`
2. `conda activate Sniffer`
Expand All @@ -34,13 +48,12 @@
Currently sniffer only works with images with the `.jpg` extension. Other file types are not supported.
#### Unsupported File Types
- :x: `.jpeg`
- :x: `.JPG`
- :x: `.PNG`


## :open_mouth: Updates Coming Soon :open_mouth:

1. Hotkeys - in development
2. Support for `.png`s
1. Support for `.png`s
2. Support for `.jpeg`s
3. Hosting :globe_with_meridians:

0 comments on commit fb70610

Please sign in to comment.