NoteWise: AI-Powered Notes Enhancement

A FastAPI backend solution for comparing and enhancing student-written lecture notes with transcript data using Gemini and Ollama.
Explore the docs »

Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Troubleshooting
5. Contact

About The Project

This FastAPI backend is designed to enhance notes and transcript data by comparing them using AI models such as Gemini and Ollama. The solution processes uploaded lecture notes and transcript files, divides them into manageable chunks, and applies AI models to fill in any missing gaps.

(back to top)

Built With

• Python
• FastAPI
• Ollama
• Gemini API

(back to top)

Getting Started

To get a local copy up and running follow these simple steps: Note: Windows steps assume that you're using PowerShell from within the Windows Terminal app.

Cloning the repository

> git clone https://github.com/KVVT-LeedsHack/leedshack.git notes-comparison

Running and testing the backend APIs

1. Install Ollama.

Choose an appropriate version here.

You should also pull a model you want to use like this:

> ollama pull deepseek-r1:1.5b`

This will download the model to your machine.

2. Install requirements.

> pip install -r requirements.txt

3. Run the backend.

> uvicorn main:app --reload

4. Test the endpoint. You can test the endpoint by running the request.py script by:

> python request.py