Giter Club home page Giter Club logo

search-app's Introduction

Offer Search App

LICENSE PYTHON PYTORCH


๐Ÿ“ƒ Dependencies

Ideal setup requires a Graphic Card


๐Ÿ›  Installation

  1. Clone repo

    git clone https://github.com/95anantsingh/search-app.git
  2. Create conda environment

    conda env create -f env.yml
  3. Download NLTK Data

    conda activate search
    python -m nltk.downloader punkt stopwords

โšก Run App

cd search-app
conda activate search
streamlit run ๐Ÿ”_Search.py

Now search for offers with options on the left to see results.

Demo


๐Ÿ“˜ Report

Project report can be found here or you can find it in the app as well.


๐Ÿ“ Project Structure

Folder Name Description
.streamlit Configuration files for Streamlit
.vscode Visual Studio Code settings and files
core Core application module
โ”œโ”€ base_search.py Base search class
โ”œโ”€ bm25.py BM25 search class
โ”œโ”€ data_processor.py Data processing code
โ”œโ”€ hybrid.py Hybrid search class
โ”œโ”€ init.py Initialization module
โ”œโ”€ neural.py Neural search class
โ”œโ”€ offers_db.py Offers database class
โ”œโ”€ tfidf.py TF-IDF search class
data Data used by the application
โ”œโ”€ processed Processed data files
โ”‚ โ”œโ”€ database.sqlite Offers SQLite database
โ”‚ โ”œโ”€ syn_queries.json Synthetic queries
โ”‚ โ”œโ”€ true_scores.csv True scores (CSV)
โ”‚ โ”œโ”€ true_scores_gold.csv True scores (gold) (CSV)
โ”‚ โ””โ”€ true_scores_syn.csv True scores (synthetic) (CSV)
โ””โ”€ raw Raw data files
notebooks Jupyter Notebook files
โ”œโ”€ eval.ipynb Evaluation notebook
โ”œโ”€ queries.ipynb Query Generation notebook
โ””โ”€ search_exp.ipynb Search experiment Notebook
vectors Vector Database files
โ”œโ”€ bm25 BM25 model files
โ”œโ”€ neural Neural model files
โ”‚ โ””โ”€ retrieval FAISS Vector Database Files
โ””โ”€ tfidf TF-IDF files
pages Application web pages
๐Ÿ”_Search.py Streamlit App File
env.yml Environment configuration file
README.md Repository README file
requirements.txt Python package requirements

๐Ÿ‘ฉ๐Ÿปโ€๐Ÿ’ป UML Diagrams

The pacakge core has the main code of this app. UML diagrams are shown below.

1. Core Package

package

2. Classes

classes


๐Ÿ“ง Contact

If you have any question, please email [email protected]

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.