Code Monkey home page Code Monkey logo

semanticsearch's Introduction

Meaningful Search

Semantic Search App

Meaningful Search is a powerful tool designed to find the most similar paragraphs in a large collection of PDF files based on the input text. It uses BERT (Bidirectional Encoder Representations from Transformers), a transformer-based machine learning model to create semantic representations of the input and the text from the PDF files. These representations are then compared using cosine similarity to find the most similar paragraphs.

Getting Started

Prerequisites

To use the Meaningful Search, you will need to have the following installed:

  • Python 3.7 or newer
  • PyPDF2
  • PyQt5
  • transformers
  • torch
  • numpy
  • sqlite3
  • sklearn

You can install these packages using pip:

pip install PyPDF2 PyQt5 transformers torch numpy sqlite3 sklearn

Installation

  1. Clone the repository
git clone https://github.com/your_username_/Meaningful_Search.git
  1. Navigate to the repository
cd Meaningful_Search

Usage

  1. Use cacher.py to cache the semantic representations of the text in your PDF files into a SQLite database. You can do this by calling the cache_pdf_encodings function with the path to the directory containing your PDF files as an argument:
from cacher import cache_pdf_encodings
cache_pdf_encodings('path/to/your/pdf/files/')

This will create a SQLite database named pdf_encodings.db containing the semantic representations of the text in your PDF files.

  1. Run search-GUI.py or search-CLI.py to start the Meaningful Search application:
python search-GUI.py

How to use the App (GUI)

  1. Enter the text you want to search in the input field.
  2. Specify the number of most similar paragraphs you want to display using the spinner.
  3. Click the 'Search' button to start the search. The application will display the most similar paragraphs along with their similarity scores, the names of the books they came from, and their page numbers.

How to use the App (CLI)

  1. Enter the text you want to search.
  2. Enter the number of most similar paragraohs you want to display.
  3. Click the 'Enter' button to start the search. The application will display the most similar paragraphs along with their similarity scores, the names of the books they came from, and their page numbers.

Contributing

Contributions are what make the open-source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

License

Distributed under the GNU GPL 3.0 License. See LICENSE for more information.

Contact

Ali Hakim Taskiran - [email protected]

Project Link: https://github.com/alihakimtaskiran/SemanticSearch

Acknowledgments

semanticsearch's People

Contributors

alihakimtaskiran avatar

Stargazers

 avatar  avatar  avatar  avatar

Watchers

 avatar

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.