Python Sdk for Milvus; Alpha version
Project description
Milvus Python SDK -- pymilvus
Using Milvus python sdk for Milvus Download
Pymilvus only supports python >= 3.4
, is fully tested under 3.4, 3.5, 3.6, 3.7.
Pymilvus can be downloaded via pip
. If no use, try pip3
$ pip install pymilvus
Different versions of Milvus and lowest/highest pymilvus version supported accordingly
Milvus version | Lowest pymilvus version supported | Highest pymivus version supported |
---|---|---|
0.3.0 | - | 0.1.13 |
0.3.1 | 0.1.14 | 0.1.25 |
0.4.0 | 0.2.0 | - |
You can download a specific version by:
$ pip install pymilvus==0.1.13
If you want to upgrade pymilvus
to newest version
$ pip install --upgrade pymilvus
Import
from milvus import Milvus, IndexType, Status
Getting started
Initial a Milvus
instance and connect
to the sever
>>> milvus = Milvus()
>>> milvus.connect(host='SERVER-HOST', port='SERVER-PORT')
Status(code=0, message="Success")
Once successfully connected, you can get the version of server
>>> milvus.server_version()
(Status(code=0, message='Success'), 0.3.1) # this is example version, the real version may vary
Add a new table
First set param
>>> param = {'table_name':'test01', 'dimension':256, 'index_type':IndexType.FLAT, 'store_raw_vector':False}
Then create table
>>> milvus.create_table(param)
Status(message='Table test01 created!', code=0)
Describe the table we just created
>>> milvus.describe_table('test01')
(Status(code=0, message='Success!'), TableSchema(table_name='test01',dimension=256, index_type=<IndexType: FLAT>, store_raw_vector=False))
Add vectors into table test01
First create 20 vectors of 256-dimension.
- Note that
random
andpprint
we used here is for creating fake vectors data and pretty print, you may not need them in your project
>>> import random
>>> from pprint import pprint
>>> dim = 256 # Dimension of the vector
# Initialize 20 vectors of 256-dimension
>>> fake_vectors = [[random.random() for _ in range(dim)] for _ in range(20)]
Then add vectors into table test01
>>> status, ids = milvus.add_vectors(table_name='test01', records=vectors)
>>> print(status)
Status(code=0, message='Success')
>>> pprint(ids) # List of ids returned
23455321135511233
12245748929023489
...
Search vectors
# create 5 vectors of 256-dimension
>>> q_records = [[random.random() for _ in range(dim)] for _ in range(5)]
Then get results
>>> status, results = milvus.search_vectors(table_name='test01', query_records=q_records, top_k=10)
>>> print(status)
Status(code=0, message='Success')
>>> pprint(results) # Searched top_k vectors
Delet the table we just created
>>> milvus.delete_table(table_name='test01')
Status(code=0, message='Success')
Disconnect with the server
>>> milvus.disconnect()
Status(code=0, message='Success')
Example python
There are some small examples in examples/
, you can find more guide there.
Build docs
$ sphinx-build -b html doc/en/ doc/en/build
If you encounter any problems or bugs, please open new issues
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for pymilvus_test-0.2.8-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | fd62e666c7e951411d6c3f702385571d0077d57e67709e96c4331bd0b8ee428f |
|
MD5 | 51a9230d5fa44bb55ad9c32ef9d93a6a |
|
BLAKE2b-256 | bbd28e513fc46780b3f1923c9aa6491e143d57578250eca4f2bf67acfffe851e |