Skip to content

Commit

Permalink
Merge pull request #2878 from liyun95/v2.5.x-preview
Browse files Browse the repository at this point in the history
V2.5.x preview
  • Loading branch information
liyun95 authored Nov 26, 2024
2 parents e79bcb5 + 3908b68 commit 755a500
Show file tree
Hide file tree
Showing 100 changed files with 18,534 additions and 13,910 deletions.
6 changes: 3 additions & 3 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ name: dev
on:
push:
branches:
- v2.4.x
- v2.5.x-preview
release:
types: [released]
workflow_dispatch:
Expand All @@ -20,7 +20,7 @@ jobs:
- name: Check out Git repository
uses: actions/checkout@v1
with:
ref: v2.4.x
ref: v2.5.x-preview

- name: Extract branch name
shell: bash
Expand Down Expand Up @@ -52,4 +52,4 @@ jobs:
cp -avr ../milvus-docs/** ./`cat version.json | jq -r .version`
git add .
git commit -m "Release new docs "
git push -f origin master
git push -f origin preview
Binary file added assets/analyzer-overview.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/ann-search.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/batch-data-and-streaming-data.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/binary-vector.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/bitmap.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/bm25.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/collection-explained.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/consistency-level-illustrated.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/dense-vector.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/filtered-search.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/full-text-search.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/grouping-search.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/hybrid-search.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/idf.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/keyword-match.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/partition-vs-partition-key.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/range-search.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/schema-explained.PNG
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/schema-hands-on.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/service-time-and-guarantee-time.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/sparse-vector.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/upsert-entities.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/use-binary-vector.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/use-dense-vector.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/use-sparse-vector.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/with-and-without-partition-key.png
2 changes: 1 addition & 1 deletion site/en/about/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,7 @@ In addition to primitive data types, Milvus supports various advanced data types
- [Sparse Vectors](sparse_vector.md)
- [Binary Vectors](index-vector-fields.md)
- [JSON Support](use-json-fields.md)
- [Array Support](array_data_type.md)
- [Array Support](array.md)
- [Distance Metrics](metric.md)

### Acceleration
Expand Down
24 changes: 12 additions & 12 deletions site/en/adminGuide/resource_group.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ All code samples on this page are in PyMilvus {{var.milvus_python_sdk_real_versi

To create a resource group, run the following after you connect to a Milvus instance. The following snippet assumes that `default` is the alias of your Milvus connection.

```Python
```python
import pymilvus

# A resource group name should be a string of 1 to 255 characters, starting with a letter or an underscore (_) and containing only numbers, letters, and underscores (_).
Expand All @@ -80,7 +80,7 @@ All code samples on this page are in PyMilvus {{var.milvus_python_sdk_real_versi

To view the list of resource groups in a Milvus instance, do as follows:

```Python
```python
rgs = utility.list_resource_groups(using='default')
print(f"Resource group list: {rgs}")

Expand All @@ -91,7 +91,7 @@ All code samples on this page are in PyMilvus {{var.milvus_python_sdk_real_versi

You can have Milvus describe a resource group in concern as follows:

```Python
```python
info = utility.describe_resource_group(name, using="default")
print(f"Resource group description: {info}")

Expand All @@ -110,7 +110,7 @@ All code samples on this page are in PyMilvus {{var.milvus_python_sdk_real_versi
Assuming there are currently 1 QueryNodes in the **__default_resource_group** of the cluster, and we want to transfer one node into created **rg**.
`update_resource_groups` ensures atomicity for multiple configuration changes, so no intermediate states will be visible to Milvus.

```Python
```python
source = '__default_resource_group'
target = 'rg'
expected_num_nodes_in_default = 0
Expand Down Expand Up @@ -138,7 +138,7 @@ All code samples on this page are in PyMilvus {{var.milvus_python_sdk_real_versi

Once there are query nodes in a resource group, you can load collections to this resource group. The following snippet assumes that a collection named `demo` already exists.

```Python
```python
from pymilvus import Collection

collection = Collection('demo')
Expand All @@ -154,7 +154,7 @@ All code samples on this page are in PyMilvus {{var.milvus_python_sdk_real_versi

Also, you can just load a partition into a resource group and have its replicas distributed among several resource groups. The following assumes that a collection named `Books` already exists and it has a partition named `Novels`.

```Python
```python
collection = Collection("Books")

# Use the load method of a collection to load one of its partition
Expand All @@ -173,7 +173,7 @@ All code samples on this page are in PyMilvus {{var.milvus_python_sdk_real_versi

Milvus uses [replicas](replica.md) to achieve load-balancing among [segments](glossary.md#Segment) distributed across several query nodes. You can move certain replicas of a collection from one resource group to another as follows:

```Python
```python
source = '__default_resource_group'
target = 'rg'
collection_name = 'c'
Expand All @@ -192,7 +192,7 @@ All code samples on this page are in PyMilvus {{var.milvus_python_sdk_real_versi

You can drop a resource group that hold no query node (`limits.node_num = 0`) at any time. In this guide, resource group `rg` now has one query node. You need to change the configuration `limits.node_num` of resource group into zero first.

```Python
```python
try:
utility.update_resource_groups({
"rg": utility.ResourceGroupConfig(
Expand All @@ -218,7 +218,7 @@ Here is a good practice for managing QueryNodes in a cloud environment:
Additionally, if we strictly enforce the constraint `sum(.requests.nodeNum) <= queryNodeNum`, we can precisely control the assignment of QueryNodes in the cluster. Let's assume there is currently only one QueryNode in the cluster and initialize the cluster.
Here is an example setup:

```Python
```python
from pymilvus import utility
from pymilvus.client.types import ResourceGroupConfig

Expand Down Expand Up @@ -261,15 +261,15 @@ Here is a good practice for managing QueryNodes in a cloud environment:
2. Cluster scale out

Assuming we have the following scaling function:
```Python
```python

def scale_to(node_num: int):
# scale the querynode number in Milvus into node_num.
pass
```

We can use the API to scale a specific resource group to a designated number of QueryNodes without affecting any other resource groups.
```Python
```python
# scale rg1 into 3 nodes, rg2 into 1 nodes
utility.update_resource_groups({
"rg1": ResourceGroupConfig(
Expand All @@ -293,7 +293,7 @@ Here is a good practice for managing QueryNodes in a cloud environment:

Similarly, we can establish scaling-in rules that prioritize selecting QueryNodes from **__pending_nodes** resource group. This information can be obtained through the `describe_resource_group` API. Achieving the goal of scaling-in specified resource group.

```Python
```python
# scale rg1 from 3 nodes into 2 nodes
utility.update_resource_groups({
"rg1": ResourceGroupConfig(
Expand Down
Loading

0 comments on commit 755a500

Please sign in to comment.