View gguf on Snyk Open Source Advisor

Package Health Score

87 / 100

security
No known security issues
popularity
Popular
maintenance
Healthy
community
Active

Explore Similar Packages

Popularity

Popular

GitHub Stars: 64.31K
Forks: 9.2K
Contributors: 470

Direct Usage Popularity

Based on project statistics from the GitHub repository for the PyPI package gguf, we found that it has been starred 64,313 times.

Security

No known security issues

Security and license risk for latest version

Release Date: Aug 23, 2024
Direct Vulnerabilities: 0
C
0
H
0
M
0
L
Indirect Vulnerabilities: 0
C
0
H
0
M
0
L
License Risk: 0
H
0
M
0
L

All security vulnerabilities belong to production dependencies of direct and indirect packages.

License

MIT

Security Policy

Yes

You can connect your project's repository to Snyk to stay up to date on security alerts and receive automatic fix pull requests.

Keep your project free of vulnerabilities with Snyk

Maintenance

Healthy

Commit Frequency

Open Issues: 309
Open PR: 268
Last Release: 27 days ago
Last Commit: 19 days ago

Further analysis of the maintenance status of gguf based on released PyPI versions cadence, the repository activity, and other data points determined that its maintenance is Healthy.

We found that gguf demonstrates a positive version release cadence with at least one new version released in the past 3 months.

As a healthy sign for on-going project maintenance, we found that the GitHub repository had at least 1 pull request or issue interacted with by the community.

Community

Active

Readme: Yes
Contributing.md: Yes
Code of Conduct: No
Contributors: 470
Funding: No

A good and healthy external contribution signal for gguf project, which invites more than one hundred open source maintainers to collaborate on the repository.

We found a way for you to contribute to the project! Looks like gguf is missing a Code of Conduct.

Embed Package Health Score Badge

Keep your project healthy

Check your requirements.txt

Ensure all the packages you're using are healthy and well-maintained

Snyk Vulnerability Scanner

Get health score & security insights directly in your IDE

Package

Python Versions Compatibility: >=3.8

Age: 1 year
Latest Release: 27 days ago
Dependencies: 0 Direct
Versions: 16
Maintainers: 1
Wheels: OS Independent

Readme

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.

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

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

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

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.

Bump the version in pyproject.toml.
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"

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:

Bump the version in pyproject.toml.
Build the package:

python -m build

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.

FAQs

What is gguf?

Read and write ML models in GGUF for GGML. Visit Snyk Advisor to see a full health score report for gguf, including popularity, security, maintenance & community analysis.

Is gguf popular?

The python package gguf receives a total of 20,855 weekly downloads. As such, gguf popularity was classified as a popular. Visit the popularity section on Snyk Advisor to see the full health analysis.

Is gguf well maintained?

We found that gguf demonstrated a healthy version release cadence and project activity. It has a community of 470 open source contributors collaborating on the project. See the full package health analysis to learn more about the package maintenance status.

Is gguf safe to use?

The python package gguf was scanned for known vulnerabilities and missing license, and no issues were found. Thus the package was deemed as safe to use. See the full health analysis review.

Last updated on 15 September-2024, at 17:05 (UTC).

Build a secure application checklist

Select a recommended open source package

Minimize your risk by selecting secure & well maintained open source packages

DONE

Scan your app for vulnerabilities

Scan your application to find vulnerabilities in your: source code, open source dependencies, containers and configuration files

SCAN NOW

Fix identified vulnerabilities

Easily fix your code by leveraging automatically generated PRs

AUTO FIX

Monitor for new issues

New vulnerabilities are discovered every day. Get notified if your application is affected

MONITOR APP

gguf

Read and write ML models in GGUF for GGML For more information about how to use this package see README

Ensure you're using the healthiest python packages

Package Health Score

Explore Similar Packages

Popularity

Direct Usage Popularity

Security

Security and license risk for latest version

Maintenance

Commit Frequency

Community

Embed Package Health Score Badge

Keep your project healthy

Check your requirements.txt

Snyk Vulnerability Scanner

Package

Readme

gguf

Installation

API Examples/Simple Tools

Development

Automatic publishing with CI

Manual publishing

Run Unit Tests

TODO

FAQs

What is gguf?

Is gguf popular?

Is gguf well maintained?

Is gguf safe to use?

Build a secure application checklist

Select a recommended open source package

Scan your app for vulnerabilities

Fix identified vulnerabilities

Monitor for new issues

Package Health Score

Explore Similar Packages

Direct Usage Popularity

Security and license risk for latest version

Commit Frequency

Embed Package Health Score Badge

Keep your project healthy

Check your requirements.txt

Snyk Vulnerability Scanner

Readme

gguf

Installation

API Examples/Simple Tools

Development

Automatic publishing with CI

Manual publishing

Run Unit Tests

TODO

FAQs

What is gguf?

Is gguf popular?

Is gguf well maintained?

Is gguf safe to use?

Build a secure application checklist

Select a recommended open source package

Scan your app for vulnerabilities

Source Code

Open Source

Container

Config

Fix identified vulnerabilities

Monitor for new issues