Skip to content

Commit

Permalink
Update README (#439)
Browse files Browse the repository at this point in the history 
Signed-off-by: yinghao.zou <[email protected]>
  • Loading branch information
@BossZou
BossZou authored Mar 8, 2021
1 parent db3c168 commit d75e489
Show file tree
Hide file tree
Showing 3 changed files with 19 additions and 278 deletions.
5 changes: 4 additions & 1 deletion CHANGELOG.md
View file
Original file line number Diff line number Diff line change
@@ -1,4 +1,7 @@
# pymilvus 1.0.x(TBD)
# pymilvus 1.0.1(2021-03-08)

## New Feature
- \436 Update Pymilvus v1.0.x documentation frame

## New Feature
- \#436 - Update PyMilvus v1.0.x documentation
Expand Down
290 changes: 14 additions & 276 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -9,304 +9,42 @@

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.

For detailed SDK documentation, refer to [API Documentation](https://milvus-io.github.io/milvus-sdk-python/pythondoc/v0.2.14/index.html).

## Compatibility
The following collection shows Milvus versions and recommended PyMilvus versions:

<!-- TOC -->

- [New features](#new-features)
- [Get started](#get-started)
- [Prerequisites](#prerequisites)
- [Install pymilvus](#install-pymilvus)
- [Examples](#examples)
- [Basic operations](#basic-operations)
- [Connect to the Milvus server](#connect-to-the-milvus-server)
- [Create/Drop collections](#createdrop-collections)
- [Create a collection](#create-a-collection)
- [Drop a collection](#drop-a-collection)
- [Create/Drop partitions in a collection](#createdrop-partitions-in-a-collection)
- [Create a partition](#create-a-partition)
- [Drop a partition](#drop-a-partition)
- [Create/Drop indexes in a collection](#createdrop-indexes-in-a-collection)
- [Create an index](#create-an-index)
- [Drop an index](#drop-an-index)
- [Insert/Delete vectors in collections/partitions](#insertdelete-vectors-in-collectionspartitions)
- [Insert vectors in a collection](#insert-vectors-in-a-collection)
- [Insert vectors in a partition](#insert-vectors-in-a-partition)
- [Delete vectors by ID](#delete-vectors-by-id)
- [Flush data in one or multiple collections to disk](#flush-data-in-one-or-multiple-collections-to-disk)
- [Compact all segments in a collection](#compact-all-segments-in-a-collection)
- [Search vectors in collections/partitions](#search-vectors-in-collectionspartitions)
- [Search vectors in a collection](#search-vectors-in-a-collection)
- [Search vectors in a partition](#search-vectors-in-a-partition)
- [Disconnect from the Milvus server](#disconnect-from-the-milvus-server)
- [FAQ](#faq)

<!-- /TOC -->

## Get started

### Prerequisites
|Milvus version| Recommended PyMilvus version |
|:-----:|:-----:|
| 1.0.0 | 1.0.1 |

pymilvus only supports Python 3.6 or higher.

### Install pymilvus
## Installation

You can install pymilvus via `pip` or `pip3` for Python3:
You can install PyMilvus via `pip` or `pip3` for Python 3.6+:

```shell
$ pip3 install pymilvus
```

The following collection shows Milvus versions and recommended pymilvus versions:

|Milvus version| Recommended pymilvus version |
|:-----:|:-----:|
| 1.0.x | 1.0.0 |


You can install a specific version of pymilvus by:
You can install a specific version of PyMilvus by:

```shell
$ pip install pymilvus==0.4.0
$ pip install pymilvus==1.0.1
```

You can upgrade `pymilvus` to the latest version by:
You can upgrade PyMilvus to the latest version by:

```shell
$ pip install --upgrade pymilvus
```

### Examples

Refer to [examples](/examples) for more example programs.

## Basic operations

## Connect to the Milvus server

1. Import pymilvus.

```python
# Import pymilvus
>>> from milvus import Milvus, IndexType, MetricType, Status
```

2. Create a client to Milvus server by using one of the following methods:

```python
# Connect to Milvus server
>>> client = Milvus(host='localhost', port='19530')
```

> Note: In the above code, default values are used for `host` and `port` parameters. Feel free to change them to the IP address and port you set for Milvus server.
```python
>>> client = Milvus(uri='tcp://localhost:19530')
```

## Create/Drop collections

### Create a collection

1. Prepare collection parameters.

```python
# Prepare collection parameters
>>> param = {'collection_name':'test01', 'dimension':128, 'index_file_size':1024, 'metric_type':MetricType.L2}
```

2. Create collection `test01` with dimension size as 128, size of the data file for Milvus to automatically create indexes as 1024, and metric type as Euclidean distance (L2).

```python
# Create a collection
>>> status = client.create_collection(param)
>>> status
Status(code=0, message='Create collection successfully!')
```

### Drop a collection

```python
# Drop collection
>>> status = client.drop_collection(collection_name='test01')
>>> status
Status(code=0, message='Delete collection successfully!')
```

## Create/Drop partitions in a collection

### Create a partition

You can split collections into partitions by partition tags for improved search performance. Each partition is also a collection.

```python
# Create partition
>>> status = client.create_partition(collection_name='test01', partition_tag='tag01')
>>> status
Status(code=0, message='OK')
```

Use `list_partitions()` to verify whether the partition is created.

```python
# Show partitions
>>> status, partitions = client.list_partitions(collection_name='test01')
>>> partitions
[(collection_name='test01', tag='_default'), (collection_name='test01', tag='tag01')]
```

### Drop a partition

```python
>>> status = client.drop_partition(collection_name='test01', partition_tag='tag01')
Status(code=0, message='OK')
```

## Create/Drop indexes in a collection

### Create an index

> Note: In production, it is recommended to create indexes before inserting vectors into the collection. Index is automatically built when vectors are being imported. However, you need to create the same index again after the vector insertion process is completed because some data files may not meet the `index_file_size` and index will not be automatically built for these data files.
1. Prepare index parameters. The following command uses `IVF_FLAT` index type as an example.

```python
# Prepare index param
>>> ivf_param = {'nlist': 4096}
```

2. Create an index for the collection.

```python
# Create index
>>> status = client.create_index('test01', IndexType.IVF_FLAT, ivf_param)
Status(code=0, message='Build index successfully!')
```

### Drop an index
## Documentation

```python
>>> status = client.drop_index('test01')
Status(code=0, message='OK')
```

## Insert/Delete vectors in collections/partitions

### Insert vectors in a collection

1. Generate 20 vectors of 128 dimension.

```python
>>> import random
>>> dim = 128
# Generate 20 vectors of 128 dimension
>>> vectors = [[random.random() for _ in range(dim)] for _ in range(20)]
```

2. Insert the list of vectors. If you do not specify vector ids, Milvus automatically generates IDs for the vectors.

```python
# Insert vectors
>>> status, inserted_vector_ids = client.insert(collection_name='test01', records=vectors)
>>> inserted_vector_ids
[1592028661511657000, 1592028661511657001, 1592028661511657002, 1592028661511657003, 1592028661511657004, 1592028661511657005, 1592028661511657006, 1592028661511657007, 1592028661511657008, 1592028661511657009, 1592028661511657010, 1592028661511657011, 1592028661511657012, 1592028661511657013, 1592028661511657014, 1592028661511657015, 1592028661511657016, 1592028661511657017, 1592028661511657018, 1592028661511657019]
```

Alternatively, you can also provide user-defined vector ids:

```python
>>> vector_ids = [id for id in range(20)]
>>> status, inserted_vector_ids = client.insert(collection_name='test01', records=vectors, ids=vector_ids)
```

### Insert vectors in a partition

```python
>>> status, inserted_vector_ids = client.insert('test01', vectors, partition_tag="tag01")
```

To verify the vectors you have inserted, use `get_vector_by_id()`. Assume you have vector with the following ID.

```python
>>> status, vector = client.get_entity_by_id(collection_name='test01', ids=inserted_vector_ids[:10])
```

### Delete vectors by ID

You can delete these vectors by:

```python
>>> status = client.delete_entity_by_id('test01', inserted_vector_ids[:10])
>>> status
Status(code=0, message='OK')
```

## Flush data in one or multiple collections to disk

When performing operations related to data changes, you can flush the data from memory to disk to avoid possible data loss. Milvus also supports automatic flushing, which runs at a fixed interval to flush the data in all collections to disk. You can use the [Milvus server configuration file](https://milvus.io/docs/reference/milvus_config.md) to set the interval.

```python
>>> status = client.flush(['test01'])
>>> status
Status(code=0, message='OK')
```

## Compact all segments in a collection

A segment is a data file that Milvus automatically creates by merging inserted vector data. A collection can contain multiple segments. If some vectors are deleted from a segment, the space taken by the deleted vectors cannot be released automatically. You can compact segments in a collection to release space.

```python
>>> status = client.compact(collection_name='test01')
>>> status
Status(code=0, message='OK')
```

## Search vectors in collections/partitions

### Search vectors in a collection

1. Prepare search parameters.

```python
>>> search_param = {'nprobe': 16}
```

2. Search vectors.

```python
# create 5 vectors of 32-dimension
>>> q_records = [[random.random() for _ in range(dim)] for _ in range(5)]
# search vectors
>>> status, results = client.search(collection_name='test01', query_records=q_records, top_k=2, params=search_param)
>>> results
[
[(id:1592028661511657012, distance:19.450458526611328), (id:1592028661511657017, distance:20.13418197631836)],
[(id:1592028661511657012, distance:19.12230682373047), (id:1592028661511657018, distance:20.221458435058594)],
[(id:1592028661511657014, distance:20.423980712890625), (id:1592028661511657016, distance:20.984281539916992)],
[(id:1592028661511657018, distance:18.37057876586914), (id:1592028661511657019, distance:19.366962432861328)],
[(id:1592028661511657013, distance:19.522361755371094), (id:1592028661511657010, distance:20.304216384887695)]
]
```

### Search vectors in a partition

```python
# create 5 vectors of 32-dimension
>>> q_records = [[random.random() for _ in range(dim)] for _ in range(5)]
>>> client.search(collection_name='test01', query_records=q_records, top_k=1, partition_tags=['tag01'], params=search_param)
```

> Note: If you do not specify `partition_tags`, Milvus searches the whole collection.
## close client

```python
>>> client.close()
```
Documentation is available online: https://pymilvus.readthedocs.io/.

## FAQ

> I'm getting random "socket operation on non-socket" errors from gRPC when connecting to Milvus from an application served on Gunicorn

Make sure to set the environment variable `GRPC_ENABLE_FORK_SUPPORT=1`. For reference, see https://zhuanlan.zhihu.com/p/136619485
## License
[Apache License 2.0](LICENSE)
2 changes: 1 addition & 1 deletion milvus/client/__init__.py
View file
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
"""client module"""

__version__ = "1.0.0"
__version__ = "1.0.1"

0 comments on commit d75e489

Please sign in to comment.