✨ | Unsloth Studio (OpenAI API) implementation
This commit is contained in:
65
README.md
65
README.md
@@ -1,27 +1,42 @@
|
||||
# AI Chat for KDE Plasma
|
||||
# Unsloth AI Chat Widget for KDE Plasma
|
||||
|
||||
## IMPORTANT
|
||||
This is just a vibe-coded hobby project. If you wish to use it, then go for it!
|
||||
An integrated AI chat widget for KDE Plasma, powered by [Unsloth Studio](https://github.com/unslothai/unsloth). Interact with a local LLM directly from your desktop.
|
||||
|
||||
## Intro
|
||||
|
||||
An integrated AI chat widget for KDE Plasma, powered by Ollama. Interact with a local LLM directly from your desktop.
|
||||
|
||||
<p align="center"><img src="assets/screenshots/image-1.webp" alt="AI Chat Widget screenshot" /></p>
|
||||
<p align="center"><img src="assets/screenshots/image-1.webp" alt="Unsloth AI Chat Widget screenshot" /></p>
|
||||
|
||||
## Features
|
||||
|
||||
- Chat with local Ollama models
|
||||
- Works inside Plasma Desktop
|
||||
- Easy installation via `kpackagetool6`
|
||||
- Chat with local Unsloth Studio models
|
||||
- Multi-turn conversations with full chat history
|
||||
- Image attachments for vision-capable models (PNG, JPG, JPEG, WEBP)
|
||||
- Configurable system prompts
|
||||
- Static API token authentication
|
||||
- Selectable default model
|
||||
- Clean, native KDE Plasma UI using Kirigami
|
||||
|
||||
## Requirements
|
||||
|
||||
- KDE Plasma 6.0 or later
|
||||
- [Unsloth Studio](https://github.com/unslothai/unsloth) running locally (see [Setup](#setup))
|
||||
|
||||
## Setup
|
||||
|
||||
Before using the widget, start Unsloth Studio:
|
||||
|
||||
```bash
|
||||
pip install unsloth
|
||||
unsloth studio -H 0.0.0.0 -p 8888
|
||||
```
|
||||
|
||||
This will serve your models at `http://localhost:8888`.
|
||||
|
||||
## Installation
|
||||
|
||||
1. **Install the widget**:
|
||||
|
||||
```bash
|
||||
git clone https://git.huitsinnevada.fi/NikkeDoy/Plasma-AI-Chat
|
||||
cd Plasma-AI-Chat
|
||||
git clone https://git.huitsinnevada.fi/NikkeDoy/Plasma-unsloth-Chat
|
||||
cd Plasma-unsloth-Chat
|
||||
kpackagetool6 -t Plasma/Applet -i .
|
||||
```
|
||||
|
||||
@@ -33,7 +48,7 @@ An integrated AI chat widget for KDE Plasma, powered by Ollama. Interact with a
|
||||
plasmashell --replace &
|
||||
```
|
||||
|
||||
> Restarting is recommended to fully activate the new widget.
|
||||
> Restarting is recommended to fully activate the new widget.
|
||||
> Alternatively, log out and log back in.
|
||||
|
||||
## Usage
|
||||
@@ -41,10 +56,26 @@ An integrated AI chat widget for KDE Plasma, powered by Ollama. Interact with a
|
||||
After installation, add the widget to your panel:
|
||||
|
||||
1. Right‑click the panel → **Add Widgets…**.
|
||||
2. Search for **AI Chat** and add it.
|
||||
2. Search for **Unsloth** and add it.
|
||||
3. Open the widget settings (right‑click → Configure) and enter your Unsloth Studio URL and API token.
|
||||
|
||||
The widget will launch and allow you to chat with your local Ollama models.
|
||||
The widget will connect to your Unsloth Studio instance, list available models, and let you start chatting.
|
||||
|
||||
## Configuration
|
||||
|
||||
Right‑click the widget → **Configure** to set:
|
||||
|
||||
| Setting | Description |
|
||||
|---------|-------------|
|
||||
| **Unsloth Studio URL** | API endpoint (e.g., `http://localhost:8888`) |
|
||||
| **API Token** | Authentication token for the API |
|
||||
| **System Prompt** | Custom system prompt for every conversation |
|
||||
| **Default Model** | Model to select on startup |
|
||||
|
||||
## License
|
||||
|
||||
This project is licensed under the MIT license. See the `LICENSE` file for details.
|
||||
This project is licensed under the GNU General Public License v3.0. See the `LICENSE` file for details.
|
||||
|
||||
## Project Website
|
||||
|
||||
<https://huitsinnevada.fi/projects>
|
||||
|
||||
Reference in New Issue
Block a user