Skip to content

Bombex/py4bd_project

Repository files navigation

Weaviate Weaviate

Animal Species Search By Image App

Final project for the Py4BD course.

This application is developed using Streamlit and allows users to upload animal images and find similar images in the database. The app provides a user-friendly interface for visualizing search results and analyzing similarities.

Animal Species Search By Image app

💻 Installation

  1. Install requirements
pip install -r requirements.txt
  1. Create and fill in a .env file similar to .env_example
  2. Run streamlit app if you need
streamlit run st_species_search.py

📚 Quickstart Guide

  1. Go to our streamlit app running on the Streamlit Community Cloud (temporarily unavailable)
  2. Upload an image of the animal you are looking for.
  3. Select the number of similar animals to output in the result.
  4. Get a search result!

Notes

  • This application serves as a demonstration and can be adapted to specific project needs.
  • API of our database in development.

For your own use, you need to prepare your own embedding base on Weaviate

Set environment variables: Set environment variables:

WEAVIATE_URL= YOUR WEAVIATE_CLUSTER_URL
WEAVIATE_API_KEY= YOUR WEAVIATE_API_KEY

To set up your Weaviate cluster, follow either of these methods:

💖 Open Source Contribution

You can improve the animal species search model by submitting datasets of animal images. Please make sure that the species are defined correctly.

The process of submitting a photo:

  1. Folders with the Latin (scientific) name of species
  2. Photos of animals in .JPG format attached to the corresponding folders
  3. Upload the images to Google Drive or any other cloud storage
  4. Go to our Google Form and fill it out.

💾 References

This application is developed based on a dataset from Kaggle

About

Final project for Py4BD

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published