Refactor STT pipeline and CLI documentation
Split the STT worker into a collector and a transcription worker to offload heavy processing to a background thread. Add the `--whisper-model` flag and implement LLM latency logging. Expand the README with comprehensive CLI usage instructions.
This commit is contained in:
@@ -28,8 +28,54 @@ Distill long sessions into concise highlights. Use LLMs to summarize recorded tr
|
||||
|
||||
## Interface & Usage
|
||||
|
||||
- **CLI**: The primary interface for confirming automated updates and querying current game state.
|
||||
- **Text Editors**: Since data is stored in Markdown and JSON, you can use any editor (VS Code, Vim, Obsidian) to manually refine your campaign data.
|
||||
### CLI
|
||||
|
||||
The primary interface for confirming automated updates and querying current game state.
|
||||
|
||||
#### Command Line Arguments
|
||||
|
||||
Use these flags to manage data ingestion and run the live capture pipeline.
|
||||
|
||||
##### RAG Ingestion
|
||||
Use these flags to add external documents to the RAG (Retrieval-Augmented Generation) system.
|
||||
|
||||
| Flag | Description |
|
||||
| :--- | :--- |
|
||||
| `--ingest-pdf <path>` | Path to a PDF file to ingest |
|
||||
| `--ingest-file <path>` | Path to a markdown file to ingest |
|
||||
| `--ingest-dir <path>` | Path to a directory of markdown files to ingest |
|
||||
|
||||
##### LLM Configuration
|
||||
These flags allow you to override the environment variables for the LLM backend.
|
||||
|
||||
| Flag | Description |
|
||||
| :--- | :--- |
|
||||
| `--llm-backend <backend>` | Backend to use (`openai`, `ollama`, or `vllm`) |
|
||||
| `--llm-model <model>` | The model name to use |
|
||||
| `--llm-api-key <key>` | API key for the LLM backend |
|
||||
| `--llm-base-url <url>` | Base URL for the LLM backend |
|
||||
|
||||
##### Pipeline Execution
|
||||
| Flag | Description |
|
||||
| :--- | :--- |
|
||||
| `--run-pipeline` | Starts the main orchestration pipeline (TUI + STT + LLM) |
|
||||
|
||||
##### Example Command
|
||||
|
||||
To run the live orchestration pipeline using the configuration specified in your `env.sh`, you can use:
|
||||
|
||||
```bash
|
||||
python main.py --run-pipeline \
|
||||
--llm-backend vllm \
|
||||
--llm-model google/gemma-4-26b-a4b-it \
|
||||
--llm-api-key no-key-required \
|
||||
--whisper-model medium \
|
||||
--llm-base-url https://vllm.tipsy.codes/v1
|
||||
```
|
||||
|
||||
### Text Editors
|
||||
|
||||
Since data is stored in Markdown and JSON, you can use any editor (VS Code, Vim, Obsidian) to manually refine your campaign data.
|
||||
|
||||
## Technical Stack
|
||||
|
||||
|
||||
Reference in New Issue
Block a user