Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/milvus-io/pymilvus
Python SDK for Milvus.
https://github.com/milvus-io/pymilvus
anns database hacktoberfest milvus python sdk vector
Last synced: 3 months ago
JSON representation
Python SDK for Milvus.
- Host: GitHub
- URL: https://github.com/milvus-io/pymilvus
- Owner: milvus-io
- License: apache-2.0
- Created: 2019-06-13T11:38:34.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2024-04-16T08:55:32.000Z (7 months ago)
- Last Synced: 2024-04-17T04:09:16.942Z (7 months ago)
- Topics: anns, database, hacktoberfest, milvus, python, sdk, vector
- Language: Python
- Homepage:
- Size: 5.34 MB
- Stars: 860
- Watchers: 17
- Forks: 286
- Open Issues: 228
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# Milvus Python SDK
[](https://pypi.org/project/pymilvus/)
[](https://pypi.org/project/pymilvus/)
[](https://pepy.tech/project/pymilvus)
[](https://pepy.tech/project/pymilvus)
[](https://pepy.tech/project/pymilvus)
[](https://github.com/milvus-io/pymilvus/blob/master/LICENSE)
[![Mergify Status][mergify-status]][mergify]
[mergify]: https://mergify.com
[mergify-status]: https://img.shields.io/endpoint.svg?url=https://api.mergify.com/v1/badges/milvus-io/pymilvus&style=flat
Python SDK for [Milvus](https://github.com/milvus-io/milvus). To contribute code to this project, please read our [contribution guidelines](https://github.com/milvus-io/milvus/blob/master/CONTRIBUTING.md) first. If you have some ideas or encounter a problem, you can find us in the Slack channel [#py-milvus](https://milvusio.slack.com/archives/C024XTWMT4L).
## Compatibility
The following collection shows Milvus versions and recommended PyMilvus versions:
|Milvus version| Recommended PyMilvus version |
|:-----:|:-----:|
| 1.0.\* | 1.0.1 |
| 1.1.\* | 1.1.2 |
| 2.0.\* | 2.0.2 |
| 2.1.\* | 2.1.3 |
| 2.2.\* | 2.2.15 |
| 2.3.\* | 2.3.7 |
| 2.4.\* | 2.4.4 |
## Installation
You can install PyMilvus via `pip` or `pip3` for Python 3.8+:
```shell
$ pip3 install pymilvus
$ pip3 install pymilvus[model] # for milvus-model
$ pip3 install pymilvus[bulk_writer] # for bulk_writer
```
You can install a specific version of PyMilvus by:
```shell
$ pip3 install pymilvus==2.4.4
```
You can upgrade PyMilvus to the latest version by:
```shell
$ pip3 install --upgrade pymilvus
```
## FAQ
Q1. How to get submodules?
A1. The following command will get the protos matching to the generated files, for protos of certain version, see
[milvus-proto](https://github.com/milvus-io/milvus-proto#usage) for details.
```shell
$ git submodule update --init
```
Q2. How to generate python files from milvus-proto?
A2.
```shell
$ make gen_proto
```
Q3. How to use the local PyMilvus repository for Milvus server?
A3.
```shell
$ make install
```
Q4. How to check coding styles?
A4.
```shell
make lint
```
Q5. How to fix the coding styles?
A5
```shell
make format
```
Q6. How to run unittests?
A6
```shell
$ pip install ".[dev]"
$ make unittest
```
Q7. `zsh: no matches found: pymilvus[model]`, how do I solve this?
A7
```shell
$ pip install "pymilvus[model]"
```
## Documentation
Documentation is available online: https://milvus.io/api-reference/pymilvus/v2.4.x/About.md
## Developing package releases
The commits on the development branch of each version will be packaged and uploaded to [Test PyPI](https://test.pypi.org/).
The package name generated by the development branch is x.y.z.rc, where is the number of commits that differ from the most recent release.
- For example, after the release of **2.3.4**, two commits were submitted on the 2.3 branch.
The version number of the latest commit of 2.3 branch is **2.3.5.rc2**.
- For example, after the release of **2.3.4**, 10 commits were submitted on the master branch.
The version number of the latest commit of master branch is **2.4.0.rc10**.
To install the package on Test PyPi, you need to append `--extra-index-url` after pip, for example:
```shell
$ python3 -m pip install --extra-index-url https://test.pypi.org/simple/ pymilvus==2.1.0.dev66
```
## License
[Apache License 2.0](LICENSE)