Skip to content

gguf-py : GGUF Editor GUI - Python + Qt #12930

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 26 commits into from
Apr 18, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
26 commits
Select commit Hold shift + click to select a range
70a566b
Committing gguf_editor_gui code
christopherthompson81 Apr 13, 2025
e6620de
Revising requirements file to align with existing requirements
christopherthompson81 Apr 13, 2025
ad1c90d
chore: Remove try-except block for gguf import
christopherthompson81 Apr 13, 2025
7f52f2f
Updating .gitignore
christopherthompson81 Apr 13, 2025
029314a
Implementing review changes
christopherthompson81 Apr 13, 2025
1d304c9
Addressing linting issues
christopherthompson81 Apr 13, 2025
04d81a8
Update gguf-py/gguf/scripts/gguf_editor_gui.py
christopherthompson81 Apr 13, 2025
2628695
Update gguf-py/gguf/scripts/gguf_editor_gui.py
christopherthompson81 Apr 13, 2025
1fa9067
Update gguf-py/gguf/scripts/gguf_editor_gui.py
christopherthompson81 Apr 13, 2025
0675b49
Update gguf-py/gguf/scripts/gguf_editor_gui.py
christopherthompson81 Apr 13, 2025
3f0f32c
Applying @CISC (Sigbjørn Skjæret)'s changes
christopherthompson81 Apr 13, 2025
9268041
Update requirements/requirements-gguf_editor_gui.txt
christopherthompson81 Apr 13, 2025
af8d354
Update gguf-py/gguf/scripts/gguf_editor_gui.py
christopherthompson81 Apr 13, 2025
cf0f6fc
Update gguf-py/gguf/scripts/gguf_editor_gui.py
christopherthompson81 Apr 13, 2025
b6df560
Update gguf-py/gguf/scripts/gguf_editor_gui.py
christopherthompson81 Apr 13, 2025
0349aa9
Update gguf-py/gguf/scripts/gguf_editor_gui.py
christopherthompson81 Apr 13, 2025
b021fd9
Update gguf-py/gguf/scripts/gguf_editor_gui.py
christopherthompson81 Apr 13, 2025
229da69
Update gguf-py/gguf/scripts/gguf_editor_gui.py
christopherthompson81 Apr 13, 2025
3423450
Update gguf-py/gguf/scripts/gguf_editor_gui.py
christopherthompson81 Apr 13, 2025
ad607a3
Filtering warnings during loading
christopherthompson81 Apr 13, 2025
bf1be33
Fixing linting issue
christopherthompson81 Apr 13, 2025
42bd4ff
Enabling an optional gui extra for installation
christopherthompson81 Apr 17, 2025
a1e2c5d
probably useful, but does not belong in this PR
CISC Apr 18, 2025
a7c9cd8
narrow down requirements
CISC Apr 18, 2025
dd18eab
add gguf editor gui requirements
CISC Apr 18, 2025
e821563
add gguf dependency
CISC Apr 18, 2025
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions gguf-py/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,11 @@ as an example for its usage.
pip install gguf
```

Optionally, you can install gguf with the extra 'gui' to enable the visual GGUF editor.
```sh
pip install gguf[gui]
```

## API Examples/Simple Tools

[examples/writer.py](https://github.com/ggml-org/llama.cpp/blob/master/gguf-py/examples/writer.py) — Generates `example.gguf` in the current directory to demonstrate generating a GGUF file. Note that this file cannot be used as a model.
Expand All @@ -25,6 +30,8 @@ pip install gguf

[gguf/scripts/gguf_new_metadata.py](https://github.com/ggml-org/llama.cpp/blob/master/gguf-py/gguf/scripts/gguf_new_metadata.py) — Copies a GGUF file with added/modified/removed metadata values.

[gguf/scripts/gguf_editor_gui.py](https://github.com/ggml-org/llama.cpp/blob/master/gguf-py/gguf/scripts/gguf_editor_gui.py) — Allows for viewing, editing, adding, or removing metadata values within a GGUF file as well as viewing its tensors with a Qt interface.

## Development
Maintainers who participate in development of this package are advised to install it in editable mode:

Expand Down
1 change: 1 addition & 0 deletions gguf-py/gguf/scripts/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -4,3 +4,4 @@
from .gguf_dump import main as gguf_dump_entrypoint
from .gguf_set_metadata import main as gguf_set_metadata_entrypoint
from .gguf_new_metadata import main as gguf_new_metadata_entrypoint
from .gguf_editor_gui import main as gguf_editor_gui_entrypoint
Loading