Skip to main content

Milvus Python SDK

version Supported Python Versions Downloads Downloads Downloads

license Static Badge

Python SDK for Milvus. To contribute code to this project, please read our contribution guidelines first. If you have some ideas or encounter a problem, you can find us in the Slack channel #py-milvus.

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.X
2.5.* 2.5.X
2.6.* 2.6.X

Installation

You can install PyMilvus via pip or pip3 for Python 3.9+:

$ 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:

$ pip3 install pymilvus==2.4.10

You can upgrade PyMilvus to the latest version by:

$ pip3 install --upgrade pymilvus

FAQ

Local development commands use uv. Install uv before running the make targets below.

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 for details.

$ git submodule update --init

Q2. How to generate python files from milvus-proto?

A2.

$ make gen_proto

Q3. How to use the local PyMilvus repository for Milvus server?

A3.

$ make install

Q4. How to check and auto-fix the coding styles?

A4.

make lint
make format

Q5. How to set up pre-commit hooks to automatically check and fix the coding styles?

Once installed, the hooks will automatically run make format and make lint before each commit. If the checks fail, the commit will be aborted, and you'll need to fix the issues before committing again.

A5. Pre-commit hooks help ensure code quality by automatically running linting and formatting checks before each commit.

# Install pre-commit (if not already installed)
$ uv tool install pre-commit

# Install the git hook scripts
$ pre-commit install

Q7. How to run the maintained test suites?

A7

$ uv sync --group dev
$ make unittest
$ make integration-lite

Q8. zsh: no matches found: pymilvus[model], how do I solve this?

A8

$ pip install "pymilvus[model]"

Documentation

Documentation is available online: https://milvus.io/api-reference/pymilvus/v2.6.x/About.md

Developing package releases

The commits on the development branch of each version will be packaged and uploaded to Test PyPI.

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:

$ python3 -m pip install --extra-index-url https://test.pypi.org/simple/ pymilvus==2.1.0.dev66

License

Apache License 2.0

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pymilvus-3.0.2.tar.gz (376.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

pymilvus-3.0.2-py3-none-any.whl (417.7 kB view details)

Uploaded Python 3

File details

Details for the file pymilvus-3.0.2.tar.gz.

File metadata

  • Download URL: pymilvus-3.0.2.tar.gz
  • Upload date:
  • Size: 376.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.9.21 {"installer":{"name":"uv","version":"0.9.21","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for pymilvus-3.0.2.tar.gz
Algorithm Hash digest
SHA256 607ac1bcc96719c1716e0027d4a59c6411ad783fb934cbe0618b6d6c0831550d
MD5 c32b13d8660100ac663ff5f981f406db
BLAKE2b-256 bb272707d1dba764495f3d54ae75a28e07f9e6090da224598df3551153ce07f2

See more details on using hashes here.

File details

Details for the file pymilvus-3.0.2-py3-none-any.whl.

File metadata

  • Download URL: pymilvus-3.0.2-py3-none-any.whl
  • Upload date:
  • Size: 417.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.9.21 {"installer":{"name":"uv","version":"0.9.21","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for pymilvus-3.0.2-py3-none-any.whl
Algorithm Hash digest
SHA256 0ec7ca3a7d24d2ce13b2610c577f0978b08f461176222ea4dc1440375efc1cea
MD5 817e7b0e5aa37a61cfbcf0fa216c91e1
BLAKE2b-256 88767155ce419d3a4525571b27e317c80b2f69b874ce75bdecfb9ffe3fe3b6ab

See more details on using hashes here.

Release history Release notifications | RSS feed

This release

3.0.2 This release

2 files

3.0.1

2 files

3.0.0

1 file

2.6.17

2 files

2.6.16

2 files

2.6.15

2 files

2.6.14

2 files

2.6.13

2 files

2.6.12

2 files

2.6.11

2 files

2.6.10

2 files

2.6.9

2 files

2.6.8

2 files

2.6.7

2 files

2.6.6

2 files

2.6.5

2 files

2.6.4

2 files

2.6.3

2 files

2.6.2

2 files

2.6.1

2 files

2.6.0

2 files

2.5.18

2 files

2.5.17

2 files

2.5.16

2 files

2.5.15

2 files

2.5.14

2 files

2.5.13

2 files

2.5.12

2 files

2.5.11

2 files

2.5.10

2 files

2.5.9

2 files

2.5.8

2 files

2.5.7

2 files

2.5.6

2 files

2.5.5

2 files

2.5.4

2 files

2.5.3

2 files

2.5.2

2 files

2.5.1

2 files

2.5.0

2 files

2.4.15

2 files

2.4.14

2 files

2.4.13

2 files

2.4.12

2 files

2.4.11

2 files

2.4.10

2 files

2.4.9

2 files

2.4.8

2 files

2.4.7

2 files

2.4.6

2 files

2.4.5

2 files

2.4.4

2 files

2.4.3

2 files

2.4.2

2 files

2.4.1

2 files

2.4.0

2 files

2.3.8

2 files

2.3.7

2 files

2.3.6

2 files

2.3.5

2 files

2.3.4

2 files

2.3.3

3 files

2.3.2

2 files

2.3.1

2 files

2.3.0

2 files

2.2.17

2 files

2.2.16

2 files

2.2.15

2 files

2.2.14

2 files

2.2.13

2 files

2.2.12

2 files

2.2.11

2 files

2.2.9

2 files

2.2.8

2 files

2.2.7

2 files

2.2.6

2 files

2.2.5

2 files

2.2.4

2 files

2.2.3

2 files

2.2.2

2 files

2.2.1

2 files

2.2.0

2 files

2.1.3

2 files

2.1.2

2 files

2.1.1

2 files

2.1.0

2 files

2.0.2

2 files

2.0.1

2 files

2.0.0

2 files

1.1.2

2 files

1.1.1

2 files

1.1.0

2 files

1.0.1

2 files

1.0.0

3 files

0.4.0

2 files

0.3.0

2 files

0.2.15

3 files

0.2.14

3 files

0.2.13

2 files

0.2.12

2 files

0.2.11

2 files

0.2.10

2 files

0.2.9

2 files

0.2.8

2 files

0.2.7

2 files

0.2.6

2 files

0.2.5

3 files

0.2.4

2 files

0.2.3

2 files

0.2.2

2 files

0.2.1

2 files

0.2.0

2 files

0.1.25

2 files

0.1.24

1 file

0.1.23

1 file

0.1.22

1 file

0.1.21

1 file

0.1.20

1 file

0.1.19

1 file

0.1.18

1 file

0.1.17

1 file

0.1.16

1 file

0.1.15

1 file

0.1.14

1 file

0.1.13

1 file

0.1.12

1 file

0.1.11

1 file

0.1.10

1 file

0.1.9

1 file

0.1.8

1 file

0.1.7

1 file

0.1.6

2 files

0.1.5

2 files

0.1.4

1 file

0.1.3

1 file

0.1.2

1 file

0.1.1

1 file

0.1.0

1 file

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page