Skip to content

Commit 6356fcd

Browse files
committed
update: install files and readme
1 parent 7caeca1 commit 6356fcd

File tree

6 files changed

+233
-1
lines changed

6 files changed

+233
-1
lines changed

.gitignore

Lines changed: 160 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,160 @@
1+
# Byte-compiled / optimized / DLL files
2+
__pycache__/
3+
*.py[cod]
4+
*$py.class
5+
6+
# C extensions
7+
*.so
8+
9+
# Distribution / packaging
10+
.Python
11+
build/
12+
develop-eggs/
13+
dist/
14+
downloads/
15+
eggs/
16+
.eggs/
17+
lib/
18+
lib64/
19+
parts/
20+
sdist/
21+
var/
22+
wheels/
23+
share/python-wheels/
24+
*.egg-info/
25+
.installed.cfg
26+
*.egg
27+
MANIFEST
28+
29+
# PyInstaller
30+
# Usually these files are written by a python script from a template
31+
# before PyInstaller builds the exe, so as to inject date/other infos into it.
32+
*.manifest
33+
*.spec
34+
35+
# Installer logs
36+
pip-log.txt
37+
pip-delete-this-directory.txt
38+
39+
# Unit test / coverage reports
40+
htmlcov/
41+
.tox/
42+
.nox/
43+
.coverage
44+
.coverage.*
45+
.cache
46+
nosetests.xml
47+
coverage.xml
48+
*.cover
49+
*.py,cover
50+
.hypothesis/
51+
.pytest_cache/
52+
cover/
53+
54+
# Translations
55+
*.mo
56+
*.pot
57+
58+
# Django stuff:
59+
*.log
60+
local_settings.py
61+
db.sqlite3
62+
db.sqlite3-journal
63+
64+
# Flask stuff:
65+
instance/
66+
.webassets-cache
67+
68+
# Scrapy stuff:
69+
.scrapy
70+
71+
# Sphinx documentation
72+
docs/_build/
73+
74+
# PyBuilder
75+
.pybuilder/
76+
target/
77+
78+
# Jupyter Notebook
79+
.ipynb_checkpoints
80+
81+
# IPython
82+
profile_default/
83+
ipython_config.py
84+
85+
# pyenv
86+
# For a library or package, you might want to ignore these files since the code is
87+
# intended to run in multiple environments; otherwise, check them in:
88+
# .python-version
89+
90+
# pipenv
91+
# According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
92+
# However, in case of collaboration, if having platform-specific dependencies or dependencies
93+
# having no cross-platform support, pipenv may install dependencies that don't work, or not
94+
# install all needed dependencies.
95+
#Pipfile.lock
96+
97+
# poetry
98+
# Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
99+
# This is especially recommended for binary packages to ensure reproducibility, and is more
100+
# commonly ignored for libraries.
101+
# https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
102+
#poetry.lock
103+
104+
# pdm
105+
# Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
106+
#pdm.lock
107+
# pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
108+
# in version control.
109+
# https://pdm.fming.dev/#use-with-ide
110+
.pdm.toml
111+
112+
# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
113+
__pypackages__/
114+
115+
# Celery stuff
116+
celerybeat-schedule
117+
celerybeat.pid
118+
119+
# SageMath parsed files
120+
*.sage.py
121+
122+
# Environments
123+
.env
124+
.venv
125+
env/
126+
venv/
127+
ENV/
128+
env.bak/
129+
venv.bak/
130+
131+
# Spyder project settings
132+
.spyderproject
133+
.spyproject
134+
135+
# Rope project settings
136+
.ropeproject
137+
138+
# mkdocs documentation
139+
/site
140+
141+
# mypy
142+
.mypy_cache/
143+
.dmypy.json
144+
dmypy.json
145+
146+
# Pyre type checker
147+
.pyre/
148+
149+
# pytype static type analyzer
150+
.pytype/
151+
152+
# Cython debug symbols
153+
cython_debug/
154+
155+
# PyCharm
156+
# JetBrains specific template is maintained in a separate JetBrains.gitignore that can
157+
# be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
158+
# and can be added to the global gitignore or merged into this file. For a more nuclear
159+
# option (not recommended) you can uncomment the following to ignore the entire idea folder.
160+
#.idea/

CMakeLists.txt

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# Previous content...
2+
3+
# Fetch pybind11
4+
FetchContent_Declare(
5+
pybind11
6+
GIT_REPOSITORY https://github.com/pybind/pybind11.git
7+
GIT_TAG v2.6.1 # Use the latest version or the version you prefer
8+
)
9+
FetchContent_MakeAvailable(pybind11)
10+
11+
# Pybind11 module
12+
pybind11_add_module(gemma_bindings bindings.cc)
13+
target_link_libraries(gemma_bindings PRIVATE libgemma)

README.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
# 📖 Python Bindings for [`gemma.cpp`](https://github.com/google/gemma.cpp)
2+
13
## Installation
24

35
Create conda environment
@@ -8,7 +10,7 @@ pip install -r requirements.txt
810

911
Build the gemma package from source
1012
```
11-
pip install -e .
13+
pip install .
1214
```
1315
Or install it
1416
```

pyproject.toml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
[build-system]
2+
requires = ["setuptools", "wheel", "pybind11"]
3+
build-backend = "setuptools.build_meta"

setup.py

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
from setuptools import setup, Extension, find_packages
2+
from setuptools.command.build_ext import build_ext
3+
import pybind11
4+
5+
6+
class CustomBuildExt(build_ext):
7+
def build_extensions(self):
8+
# Customize the build process here if needed
9+
build_ext.build_extensions(self)
10+
11+
# Include the pybind11 include directory
12+
pybind11_include_dir = pybind11.get_include()
13+
14+
ext_modules = [
15+
Extension(
16+
'gemma_cpp_extension', # Name of the module to import in Python
17+
['src/binding.cc', 'vendor/gemma.cpp/gemma.cc', 'vendor/gemma.cpp/run.cc'], # Source files
18+
include_dirs=[pybind11_include_dir, './src/include', './vendor/gemma.cpp/compression', './vendor/gemma.cpp/util'], # Include directories
19+
language='c++',
20+
extra_compile_args=['-std=c++11'], # Replace with your required C++ version
21+
),
22+
]
23+
24+
setup(
25+
name='gemma-cpp-python',
26+
version='0.1.0',
27+
author='Nam Tran',
28+
author_email='trannam.ase@gmail.com',
29+
description='A Python wrapper for the GEMMA C++ library',
30+
long_description=open('README.md').read(),
31+
long_description_content_type='text/markdown',
32+
packages=find_packages(),
33+
ext_modules=ext_modules,
34+
cmdclass={
35+
'build_ext': CustomBuildExt,
36+
},
37+
# Add all other necessary package metadata
38+
install_requires=[
39+
'pybind11>=2.6',
40+
],
41+
)

src/binding.cc

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
#include <pybind11/pybind11.h>
2+
3+
// #include "vendor/gemma.cpp/gemma.h"
4+
5+
namespace py = pybind11;
6+
7+
PYBIND11_MODULE(gemma_bindings, m)
8+
{
9+
m.doc() = "Python bindings for the GEMMA library";
10+
11+
// Expose classes and functions here, for example:
12+
// m.def("function_name", &function_name, "A function from the gemma library.");
13+
}

0 commit comments

Comments
 (0)