Skip to content

Latest commit

 

History

History
75 lines (60 loc) · 2.71 KB

README.md

File metadata and controls

75 lines (60 loc) · 2.71 KB

Trezca Logo


Supafast Image Similarity Indexing

Getting Started (beta)

Install rust if you haven't

This will prepare the release binary on your local machine

git clone https://github.com/udaypatel1/tezca.git
cd tezca
cargo build --release

To run the release binary, do the following:

cargo run --release assets/sf.jpg assets/la.jpg
Index Value Meaning
0.99 Near perfect positive correlation
0 No similarity
-0.99 Near perfect anti-correlation

Use any combination of the sample images given in assets/ or use your own images

For debugging purposes and contributing to pre-releases, run the binary without the release flag

cargo run -- assets/sf.jpg assets/la.jpg

Contributing

Much is left to do and plan for the future of this initiative. It's meant to be a simple, easy-to-use, and performant CLI tool to compare images in a file system.

Please raise an Issue, create a Branch and make a Pull Request to main if you would like to do any of the following:

  • Make this even faster
    • smarter threading strategies
    • more concurrent processes
    • refining current algorithms
    • adding additional algorithms to refine index accuracy
  • Build a benchmarking feature
    • introduce unit testing natively in Rust
  • Decouple components / services for better maintanability and structure
    • add Github Actions for automated CI/CD related goodies
  • Build better thread management
  • Have ideas for CLI subcommands or flags to expand your proposed functionality
  • Update this README
  • Want to do something cool and new with Rust that is beginner-friendly and applicable but still meaningful + you meet the minimum coolness factor :)

This repo is in WIP status. For more information on non-ML based image processing, read this