leafspark
/
AutoGGUF
mirror of https://github.com/leafspark/AutoGGUF
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

add star history and formatting change

This commit is contained in:
leafspark 2024-08-04 15:39:20 -07:00 committed by GitHub
parent 86b1474c99
commit 91ed31c5a4
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 16 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

29
README.md
View File

@ -5,25 +5,25 @@ # AutoGGUF - automated GGUF model quantizer
llama.cpp, manage multiple backends, and perform quantization tasks with various llama.cpp, manage multiple backends, and perform quantization tasks with various
options. options.
**Main features**: ## Features:
1. Download and manage llama.cpp backends 1. Download and manage llama.cpp backends
2. Select and quantize GGUF models 2. Select and quantize GGUF models
3. Configure quantization parameters 3. Configure quantization parameters
4. Monitor system resources during quantization 4. Monitor system resources during quantization
**Usage**: ## Usage:
Cross platform: **Cross platform**:
1. Install dependencies, either using the `requirements.txt` file or `pip install PyQt6 requests psutil`. 1. Install dependencies, either using the `requirements.txt` file or `pip install PyQt6 requests psutil`.
2. Run the `run.bat` script to start the application, or run the command `python src/main.py`. 2. Run the `run.bat` script to start the application, or run the command `python src/main.py`.
Windows: **Windows**:
1. Download latest release, extract all to folder and run `AutoGGUF.exe` 1. Download latest release, extract all to folder and run `AutoGGUF.exe`
2. Enjoy! 2. Enjoy!
**Building**: ## Building:
Cross platform: **Cross platform**:
```bash ```bash
cd src cd src
pip install -U pyinstaller pip install -U pyinstaller
@ -31,20 +31,20 @@ # AutoGGUF - automated GGUF model quantizer
cd dist/main cd dist/main
./main ./main
``` ```
Windows: **Windows**:
```bash ```bash
build RELEASE/DEV build RELEASE/DEV
``` ```
Find exe in `build/<type>/dist/AutoGGUF.exe`. Find exe in `build/<type>/dist/AutoGGUF.exe`.
**Dependencies**: ## Dependencies:
- PyQt6 - PyQt6
- requests - requests
- psutil - psutil
- shutil - shutil
- OpenSSL - OpenSSL
**Localizations:** ## Localizations:
The following languages are currently supported (machine translated, except for English): The following languages are currently supported (machine translated, except for English):
```python ```python
@ -81,7 +81,7 @@ # AutoGGUF - automated GGUF model quantizer
``` ```
In order to use them, please set the `AUTOGGUF_LANGUAGE` environment variable to one of the listed language codes. In order to use them, please set the `AUTOGGUF_LANGUAGE` environment variable to one of the listed language codes.
**Issues:** ## Issues:
- Actual progress bar tracking - Actual progress bar tracking
- Download safetensors from HF and convert to unquanted GGUF - Download safetensors from HF and convert to unquanted GGUF
- Perplexity testing - Perplexity testing
@ -94,12 +94,15 @@ # AutoGGUF - automated GGUF model quantizer
- ~~Cannot select output/token embd type~~ (fixed in v1.1.0) - ~~Cannot select output/token embd type~~ (fixed in v1.1.0)
- ~~Importing presets with KV overrides causes UI thread crash~~ (fixed in v1.3.0) - ~~Importing presets with KV overrides causes UI thread crash~~ (fixed in v1.3.0)
**Prerelease issues:** ## Prerelease issues:
- Base Model label persists even when GGML type is selected - Base Model label persists even when GGML type is selected
**Troubleshooting:** ## Troubleshooting:
- ~~llama.cpp quantizations errors out with an iostream error: create the `quantized_models` directory (or set a directory)~~ (fixed in v1.2.1, automatically created on launch) - ~~llama.cpp quantizations errors out with an iostream error: create the `quantized_models` directory (or set a directory)~~ (fixed in v1.2.1, automatically created on launch)
- SSL module cannot be found error: Install OpenSSL or run from source `python src/main.py` using the `run.bat` script (`pip install requests`) - SSL module cannot be found error: Install OpenSSL or run from source `python src/main.py` using the `run.bat` script (`pip install requests`)
**User interface:** ## User interface:
![image](https://github.com/user-attachments/assets/906bf9cb-38ed-4945-a32e-179acfdcc529) ![image](https://github.com/user-attachments/assets/906bf9cb-38ed-4945-a32e-179acfdcc529)
## Stargazers:
[![Star History Chart](https://api.star-history.com/svg?repos=leafspark/AutoGGUF&type=Date)](https://star-history.com/#leafspark/AutoGGUF&Date)