https://github.com/jerryshell/similars
similaRS is a tool for calculating image similarity written in Rust 🦀
https://github.com/jerryshell/similars
Last synced: 11 months ago
JSON representation
similaRS is a tool for calculating image similarity written in Rust 🦀
- Host: GitHub
- URL: https://github.com/jerryshell/similars
- Owner: jerryshell
- License: agpl-3.0
- Created: 2020-04-10T14:53:58.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2024-12-07T15:33:46.000Z (about 1 year ago)
- Last Synced: 2025-01-16T15:27:06.706Z (about 1 year ago)
- Language: Rust
- Homepage:
- Size: 141 KB
- Stars: 1
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# similaRS
_similaRS_ is a tool for calculating image similarity written in Rust 🦀
## How to use
```bash
cargo install --git https://github.com/jerryshell/similars
```
```
Usage: similars_cli [OPTIONS] --image-x-path --image-y-path
Options:
-x, --image-x-path
-y, --image-y-path
--width [default: 8]
--height [default: 8]
-d, --show-distance By default, the output is the percentile of similarity, or the Hamming distance if --show-distance is explicitly specified.
-h, --help Print help
-V, --version Print version
```
## Example
By default, the output is the percentile of similarity
```bash
similars_cli -x example_img1.jpg -y example_img2.jpg
# 95.3125
```
If `-d` is explicitly specified, the output is Hamming distance
```bash
similars_cli -d -x example_img1.jpg -y example_img2.jpg
# 3
```
## References
- [https://www.ruanyifeng.com/blog/2011/07/principle_of_similar_image_search.html](https://www.ruanyifeng.com/blog/2011/07/principle_of_similar_image_search.html)
## License
[GNU Affero General Public License v3.0](https://choosealicense.com/licenses/agpl-3.0/)