Skip to content

Commit aff9d10

Browse files
gguf-py : GGUF Editor GUI - Python + Qt6 (#12930)
1 parent 35370ba commit aff9d10

File tree

6 files changed

+1629
-1
lines changed

6 files changed

+1629
-1
lines changed

gguf-py/README.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,11 @@ as an example for its usage.
1111
pip install gguf
1212
```
1313

14+
Optionally, you can install gguf with the extra 'gui' to enable the visual GGUF editor.
15+
```sh
16+
pip install gguf[gui]
17+
```
18+
1419
## API Examples/Simple Tools
1520

1621
[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.
@@ -25,6 +30,8 @@ pip install gguf
2530

2631
[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.
2732

33+
[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.
34+
2835
## Development
2936
Maintainers who participate in development of this package are advised to install it in editable mode:
3037

gguf-py/gguf/scripts/__init__.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,3 +4,4 @@
44
from .gguf_dump import main as gguf_dump_entrypoint
55
from .gguf_set_metadata import main as gguf_set_metadata_entrypoint
66
from .gguf_new_metadata import main as gguf_new_metadata_entrypoint
7+
from .gguf_editor_gui import main as gguf_editor_gui_entrypoint

0 commit comments

Comments
 (0)