README.md

metadata

title: Research Notes Matcher
emoji: 🏢
colorFrom: pink
colorTo: purple
sdk: gradio
sdk_version: 5.1.0
app_file: app.py
pinned: false
license: mit
short_description: Assist you to match bucnhes of text with your reference note

Research Notes Matcher

This application allows you to find the top 5 matching research notes based on your input text. The tool uses a pre-trained language model from Hugging Face's Sentence Transformers to compute semantic similarity between the notes and the user input.

Features

• Upload CSV: Upload a CSV file containing research notes.
• Text Input: Enter your text to find the most relevant notes.
• Semantic Matching: The application uses a Sentence Transformer to provide more meaningful matches compared to traditional methods.

Requirements

Make sure to install the following packages:

pip install gradio pandas sentence-transformers scikit-learn

Usage

1. Run the application.
2. Upload a CSV file with the columns Source, Section, and Notes.
3. Type your content in the provided textbox.
4. Click the submit button to see the top 5 matching entries.

Sample CSV Format

Your CSV file should have the following columns:

Source	Section	Notes
Source1	Section1	Note1
Source2	Section2	Note2

Launching the Application

To run the application, execute the following command in your terminal:

python app.py

Replace app.py with the name of your Python file if it's different.

License

This project is licensed under the MIT License.

Acknowledgements

• Gradio for creating the user interface.
• Hugging Face for providing the Sentence Transformers.

---