https://github.com/aryanvbw/nst-ai
🎓 NST AI - Your Personal Study Companion
https://github.com/aryanvbw/nst-ai
aryanvbw newton-school nst-ai vivek vivek-w
Last synced: 2 months ago
JSON representation
🎓 NST AI - Your Personal Study Companion
- Host: GitHub
- URL: https://github.com/aryanvbw/nst-ai
- Owner: AryanVBW
- Created: 2024-10-28T06:52:21.000Z (12 months ago)
- Default Branch: main
- Last Pushed: 2025-04-15T00:19:13.000Z (6 months ago)
- Last Synced: 2025-07-28T07:24:07.044Z (3 months ago)
- Topics: aryanvbw, newton-school, nst-ai, vivek, vivek-w
- Language: Python
- Homepage: http://vivek.aryanvbw.live/NST-AI/
- Size: 33.7 MB
- Stars: 0
- Watchers: 1
- Forks: 2
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: docs/CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Security: docs/SECURITY.md
Awesome Lists containing this project
README
# 🎓 NST AI - Your Personal Study Companion
• Presentation: https://nst-ai.aryanvbw.live/
• Demo video: https://youtu.be/PgualJtHqiE
Welcome to **NST AI** – your AI-powered study buddy designed specifically for Newton School of Technologies! With NST AI, you can ask questions, summarize lectures, and interact with your notes offline using state-of-the-art language models like **Mistral 7b LLM** and **Nomic Embed Text**. Follow the steps below to set up NST AI on macOS.
---
## 🚀 Features
- 💬 **Ask AI Anything**: Get instant answers to questions about your lectures and notes.
- 📑 **Summarize Notes**: Automatically summarize classes, lectures, and key study topics.
- 🌐 **Offline Access**: Access powerful LLM capabilities without an internet connection.
---
## 📋 Prerequisites
Before you start, make sure the following are installed on your Mac:
- 🐍 **Python 3.11** [Download here](https://www.python.org/downloads/)
- 🍺 **Homebrew** [Install Homebrew](https://brew.sh/)
---
## ⚙️ Installation Guide
Follow these steps to install and set up NST AI:
### Step 1: 🔄 Update Pip
First, update `pip` to the latest version:
```
pip install pip --upgrade
```
### Step 2: 📦 Install Poetry
Install Poetry to manage project dependencies:
```
pip install poetry
poetry --version
```
### Step 3: 🌐 Install Ollama.ai
1. Visit Ollama’s official website and download the macOS version.
2. After downloading, unzip the file, open it, and follow the instructions to move Ollama to your Applications folder.
3. Important: Quit Ollama from the taskbar by selecting Quit Ollama.
### Step 4: 📥 Download LLM Models
NST AI uses Mistral 7b LLM and Nomic Embed Text models for offline functionality. Pull these models with:
```
ollama pull mistral
ollama pull nomic-embed-text
```
### Step 5: 🖥️ Start Ollama Service
Start the Ollama service:
```
ollama serve
```
⚠️ Note: If you see Error: listen tcp 127.0.0.1:11434: bind: address already in use, Ollama is already running. Close it from the taskbar and try again.
Step 6: 🛠️ Install Ollama LLM with Poetry
In a new terminal window, install NST AI’s dependencies:
```
poetry install --extras "ui llms-ollama embeddings-ollama vector-stores-qdrant"
```
### Step 7: 🚀 Run NST AI
To start NST AI, use:
```
PGPT_PROFILES=ollama make run
```
Access NST AI in your browser at http://localhost:8001.
🛠 Troubleshooting
• 🐢 Slow CPU or GPU Issues:
If NST AI is slow or if you experience GPU issues, modify the timeout setting:
Open ```components/llm/llm_component.py``` and add:
```request_timeout=300```
🎥 Video Tutorial
🌟 Final Note
NST AI is here to enhance student learning at NST, making studying easier and more efficient. If you have any questions or need assistance, feel free to reach out. Enjoy exploring the world of personalized AI learning! 🎉