Skip to content

Commit 042777c

Browse files
authored
Update README.md
1 parent c6ae2e3 commit 042777c

File tree

1 file changed

+13
-8
lines changed

1 file changed

+13
-8
lines changed

README.md

Lines changed: 13 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,29 @@
1-
AutoGGUF - Automated GGUF Model Quantizer
1+
# AutoGGUF - automated GGUF model quantizer
22

33
This application provides a graphical user interface for quantizing GGUF models
44
using the llama.cpp library. It allows users to download different versions of
55
llama.cpp, manage multiple backends, and perform quantization tasks with various
66
options.
77

8-
Main features:
8+
**Main features**:
99
1. Download and manage llama.cpp backends
1010
2. Select and quantize GGUF models
1111
3. Configure quantization parameters
1212
4. Monitor system resources during quantization
1313

14-
Usage:
15-
Run the main.py script to start the application.
14+
**Usage**:
15+
1. Install dependencies, either using the `requirements.txt` file or `pip install PyQt6 requests psutil`.
16+
2. Run the `run.bat` script to start the application, or run the command `python src/main.py`.
1617

17-
Dependencies:
18+
**Dependencies**:
1819
- PyQt6
1920
- requests
2021
- psutil
2122

22-
Author: leafspark
23-
Version: 1.0.0
24-
License: apache-2.0
23+
**To be implemented:**
24+
- Actual progress bar tracking
25+
- Download safetensors from HF and convert to unquanted GGUF
26+
- Specify multiple KV overrides
27+
28+
**User interface:**
29+
![image](https://github.com/user-attachments/assets/b1b58cba-4314-479d-a1d8-21ca0b5a8935)

0 commit comments

Comments
 (0)