mirror of
https://github.com/Monadical-SAS/reflector.git
synced 2026-02-05 02:16:46 +00:00
Igor Monadical
407c15299f
* feat: WIP doc (vibe started and iterated) * install from scratch docs * caddyfile.example * gitignore * authentik script * authentik script * authentik script * llm doc * authentik ongoing * more daily setup logs * doc website * gpu self hosted setup guide (no-mistakes) * doc review round * doc review round * doc review round * update doc site sidebars * feat(docs): add mermaid diagram support * docs polishing * live pipeline doc * move pipeline dev docs to dev docs location * doc pr review iteration * dockerfile healthcheck * docs/pr-comments * remove jwt comment * llm suggestion * pr comments * pr comments * document auto migrations * cleanup docs --------- Co-authored-by: Mathieu Virbel <mat@meltingrocks.com> Co-authored-by: Igor Loskutov <igor.loskutoff@gmail.com>
61 lines
2.9 KiB
Markdown
61 lines
2.9 KiB
Markdown
---
|
|
sidebar_position: 1
|
|
title: Introduction
|
|
---
|
|
|
|
# Welcome to Reflector
|
|
|
|
Reflector is a privacy-focused, self-hosted AI-powered audio transcription and meeting analysis platform that provides real-time transcription, speaker diarization, and summarization for audio content and live meetings. With complete control over your data and infrastructure, you can run models on your own hardware (roadmap - currently supports Modal.com for GPU processing).
|
|
|
|
## What is Reflector?
|
|
|
|
Reflector is a web application that utilizes AI to process audio content, providing:
|
|
|
|
- **Real-time Transcription**: Convert speech to text using [Whisper](https://github.com/openai/whisper) (multi-language) or [Parakeet](https://github.com/NVIDIA/NeMo) (English) models
|
|
- **Speaker Diarization**: Identify and label different speakers using [Pyannote](https://github.com/pyannote/pyannote-audio) 3.1
|
|
- **Topic Detection & Summarization**: Extract key topics and generate concise summaries using LLMs
|
|
- **Meeting Recording**: Create permanent records of meetings with searchable transcripts
|
|
|
|
|
|
|
|
## Features
|
|
|
|
| Feature | Public Mode | Private Mode |
|
|
|--------------------------------------------|------------|--------------|
|
|
| **Authentication** | None required | Required |
|
|
| **Audio Upload** | ✅ | ✅ |
|
|
| **Live Microphone Streaming** | ✅ | ✅ |
|
|
| **Transcription** | ✅ | ✅ |
|
|
| **Speaker Diarization** | ✅ | ✅ |
|
|
| **Topic Detection** | ✅ | ✅ |
|
|
| **Summarization** | ✅ | ✅ |
|
|
| **Virtual Meeting Rooms (Whereby, Daily)** | ❌ | ✅ |
|
|
| **Browse Transcripts Page** | ❌ | ✅ |
|
|
| **Search Functionality** | ❌ | ✅ |
|
|
| **Persistent Storage** | ❌ | ✅ |
|
|
|
|
## Architecture Overview
|
|
|
|
Reflector consists of three main components:
|
|
|
|
- **Frontend**: React application built with Next.js
|
|
- **Backend**: Python server using FastAPI
|
|
- **Processing**: Scalable GPU workers for ML inference (Modal.com or local)
|
|
|
|
## Getting Started
|
|
|
|
Ready to deploy Reflector? Head over to our [Installation Guide](./installation/overview) to set up your own instance.
|
|
|
|
For a quick overview of how Reflector processes audio, check out our [Pipeline Documentation](./pipelines/overview).
|
|
|
|
## Open Source
|
|
|
|
Reflector is open source software developed by [Monadical](https://monadical.com) and licensed under the **MIT License**. We welcome contributions from the community!
|
|
|
|
- [GitHub Repository](https://github.com/monadical-sas/reflector)
|
|
- [Issue Tracker](https://github.com/monadical-sas/reflector/issues)
|
|
- [Pull Requests](https://github.com/monadical-sas/reflector/pulls)
|
|
|
|
## Support
|
|
|
|
Need help? Reach out to the community through GitHub Discussions. |