[pull] master from milvus-io:master

.github/mergify.yml

@@ -4,10 +4,12 @@ pull_request_rules:
       - or:
         - base=master
         - base~=2\.\d
-      - "status-success=Run Python Tests (3.8)"
+      - "status-success=Run Python Tests (3.8, windows-latest)"
+      - "status-success=Run Python Tests (3.12, windows-latest)"
+      - "status-success=Run Python Tests (3.8, ubuntu-latest)"
+      - "status-success=Run Python Tests (3.12, ubuntu-latest)"
       - "status-success=Run Check Proto (3.8)"
       - "status-success=Code lint check (3.8)"
-      - "status-success=Run Python Tests (3.12)"
       - "status-success=Run Check Proto (3.12)"
       - "status-success=Code lint check (3.12)"
     actions:

.github/workflows/check_milvus_proto.yml

@@ -26,10 +26,11 @@ jobs:
     - name: Install dependencies
       run: |
         python -m pip install --upgrade pip
-        pip install -e .
+        pip install -e ".[dev]"
 
     - name: Try generate proto
       run: |
         git submodule update --init
+        make gen_proto
         make check_proto_product
 

.github/workflows/code_checker.yml

@@ -19,12 +19,12 @@ jobs:
         uses: actions/setup-python@v5
         with:
           python-version: ${{ matrix.python-version }}
-      - name: check pyproject.toml install
+      - name: Check pyproject.toml install
         run: |
           pip install -e .
       - name: Install requirements
         run: |
-          pip install -r requirements.txt
+          pip install -e ".[dev]"
       - name: Run pylint
         shell: bash
         run: |

.github/workflows/pull_request.yml

@@ -8,10 +8,11 @@ on:
 jobs:
   build:
     name: Run Python Tests
-    runs-on: ubuntu-latest
     strategy:
       matrix:
         python-version: [3.8, 3.12]
+        os: [ubuntu-latest, windows-latest]
+    runs-on: ${{ matrix.os }}
 
     steps:
       - name: Checkout code
@@ -28,7 +29,7 @@ jobs:
       - name: Install dependencies
         run: |
           python -m pip install --upgrade pip
-          pip install -e ".[test]"
+          pip install -e ".[dev]"
 
       - name: Test with pytest
         run: |

Makefile

@@ -2,12 +2,12 @@ unittest:
 	PYTHONPATH=`pwd` python3 -m pytest tests --cov=pymilvus -v
 
 lint:
-	PYTHONPATH=`pwd` black pymilvus --check
-	PYTHONPATH=`pwd` ruff check pymilvus
+	PYTHONPATH=`pwd` python3 -m black pymilvus --check
+	PYTHONPATH=`pwd` python3 -m ruff check pymilvus
 
 format:
-	PYTHONPATH=`pwd` black pymilvus
-	PYTHONPATH=`pwd` ruff check pymilvus --fix
+	PYTHONPATH=`pwd` python3 -m black pymilvus
+	PYTHONPATH=`pwd` python3 -m ruff check pymilvus --fix
 
 codecov:
 	PYTHONPATH=`pwd` pytest --cov=pymilvus --cov-report=xml tests -x -v -rxXs
@@ -25,6 +25,7 @@ get_proto:
 	git submodule update --init
 
 gen_proto:
+	pip install -e ".[dev]"
 	cd pymilvus/grpc_gen && ./python_gen.sh
 
 check_proto_product: gen_proto

README.md

@@ -27,7 +27,7 @@ The following collection shows Milvus versions and recommended PyMilvus versions
 | 2.1.\* | 2.1.3 |
 | 2.2.\* | 2.2.15 |
 | 2.3.\* | 2.3.7 |
-| 2.4.\* | 2.4.0 |
+| 2.4.\* | 2.4.9 |
 
 
 ## Installation
@@ -37,12 +37,13 @@ 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.3.7
+$ pip3 install pymilvus==2.4.9
 ```
 
 You can upgrade PyMilvus to the latest version by:
@@ -62,8 +63,6 @@ $ git submodule update --init
 
 Q2. How to generate python files from milvus-proto?
 
-**Before generating python files, please install requirements in `requirements.txt`**
-
 A2.
 ```shell
 $ make gen_proto
@@ -94,10 +93,10 @@ Q6. How to run unittests?
 
 A6
 ```shell
-$ pip install ".[test]"
+$ pip install ".[dev]"
 $ make unittest
 ```
-Q7. `zsh: no matches found: pymilvus[model]` in mac, how do I solve this?
+Q7. `zsh: no matches found: pymilvus[model]`, how do I solve this?
 
 A7
 ```shell

examples/README.md

@@ -0,0 +1 @@
+# Examples

examples/bm25.py

@@ -0,0 +1,89 @@
+from pymilvus import (
+    MilvusClient,
+    Function,
+    FunctionType,
+    DataType,
+)
+
+fmt = "\n=== {:30} ===\n"
+collection_name = "doc_in_doc_out"
+milvus_client = MilvusClient("http://localhost:19530")
+
+has_collection = milvus_client.has_collection(collection_name, timeout=5)
+if has_collection:
+    milvus_client.drop_collection(collection_name)
+
+schema = milvus_client.create_schema()
+schema.add_field("id", DataType.INT64, is_primary=True, auto_id=False)
+schema.add_field("document_content", DataType.VARCHAR, max_length=9000, enable_analyzer=True)
+schema.add_field("sparse_vector", DataType.SPARSE_FLOAT_VECTOR)
+
+bm25_function = Function(
+    name="bm25_fn",
+    input_field_names=["document_content"],
+    output_field_names="sparse_vector",
+    function_type=FunctionType.BM25,
+)
+schema.add_function(bm25_function)
+
+index_params = milvus_client.prepare_index_params()
+index_params.add_index(
+    field_name="sparse_vector",
+    index_name="sparse_inverted_index",
+    index_type="SPARSE_INVERTED_INDEX",
+    metric_type="BM25",
+    params={"bm25_k1": 1.2, "bm25_b": 0.75},
+)
+
+ret = milvus_client.create_collection(collection_name, schema=schema, index_params=index_params, consistency_level="Strong")
+print(ret)
+
+print(fmt.format("    all collections    "))
+print(milvus_client.list_collections())
+
+print(fmt.format(f"schema of collection {collection_name}"))
+print(milvus_client.describe_collection(collection_name))
+
+rows = [
+        {"id": 1, "document_content": "hello world"},
+        {"id": 2, "document_content": "hello milvus"},
+        {"id": 3, "document_content": "hello zilliz"},
+]
+
+print(fmt.format("Start inserting entities"))
+insert_result = milvus_client.insert(collection_name, rows, progress_bar=True)
+print(fmt.format("Inserting entities done"))
+print(insert_result)
+
+texts_to_search = ["zilliz"]
+search_params = {
+    "metric_type": "BM25",
+    "params": {}
+}
+print(fmt.format(f"Start search with retrieve several fields."))
+result = milvus_client.search(collection_name, texts_to_search, limit=3, output_fields=["document_content"], search_params=search_params)
+for hits in result:
+    for hit in hits:
+        print(f"hit: {hit}")
+
+print(fmt.format("Start query by specifying primary keys"))
+query_results = milvus_client.query(collection_name, ids=[3])
+print(query_results[0])
+
+upsert_ret = milvus_client.upsert(collection_name, {"id": 2 , "document_content": "hello milvus again"})
+print(upsert_ret)
+
+print(fmt.format("Start query by specifying filtering expression"))
+query_results = milvus_client.query(collection_name, filter="document_content == 'hello milvus again'")
+for ret in query_results:
+    print(ret)
+
+print(f"start to delete by specifying filter in collection {collection_name}")
+delete_result = milvus_client.delete(collection_name, ids=[3])
+print(delete_result)
+
+print(fmt.format("Start query by specifying filtering expression"))
+query_results = milvus_client.query(collection_name, filter="document_content == 'hello zilliz'")
+print(f"Query results after deletion: {query_results}")
+
+milvus_client.drop_collection(collection_name)