Second-Me/lpm_kernel/L2/gguf-py
wuyuxiangX ea86f26af3
Feature/cloud upgrade (#388)
* feat: Updated the cloud service model list and fixed the error message in the training process service

* cloud serive add

* add deployed_name

* add name,deploy model

* add model,name

* feat: Update cloud model deployment information, add deployment status and related parameters

* remove qwen2.5

* feat: Updated the model name to Qwen3, adjusted related configurations and default values

* refactor: simplify chat data processing and update model training configuration

* Qwen 3

* feat: Add cloud service status check function to optimize model status management

* chore: update API endpoints and file paths for local development environment

* feat: store complete training parameters in local storage

* Fix/cloud service stop (#384)

* fix cloud service stop

* add pending status

* feature: Added pause status polling function and updated cloud training stop logic

* Stop logic modification

* feature: Added cloud training pause status check function to optimize training process control

* fix stop

* feature: Add language parameter to support multi-language training configuration

* add Chinese language, fix top

---------

Co-authored-by: wyx-hhhh <1360479992@qq.com>

* feat: update originPrompt to simplify response structure and enhance clarity

* load error

---------

Co-authored-by: yanmuyuan <2216646664@qq.com>
Co-authored-by: doubleBlack2 <108928143+doubleBlack2@users.noreply.github.com>
2025-06-23 14:21:23 +08:00
..
examples Initial commit 2025-03-20 00:37:54 +08:00
gguf Feature/cloud upgrade (#388) 2025-06-23 14:21:23 +08:00
tests Initial commit 2025-03-20 00:37:54 +08:00
LICENSE Initial commit 2025-03-20 00:37:54 +08:00
pyproject.toml Initial commit 2025-03-20 00:37:54 +08:00
README.md Initial commit 2025-03-20 00:37:54 +08:00

gguf

This is a Python package for writing binary files in the GGUF (GGML Universal File) format.

See convert_hf_to_gguf.py as an example for its usage.

Installation

pip install gguf

API Examples/Simple Tools

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.

examples/reader.py — Extracts and displays key-value pairs and tensor details from a GGUF file in a readable format.

gguf/scripts/gguf_dump.py — Dumps a GGUF file's metadata to the console.

gguf/scripts/gguf_set_metadata.py — Allows changing simple metadata values in a GGUF file by key.

gguf/scripts/gguf_convert_endian.py — Allows converting the endianness of GGUF files.

gguf/scripts/gguf_new_metadata.py — Copies a GGUF file with added/modified/removed metadata values.

Development

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

cd /path/to/llama.cpp/gguf-py

pip install --editable .

Note: This may require to upgrade your Pip installation, with a message saying that editable installation currently requires setup.py. In this case, upgrade Pip to the latest:

pip install --upgrade pip

Automatic publishing with CI

There's a GitHub workflow to make a release automatically upon creation of tags in a specified format.

  1. Bump the version in pyproject.toml.
  2. Create a tag named gguf-vx.x.x where x.x.x is the semantic version number.
git tag -a gguf-v1.0.0 -m "Version 1.0 release"
  1. Push the tags.
git push origin --tags

Manual publishing

If you want to publish the package manually for any reason, you need to have twine and build installed:

pip install build twine

Then, follow these steps to release a new version:

  1. Bump the version in pyproject.toml.
  2. Build the package:
python -m build
  1. Upload the generated distribution archives:
python -m twine upload dist/*

Run Unit Tests

From root of this repository you can run this command to run all the unit tests

python -m unittest discover ./gguf-py -v

TODO

  • Include conversion scripts as command line entry points in this package.