automatically quant GGUF models
Go to file
dependabot[bot] cc47e59f37
build(deps): update huggingface-hub requirement
Updates the requirements on [huggingface-hub](https://github.com/huggingface/huggingface_hub) to permit the latest version.
- [Release notes](https://github.com/huggingface/huggingface_hub/releases)
- [Commits](https://github.com/huggingface/huggingface_hub/compare/v0.29.1...v0.29.2)

---
updated-dependencies:
- dependency-name: huggingface-hub
  dependency-type: direct:production
...

Signed-off-by: dependabot[bot] <support@github.com>
2025-03-09 11:52:53 +00:00
.github ci: update artifact upload version 2025-02-10 17:36:09 -08:00
assets refactor: prepare repo for v1.8.1 2024-09-04 17:19:54 -07:00
docs feat(ui): update Japanese and German localizations 2024-09-15 12:48:41 -07:00
plugins feat(core): implement plugins 2024-08-22 20:08:02 -07:00
src feat(backend): allow setting fetch repository 2025-01-27 15:32:07 -08:00
.env.example feat(backend): allow setting fetch repository 2025-01-27 15:32:07 -08:00
.gitattributes chore: add .gitattributes 2024-08-04 18:52:14 -07:00
.gitignore refactor: optimize GGUF imports 2024-09-14 10:11:43 -07:00
.pre-commit-config.yaml ci: remove crlf 2024-08-04 21:15:34 -07:00
CHANGELOG.md chore: updated changelog for v2 2025-01-27 19:04:15 -08:00
CODE_OF_CONDUCT.md docs: add code of conduct 2024-08-05 11:47:18 -07:00
CONTRIBUTING.md refactor: prepare for v1.9.1 2024-10-13 10:21:28 -07:00
LICENSE chore: update for new year and improve compliance 2025-01-08 15:11:47 -08:00
README.md feat(backend): allow setting fetch repository 2025-01-27 15:32:07 -08:00
SECURITY.md refactor: prepare for v1.9.1 2024-10-13 10:21:28 -07:00
build.bat edit favicon 2024-08-04 16:04:04 -07:00
build.sh refactor: prepare for v1.9.1 2024-10-13 10:21:28 -07:00
build_optimized.bat refactor: prepare for v1.9.1 2024-10-13 10:21:28 -07:00
build_optimized.sh refactor: prepare for v1.9.1 2024-10-13 10:21:28 -07:00
requirements.txt build(deps): update huggingface-hub requirement 2025-03-09 11:52:53 +00:00
run.bat modify backend check logic 2024-08-04 09:12:07 -07:00
run.sh refactor: prepare for v1.9.1 2024-10-13 10:21:28 -07:00
setup.py chore: update setup.py email and version 2025-03-04 20:34:10 -08:00

README.md

AutoGGUF-banner

AutoGGUF - automated GGUF model quantizer

GitHub release GitHub last commit CI/CD Status

Powered by llama.cpp Platform Compatibility GitHub license GitHub top language

GitHub stars GitHub forks GitHub release (latest by date) GitHub repo size Lines of Code

Issues Code Style: Black PRs Welcome

The most comprehensive GUI tool for GGUF model quantization. Stop wrestling with command lines - quantize, merge, and optimize your models with just a few clicks.

Features

  • 📩 Download and manage llama.cpp backends
  • 🗃️ Select and quantize GGUF models
  • 📐 Configure quantization parameters
  • 💻 Monitor system resources during quantization
  • Parallel quantization + imatrix generation
  • 🎉 LoRA conversion and merging
  • 📁 Preset saving and loading
  • 8 AutoFP8 quantization
  • 🪓 GGUF splitting and merging
  • 🌐 HTTP API for automated monitoring

Why AutoGGUF?

  • Fast: Saves time on manual configuration
  • Simple: Clean UI, no terminal needed
  • Powerful: Handles models up to infinite size, only limited by your RAM
  • Resource-aware: Optimized memory management and efficient UI library

AutoGGUF-v1 8 1-showcase-blue

Quick Start

Cross-platform

  1. git clone https://github.com/leafspark/AutoGGUF
  2. cd AutoGGUF
  3. Install dependencies:
    pip install -r requirements.txt
    
  4. Run the application:
    python src/main.py
    
    or use the run.bat script.

macOS and Ubuntu builds are provided with GitHub Actions, you may download the binaries in the releases section.

Windows (for the impatient)

Standard builds:

  1. Download the latest release
  2. Extract all files to a folder
  3. Run AutoGGUF-x64.exe
  4. Any necessary folders will be automatically created

Setup builds:

  1. Download setup variant of latest release
  2. Extract all files to a folder
  3. Run the setup program
  4. The .GGUF extension will be registered with the program automatically
  5. Run the program from the Start Menu or desktop shortcuts

After launching the program, you may access its local server at port 7001 (set AUTOGGUF_SERVER to "enabled" first)

Verifying Releases

Linux/macOS:

gpg --import AutoGGUF-v1.5.0-prerel.asc
gpg --verify AutoGGUF-v1.9.1-Windows-avx2.zip.sig AutoGGUF-v1.9.1-Windows-avx2.zip
sha256sum -c AutoGGUF-v1.9.1.sha256

Windows (PowerShell):

# Import the public key
gpg --import AutoGGUF-v1.5.0-prerel.asc

# Verify the signature
gpg --verify AutoGGUF-v1.9.1-Windows-avx2.zip.sig AutoGGUF-v1.9.1-Windows-avx2.zip

# Check SHA256
$fileHash = (Get-FileHash -Algorithm SHA256 AutoGGUF-v1.9.1-Windows-avx2.zip).Hash.ToLower()
$storedHash = (Get-Content AutoGGUF-v1.9.1.sha256 | Select-String AutoGGUF-v1.9.1-Windows-avx2.zip).Line.Split()[0]
if ($fileHash -eq $storedHash) { "SHA256 Match" } else { "SHA256 Mismatch" }

Release keys are identical to ones used for commiting.

Building

Cross-platform

pip install -U pyinstaller
./build.sh RELEASE | DEV
cd build/<type>/dist/
./AutoGGUF

Windows

pip install -U pyinstaller
build RELEASE | DEV

Find the executable in build/<type>/dist/AutoGGUF-x64.exe.

You can also use Nuitka, which may result in a slower build but a faster output executable:

build_optimized RELEASE | DEV

Localizations

View the list of supported languages at AutoGGUF/wiki/Installation#configuration (LLM translated, except for English).

More languages will be updated as soon as possible!

To use a specific language, set the AUTOGGUF_LANGUAGE environment variable to one of the listed language codes (note: some languages may not be fully supported yet, those will fall back to English).

Issues

  • Some inconsistent logging
  • Missing translations

Planned Features

  • Time estimation for quantization
  • Quantization file size estimate
  • Perplexity testing
  • bitsandbytes

Due to my limited availability and a lack of time, I won't be actively developing new features for this project as much. While I'll continue to publish builds from time to time, I strongly recommend running from source if you want to stay up to date with the latest changes. I'm still committed to keeping dependencies updated weekly and making small maintenance fixes to ensure everything runs smoothly. If you run into any problems or notice issues, please don't hesitate to let me know - I appreciate your feedback and will do my best to address them.

Support

  • SSL module cannot be found error: Install OpenSSL or run from source using python src/main.py with the run.bat script (pip install requests)
  • Check out the Wiki for advanced usage and configuration

Contributing

Fork the repo, make your changes, and ensure you have the latest commits when merging. Include a changelog of new features in your pull request description. Read CONTRIBUTING.md for more information.

Stargazers

Star History Chart