Skip to content

Commit e160d35

Browse files
committed
update: readme
1 parent 32159c4 commit e160d35

File tree

1 file changed

+27
-12
lines changed

1 file changed

+27
-12
lines changed

README.md

Lines changed: 27 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,33 @@
1-
# 📖 Python Bindings for [`gemma.cpp`](https://github.com/google/gemma.cpp)
1+
# gemma-cpp-python: Python Bindings for [gemma.cpp](https://github.com/google/gemma.cpp)
22

3-
## Installation
3+
**Latest Version: v0.1.0**
44

5-
Create conda environment
6-
```
7-
conda create -p ./env python=3.11 -y
8-
pip install -r requirements.txt
9-
```
5+
[![License: MIT](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE)
106

11-
Build the gemma package from source
12-
```
7+
`gemma-cpp-python` provides Python bindings for `gemma`, a high-performance C++ library, bridging advanced computational functionalities to Python.
8+
9+
## 🙏 Acknowledgments
10+
Special thanks to the creators and contributors of [gemma.cpp](https://github.com/google/gemma.cpp) for their foundational work.
11+
12+
13+
## 🛠 Installation
14+
15+
```bash
16+
pip install -r requirements.txt
1317
pip install .
1418
```
15-
Or install it
16-
```
17-
pip install gemma-cpp-python
19+
20+
## 🖥 Usage
21+
22+
For usage examples, refer to tests/test_chat.py. Here's a quick start:
23+
```bash
24+
import pygemma
25+
pygemma.show_help()
1826
```
27+
28+
## 🤝 Contributing
29+
Contributions are welcome. Please clone the repository, push your changes to a new branch, and submit a pull request.
30+
31+
## License
32+
gemma-cpp-python is MIT licensed. See the LICENSE file for details.
33+

0 commit comments

Comments
 (0)