automatically quant GGUF models
Go to file
leafspark 7349aedc78
ci: fix slashes in build.yml
2024-08-26 15:04:04 -07:00
.github ci: fix slashes in build.yml 2024-08-26 15:04:04 -07:00
assets ci: add inno setup build file 2024-08-16 21:04:32 -07:00
docs docs: update docstrings and small code fixes 2024-08-16 19:43:48 -07:00
plugins feat(core): implement plugins 2024-08-22 20:08:02 -07:00
src chore: bump version to v1.8.0 2024-08-26 14:53:16 -07:00
.env.example fix: update regex for progress tracking 2024-08-20 17:15:55 -07:00
.gitattributes chore: add .gitattributes 2024-08-04 18:52:14 -07:00
.gitignore feat(core): implement plugins 2024-08-22 20:08:02 -07:00
.pre-commit-config.yaml ci: remove crlf 2024-08-04 21:15:34 -07:00
CHANGELOG.md chore: bump version to v1.8.0 2024-08-26 14:53:16 -07:00
CODE_OF_CONDUCT.md docs: add code of conduct 2024-08-05 11:47:18 -07:00
CONTRIBUTING.md docs: update docstrings and small code fixes 2024-08-16 19:43:48 -07:00
LICENSE add details 2024-08-03 19:41:08 -07:00
README.md docs: update showcase image 2024-08-16 21:32:06 -07:00
SECURITY.md docs: update docstrings and small code fixes 2024-08-16 19:43:48 -07:00
build.bat edit favicon 2024-08-04 16:04:04 -07:00
build.sh build: add cross-platform build scripts 2024-08-04 19:04:02 -07:00
build_optimized.bat refactor: edit build scripts and add README mention 2024-08-13 20:10:06 -07:00
requirements.txt build(deps): update numpy requirement from <2.0.0 to <3.0.0 2024-08-25 11:13:25 +00:00
run.bat modify backend check logic 2024-08-04 09:12:07 -07:00
run.sh feat(conversion): add HF to GGUF conversion + refactor localization 2024-08-05 13:29:30 -07:00
setup.py feat(core): add update checking support 2024-08-18 13:30:45 -07:00

README.md

AutoGGUF-banner

AutoGGUF - automated GGUF model quantizer

GitHub release GitHub last commit CI/CD Status

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

GitHub stars GitHub forks GitHub release (latest by date) GitHub repo size

Code Style: Black Issues PRs Welcome

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

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

Usage

Cross-platform

  1. Install dependencies:
    pip install -r requirements.txt
    
  2. Run the application:
    python src/main.py
    
    or use the run.bat script.

Windows

Standard builds:

  1. Download the latest release
  2. Extract all files to a folder
  3. Run AutoGGUF-x64.exe

Setup builds:

  1. Download setup varient 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

Verifying Releases

Linux/macOS:

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

Windows (PowerShell):

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

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

# Check SHA256
$fileHash = (Get-FileHash -Algorithm SHA256 AutoGGUF-v1.5.0-Windows-avx2-prerel.zip).Hash.ToLower()
$storedHash = (Get-Content AutoGGUF-v1.5.0-prerel.sha256 | Select-String AutoGGUF-v1.5.0-Windows-avx2-prerel.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

build RELEASE | DEV

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

You can also use the slower build but faster executable script (Nuitka):

build_optimized RELEASE | DEV

Dependencies

Find them in requirements.txt.

Localizations

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

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).

Known Issues

  • None!

Planned Features

  • Time estimation for quantization
  • Actual progress bar tracking
  • Perplexity testing
  • Web API and management (partially implemented in v1.6.2)
  • Themes (added in v1.7.1)
  • Sleek UI menubar (added in v1.7.1)

Troubleshooting

  • 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)

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.

User Interface

AutoGGUF-v1 7 1-showcase-blue

Stargazers

Star History Chart