Skip to content

Commit e4cdb46

Browse files
committed
Update project README and PyPI information
1 parent 9803860 commit e4cdb46

File tree

3 files changed

+18
-35
lines changed

3 files changed

+18
-35
lines changed

LICENSE.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
MIT License
22

3-
Copyright (c) 2023 Andrei Betlen
3+
Copyright (c) 2023 Andrei Betlen [Original project author]
44

55
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
66

README.md

Lines changed: 12 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1,42 +1,32 @@
11
# Python bindings for [`ggml`](https://github.com/ggerganov/ggml)
22

3-
[![Documentation Status](https://readthedocs.org/projects/ggml-python/badge/?version=latest)](https://ggml-python.readthedocs.io/en/latest/?badge=latest)
4-
[![Tests](https://github.com/abetlen/ggml-python/actions/workflows/test.yaml/badge.svg)](https://github.com/abetlen/ggml-python/actions/workflows/test.yaml)
5-
[![PyPI](https://img.shields.io/pypi/v/ggml-python)](https://pypi.org/project/ggml-python/)
6-
[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/ggml-python)](https://pypi.org/project/ggml-python/)
7-
[![PyPI - License](https://img.shields.io/pypi/l/ggml-python)](https://pypi.org/project/ggml-python/)
8-
[![PyPI - Downloads](https://img.shields.io/pypi/dm/ggml-python)](https://pypi.org/project/ggml-python/)
3+
[![PyPI](https://img.shields.io/pypi/v/ggml-py)](https://pypi.org/project/ggml-py/)
4+
[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/ggml-py)](https://pypi.org/project/ggml-py/)
5+
[![PyPI - License](https://img.shields.io/pypi/l/ggml-py)](https://pypi.org/project/ggml-py/)
6+
[![PyPI - Downloads](https://img.shields.io/pypi/dm/ggml-py)](https://pypi.org/project/ggml-py/)
97

8+
> ℹ️ Note this is a fork of the [original project](https://github.com/abetlen/ggml-python) which hasn't been updated July 2024. There have been a number of CVE security patches for `ggml / llama.cpp` since that date. This fork updates `ggml` to the latest. [See the llama.cpp security page for more on this](https://github.com/ggml-org/llama.cpp/security).
109
1110
Python bindings for the [`ggml`](https://github.com/ggerganov/ggml) tensor library for machine learning.
1211

13-
> ⚠️ Neither this project nor `ggml` currently guarantee backwards-compatibility, if you are using this library in other applications I strongly recommend pinning to specific releases in your `requirements.txt` file.
14-
15-
# Documentation
16-
17-
- [Getting Started](https://ggml-python.readthedocs.io/en/latest/)
18-
- [API Reference](https://ggml-python.readthedocs.io/en/latest/api-reference/)
19-
- [Examples](https://github.com/abetlen/ggml-python/tree/main/examples)
20-
2112
# Installation
2213

23-
2414
Requirements
25-
- Python 3.8+
15+
- Python 3.10+
2616
- C compiler (gcc, clang, msvc, etc)
2717

28-
You can install `ggml-python` using `pip`:
18+
You can install `ggml-py` using `pip`:
2919

3020
```bash
31-
pip install ggml-python
21+
pip install ggml-py
3222
```
3323

3424
This will compile ggml using cmake which requires a c compiler installed on your system.
35-
To build ggml with specific features (ie. OpenBLAS, GPU Support, etc) you can pass specific cmake options through the `cmake.args` pip install configuration setting. For example to install ggml-python with cuBLAS support you can run:
25+
To build ggml with specific features (ie. OpenBLAS, GPU Support, etc) you can pass specific cmake options through the `cmake.args` pip install configuration setting. For example to install ggml-py with cuBLAS support you can run:
3626

3727
```bash
3828
pip install --upgrade pip
39-
pip install ggml-python --config-settings=cmake.args='-DGGML_CUDA=ON'
29+
pip install ggml-py --config-settings=cmake.args='-DGGML_CUDA=ON'
4030
```
4131

4232
## Options
@@ -89,10 +79,10 @@ ggml.ggml_free(ctx)
8979

9080
# Troubleshooting
9181

92-
If you are having trouble installing `ggml-python` or activating specific features please try to install it with the `--verbose` and `--no-cache-dir` flags to get more information about any issues:
82+
If you are having trouble installing `ggml-py` or activating specific features please try to install it with the `--verbose` and `--no-cache-dir` flags to get more information about any issues:
9383

9484
```bash
95-
pip install ggml-python --verbose --no-cache-dir --force-reinstall --upgrade
85+
pip install ggml-py --verbose --no-cache-dir --force-reinstall --upgrade
9686
```
9787

9888
# License

pyproject.toml

Lines changed: 5 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -3,24 +3,18 @@ requires = ["scikit-build-core[pyproject]>=0.5.1"]
33
build-backend = "scikit_build_core.build"
44

55
[project]
6-
name = "ggml_python"
6+
name = "ggml_py"
77
dynamic = ["version"]
8-
description = "Python bindings for ggml"
8+
description = "Python bindings for ggml. Fork of original project updating ggml to latest."
99
readme = "README.md"
1010
license = { text = "MIT" }
11-
authors = [
12-
{ name = "Andrei Betlen", email = "abetlen@gmail.com" },
13-
]
14-
requires-python = ">=3.7"
11+
requires-python = ">=3.10"
1512
dependencies = [
1613
"numpy>=1.20.0",
1714
"typing_extensions>=4.6.3",
18-
"importlib_resources>=6.4.0; python_version < '3.9'",
1915
]
2016
classifiers = [
2117
"Programming Language :: Python :: 3",
22-
"Programming Language :: Python :: 3.8",
23-
"Programming Language :: Python :: 3.9",
2418
"Programming Language :: Python :: 3.10",
2519
"Programming Language :: Python :: 3.11",
2620
"Programming Language :: Python :: 3.12",
@@ -56,6 +50,5 @@ convert = [
5650
]
5751

5852
[project.urls]
59-
Homepage = "https://github.com/abetlen/ggml-python"
60-
Documentation = "https://ggml-python.readthedocs.io/en/latest/"
61-
Issues = "https://github.com/abetlen/ggml-python/issues"
53+
Homepage = "https://github.com/neuml/ggml-python"
54+
Issues = "https://github.com/neuml/ggml-python/issues"

0 commit comments

Comments
 (0)