Skip to content

Commit

Permalink
update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
JettChenT committed Feb 24, 2023
1 parent 15f8324 commit 010e23f
Show file tree
Hide file tree
Showing 2 changed files with 21 additions and 2 deletions.
2 changes: 1 addition & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -133,4 +133,4 @@ shodan-api-key.env
.idea/
.tmpimage
tmp/
.env
**/.env
21 changes: 20 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@ btw: we have a discord channel ! [join](https://discord.gg/JCepvsHNqW)

- [Usage](#Usage)
- [Installation](#Installation)
- [Places365: On device model](#places365-on-device-footage-classification)
- [Demo](#Demo)

## Usage
Expand All @@ -45,7 +46,8 @@ If your terminal supports links, click the link and open it in your browser, oth
go to [shodan.io](https://shodan.io), register/log in and grab your API key

4. set up clarifai:
go to [clarifai.com](https://clarifai.com), register/log in, create an application and grab your API key
go to [clarifai.com](https://clarifai.com), register/log in, create an application and grab your API key.
Alternatively, use the [places365](#places365-on-device-footage-classification) model.

5. setup geoip:
go to [geo.ipify.org](https://geo.ipify.org), register/log in and grab your API key
Expand All @@ -56,6 +58,23 @@ If your terminal supports links, click the link and open it in your browser, oth

And then you can [run](#Usage) the program!

## Places365: On device footage classification
It is now possible to run [the Places365 model](https://github.com/CSAILVision/places365),
a model fined tuned for real world locations,
to get information about webcam footage.

To use this model, you need to install the following packages:
```bash
pip install torch torchvision
```

Then, you can run the program with the `--places` flag:
```
python sfw search MJPG --tag=False --places
```

The model will take some time to download, and will be cached for future use.

## Demo

[![asciicast](https://asciinema.org/a/494164.svg)](https://asciinema.org/a/494164)

0 comments on commit 010e23f

Please sign in to comment.