Installation

Installing via pip

PyMilvus-ORM is in the Python Package Index.

PyMilvus-ORM only support python3(>= 3.6), usually, it's ok to install PyMilvus-ORM like below.

$ python3 -m pip install pymilvus-orm==2.0.0rc2

Installing in a virtual environment

It's recommended to use PyMilvus-ORM in a virtual environment, using virtual environment allows you to avoid installing Python packages globally which could break system tools or other projects. We use virtualenv as an example to demonstrate how to install and using PyMilvus-ORM in a virtual environment. See virtualenv for more information about why and how.

$ python3 -m pip install virtualenv
$ virtualenv venv
$ source venv/bin/activate
(venv) $ pip install pymilvus-orm==2.0.0rc2

If you want to exit the virtualenv venv, you can use deactivate.

(venv) $ deactivate
$

Installing a specific PyMilvus-ORM version

Here we assume you are already in a virtual environment.

Suitable PyMilvus-ORM version depends on Milvus version you are using. See install pymilvus-orm for recommended pymilvus-orm version.

If you want to install a specific version of PyMilvus-ORM:

(venv) $ pip install pymilvus-orm==2.0.0rc2

If you want to upgrade PyMilvus-ORM into the latest version published:

(venv) $ pip install --upgrade pymilvus-orm

Installing from source

This will install the latest PyMilvus-ORM into your virtual environment.

(venv) $ pip install git+https://github.com/milvus-io/pymilvus-orm.git

Verifying installation

Your installation is correct if the following command in the Python shell doesn't raise an exception.

(venv) $ python -c "from pymilvus_orm import Milvus, DataType"