From 65de13dcdcfa56266e0b350ada3afdb528d3807a Mon Sep 17 00:00:00 2001 From: yiwen92 <34636520+yiwen92@users.noreply.github.com> Date: Mon, 22 Apr 2024 11:48:24 +0800 Subject: [PATCH 1/2] Update create_collection.md Clarify behaviors for create collection --- .../Collections/create_collection.md | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/API_Reference/pymilvus/v2.4.x/MilvusClient/Collections/create_collection.md b/API_Reference/pymilvus/v2.4.x/MilvusClient/Collections/create_collection.md index ff817dca9..0b9557ffb 100644 --- a/API_Reference/pymilvus/v2.4.x/MilvusClient/Collections/create_collection.md +++ b/API_Reference/pymilvus/v2.4.x/MilvusClient/Collections/create_collection.md @@ -1,6 +1,6 @@ # create_collection() -This operation creates a collection either with default or customized settings. +This operation supports creates a collection with 2 separate modes: quick setup or customized setup. ## Request syntax @@ -14,8 +14,8 @@ create_collection( metric_type: str = "COSINE", auto_id: bool = False, timeout: Optional[float] = None, - schema: Optional[CollectionSchema] = None, - index_params: Optional[IndexParams] = None, + schema: Optional[CollectionSchema] = None, # this is customized setting + index_params: Optional[IndexParams] = None, # this is customized setting **kwargs, ) -> None ``` @@ -84,7 +84,7 @@ __PARAMETERS:__ The schema of this collection. - Setting this to __None__ indicates this collection will be created with default settings. + Setting this to __None__ indicates this collection will be created with quick setup. To set up a collection with a customized schema, you need to create a __CollectionSchema__ object and reference it here. In this case, Milvus ignores all other schema-related settings carried in the request. @@ -202,7 +202,7 @@ You can choose between a quick setup or a customized setup as follows: - __Quick setup__ - The quick setup collection has two fields: the primary and vector fields. It also allows the insertion of undefined fields and their values in key-value pairs in a dynamic field. + The quick setup collection has two required fields: the primary and vector fields. It also allows the insertion of undefined fields and their values in key-value pairs in a dynamic field. ```python client.create_collection( @@ -236,7 +236,7 @@ You can choose between a quick setup or a customized setup as follows: ) ``` - In the above code, the collection will be created and automatically loaded into memory. + In the above code, the collection will be created, automatically indexed and loaded into memory. - __Customized setup with index parameters__ @@ -279,7 +279,7 @@ You can choose between a quick setup or a customized setup as follows: ) ``` - In the above code, the collection will be created and automatically loaded into memory. + In the above code, the collection will be created, indexed with customized settings and automatically loaded into memory. - __Customized setup without index parameters__ @@ -303,7 +303,7 @@ You can choose between a quick setup or a customized setup as follows: ) ``` - In the above code, the collection will also be created, but its data will not automatically loaded into memory. + In the above code, the collection will also be created, but since it lacks index_params, so its data will not indexed and loaded into memory automatically. ## Related methods From c8f9d3a796afc534df382932a13ae6e7a8ba7672 Mon Sep 17 00:00:00 2001 From: AnthonyTsu1984 <115786031+AnthonyTsu1984@users.noreply.github.com> Date: Wed, 29 May 2024 17:45:30 +0800 Subject: [PATCH 2/2] Update create_collection.md --- .../v2.4.x/MilvusClient/Collections/create_collection.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/API_Reference/pymilvus/v2.4.x/MilvusClient/Collections/create_collection.md b/API_Reference/pymilvus/v2.4.x/MilvusClient/Collections/create_collection.md index 0b9557ffb..870ade51b 100644 --- a/API_Reference/pymilvus/v2.4.x/MilvusClient/Collections/create_collection.md +++ b/API_Reference/pymilvus/v2.4.x/MilvusClient/Collections/create_collection.md @@ -1,6 +1,6 @@ # create_collection() -This operation supports creates a collection with 2 separate modes: quick setup or customized setup. +This operation supports creating a collection with two separate modes: quick setup or customized setup. ## Request syntax