https://github.com/vearch/vearch-python
Python sdk for vearch
https://github.com/vearch/vearch-python
deep-learning local-development python-sdk real-time-index vector-search
Last synced: about 2 months ago
JSON representation
Python sdk for vearch
- Host: GitHub
- URL: https://github.com/vearch/vearch-python
- Owner: vearch
- License: other
- Created: 2020-03-19T08:27:15.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2022-03-18T07:23:23.000Z (over 3 years ago)
- Last Synced: 2025-05-09T00:39:24.733Z (about 2 months ago)
- Topics: deep-learning, local-development, python-sdk, real-time-index, vector-search
- Language: Python
- Homepage:
- Size: 59.6 KB
- Stars: 8
- Watchers: 6
- Forks: 6
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Gamma Python SDK
gamma python sdk and python wheel packages.
## Overview
This repository shows gamma python sdk and provides scripts to create wheel
packages for the gamma library.
[python sdk api](./docs/APIPythonSDK.md) is the document of python sdk api.
Files in directory of python shows how the python sdk encapsulate gamma.
setup.py is written for creating wheel packages for gamma.
Of course, pip install vearch is the easiest way to use this python sdk. And
this repository helps to build your custom python sdk.
## Building source package
if thers is a custom built gamma library in the system, build source package
for the best performance.
### Prerequisite
You can build it with docker image: pypywheels/manylinux2010-pypy_x86_64:latest
auditwheel tool should be installed firstly. You can install it by pip.
The package can be built when gamma is already built and installed.
See the official [gamma installation
instruction](https://github.com/vearch/gamma/blob/master/README.md) for more
on how to build and install gamma. In particular, compiling wheel packages
requires additional compilation options in compiling gamma.
```bash
git clone https://github.com/vearch/vearch-python.git
git submodule init
git submodule update
cd gamma
mkdir build && cd build
cmake -DCMAKE_BUILD_TYPE=Release -DPERFORMANCE_TESTING=ON ..
make
sh build-wheels.sh
sh install-vearch.sh
```
Then the whl file will be generated into the wheelhouse directory.
For building wheel packages, swig 3.0.12 or later needs to be avaiable.
### Linux
In linux, `auditwheel` is used for creating python wheel packages ocntains
precompiled binary extensions.
Header locations and link flags can be customized by `GAMMA_INCLUDE` and
`GAMMA_LDFLAGS` environment variables for building wheel packages.
Windows and OSX are not supported yet.