Skip to content

Commit 69c3963

Browse files
committed
update: readme, for better install
1 parent e160d35 commit 69c3963

File tree

1 file changed

+6
-1
lines changed

1 file changed

+6
-1
lines changed

README.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,21 +13,26 @@ Special thanks to the creators and contributors of [gemma.cpp](https://github.co
1313
## 🛠 Installation
1414

1515
```bash
16+
git clone https://github.com/namtranase/gemma-cpp-python.git
17+
git submodule update --init --recursive
1618
pip install -r requirements.txt
1719
pip install .
1820
```
1921

2022
## 🖥 Usage
2123

24+
To acctually run the model, you need to install the model followed on the [gemma.cpp](https://github.com/google/gemma.cpp?tab=readme-ov-file#step-1-obtain-model-weights-and-tokenizer-from-kaggle) repo
25+
2226
For usage examples, refer to tests/test_chat.py. Here's a quick start:
2327
```bash
2428
import pygemma
2529
pygemma.show_help()
2630
```
2731

32+
33+
2834
## 🤝 Contributing
2935
Contributions are welcome. Please clone the repository, push your changes to a new branch, and submit a pull request.
3036

3137
## License
3238
gemma-cpp-python is MIT licensed. See the LICENSE file for details.
33-

0 commit comments

Comments
 (0)