nlp-agent

<div align="center"> <a href="docs/release/v2.0.0.md"> <img src="docs/assets/nova-v2.0.0-preview.jpg" alt="Nova — AI-powered NLP Learning & Teaching Platform" width="1280"> </a> <p> <img src="https://img.shields.io/github/stars/liunor/nlp-agent?logo=github" alt="GitHub stars"> <img src="https://github.com/liunor/nlp-agent/actions/workflows/ci.yml/badge.svg?branch=main" alt="CI"> <img src="https://img.shields.io/badge/Python-3.11%2B-3776AB?logo=python&logoColor=white" alt="Python 3.11+"> <img src="https://img.shields.io/badge/FastAPI-005571?logo=fastapi" alt="FastAPI"> <img src="https://img.shields.io/badge/LangGraph-1C3C3C" alt="LangGraph"> <img src="https://img.shields.io/badge/MySQL-4479A1?logo=mysql&logoColor=white" alt="MySQL"> <img src="https://img.shields.io/badge/Redis-DC382D?logo=redis&logoColor=white" alt="Redis"> <img src="https://img.shields.io/badge/Docker-2496ED?logo=docker&logoColor=white" alt="Docker"> <img src="https://img.shields.io/badge/docs-docs%2F-blue" alt="Docs"> <img src="https://img.shields.io/badge/License-MIT-0969da" alt="MIT License"> </p> <p> <a href="#features">Features</a> · <a href="#quick-start">Quick Start</a> · <a href="README.zh.md">中文</a> · <a href="CONTRIBUTING.md">Contributing</a> · <a href="LICENSE">License</a> </p> </div> <img src="docs/assets/demo-flow.gif" alt="Nova feature walkthrough" width="100%" /> Nova is a teaching and learning assistant for NLP courses. A single deployment serves four roles — Learner, Teacher, Developer and Monitor — so one instance covers a whole class. Teachers author topics, Markdown knowledge points and exercise blueprints. Students ask questions in plain language and get step-by-step explanations, auto-graded practice, and a review of each answer against the rubric their teacher defined. The Developer configures models and infrastructure, and the Monitor watches every turn across the pipeline. ## Start here | You want to... | Go to | | --- | --- | | Run it locally in minutes | [Quick Start](#quick-start) | | See what it looks like | [Four dedicated views](#four-dedicated-views) | | Understand the feature set | [Features](#features) | | Configure models & database | [`.env-example`](./.env-example) | | Contribute or extend it | [CONTRIBUTING.md](./CONTRIBUTING.md) | ## Four dedicated views Nova runs four role-based views over a single deployment, so a whole classroom works on one instance: ### Learner The Learner view is where students do their coursework. - Ask questions in plain language and follow step-by-step explanations. - Practise with auto-generated exercises that come from your teacher's blueprints. - Review every answer against the weighted rubric your teacher defined. <p align="center"> <img src="docs/assets/screenshot-learner.png" alt="Learner view" width="900"> </p> ### Teacher The Teacher view is where instructors author the course. - Write topics and Markdown knowledge points; each question is injected with exactly the scope it needs. - Design exercise blueprints that generate questions and grade answers against weighted rubrics. - Keep grading consistent across the class with one shared rubric. <p align="center"> <img src="docs/assets/screenshot-teacher.png" alt="Teacher view" width="900"> </p> ### Developer The Developer view manages model and runtime configuration. - Add and rotate model providers and their API keys in one place. - Tune runtime settings for the web, worker and sandbox services. - Manage the sandbox that runs generated code, isolated from the host. <p align="center"> <img src="docs/assets/screenshot-developer.png" alt="Developer view" width="900"> </p> ### Monitor The Monitor view is the observability dashboard. - Watch live turns, traces and metrics across web, worker and sandbox. - Inspect task activity along the whole pipeline. - Trace a single question from the client all the way to the answer. <p align="center"> <img src="docs/assets/screenshot-monitor.png" alt="Monitor view" width="900"> </p> ## Features - **Four role-based views**: Learner, Teacher, Developer and Monitor, separated by access control so each role sees only what it should. - **Guided learning**: question-and-answer sessions that resolve a problem step by step instead of dumping a single answer. - **Auto-graded exercises**: teachers define blueprints that generate questions and grade each answer against weighted rubrics. - **Knowledge-point catalogue**: teachers write topics and Markdown knowledge points; each question is answered with exactly the scope it needs, nothing more. - **Observability**: a built-in monitor shows turns, traces and metrics across web, worker and sandbox. - **Modular runtime**: a coordinator/worker engine on LangGraph, with tools, memory and sandboxed code execution. - **Web and CLI**: chat from the browser or the terminal, so students and teachers aren't tied to one interface. ## Quick Start ### Prerequisites - Python 3.11 or newer, and [uv](https://docs.astral.sh/uv/). - A MySQL database, configured in `.env`. > [!NOTE] > Copy [`.env-example`](./.env-example) to `.env` and fill in the model service key and database connection before starting. > [!TIP] > For the full distributed stack (nginx, MySQL, Redis, web, worker, sandbox manager), use the provided [`compose.yaml`](./compose.yaml). ### Install and run ```powershell uv sync # install dependencies Copy-Item .env-example .env # prepare config: model key & database uv run python main.py bootstrap-db # initialize the database uv run python main.py bootstrap-developer # create the first account uv run python main.py serve # start the server ``` Once it starts, open <http://127.0.0.1:8765>. ### Log in and explore Log in with the account created by `bootstrap-developer`: - Learner — <http://127.0.0.1:8765/> - Teacher — <http://127.0.0.1:8765/teacher> - Developer — <http://127.0.0.1:8765/developer> Or chat from the terminal: ```powershell uv run python main.py chat ``` For the observability monitor, run `uv run python main.py monitor` first, then open <http://127.0.0.1:8766/>. ## Documentation - [Contributing](./CONTRIBUTING.md) - [Configuration & guides](./docs/) - [License](./LICENSE) --- This repository is licensed under the [MIT](./LICENSE) license.