obsidian-plugin/aldo-g_obsidian-llm-test
1
0
Fork 0
mirror of https://github.com/aldo-g/obsidian-llm-test.git synced 2026-07-22 05:42:19 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

getting down to fixing

Browse source
This commit is contained in:
Alastair Grant 2025-03-12 11:11:53 +01:00
commit 99de505f57
1 changed files with 1 additions and 16 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

17
README.md
View file

@ -13,7 +13,6 @@ Test your knowledge with AI-generated questions based on your Obsidian notes. Th
- **Knowledge Assessment**: Test your understanding with customized questions at different difficulty levels
- **Instant Feedback**: Get immediate feedback on your answers
- **Score Tracking**: Track your progress with detailed scoring
- **Bulk Testing**: Mark multiple tests simultaneously to save time
- **Organized Dashboard**: View and manage all your tests in one place
## Installation
@ -25,12 +24,6 @@ Test your knowledge with AI-generated questions based on your Obsidian notes. Th
3. Click "Browse" and search for "Test Plugin"
4. Install the plugin and enable it
### Manual Installation
1. Download the latest release from the [GitHub releases page](https://github.com/aldo-g/obsidian-rag-test-plugin/releases)
2. Extract the files into your Obsidian vault's `.obsidian/plugins/obsidian-rag-test-plugin` folder
3. Restart Obsidian and enable the plugin in the Community Plugins settings
## Setup
1. After installation, go to the plugin settings in Obsidian
@ -102,14 +95,6 @@ This plugin uses Retrieval-Augmented Generation (RAG) with various LLM models to
## FAQ & Troubleshooting
**Q: Which LLM provider should I use?**
A: Each provider has strengths and weaknesses:
- OpenAI's GPT-4 and GPT-4o provide excellent question generation and feedback
- Claude 3 Opus has a large context window for longer notes
- Mistral Medium offers a good balance of performance and cost
- Gemini 1.5 Pro has excellent context handling capabilities
- Choose based on your budget, note size, and preferred response style
**Q: Why do I need an API key?**
A: The plugin uses LLM APIs to generate questions and mark answers. You need an API key to access these services.
@ -151,4 +136,4 @@ This project is licensed under the Zero-Clause BSD License (0BSD).
## Acknowledgements
- Built with [Obsidian Plugin API](https://github.com/obsidianmd/obsidian-api)
- Uses LLM APIs from OpenAI, Anthropic, Mistral, Google, and DeepSeek for test generation and grading
- Uses LLM APIs from OpenAI, Anthropic, Mistral, Google, and DeepSeek for test generation and grading