logo
Browse Source

Add README

Signed-off-by: shiyu22 <shiyu.chen@zilliz.com>
main
shiyu22 2 years ago
parent
commit
2d27578dd0
  1. 12
      README.md

12
README.md

@ -10,7 +10,7 @@
## Code Example ## Code Example
- Create Milvus Collection
#### Create Milvus Collection
Before running the pipeline, please create Milvus collection first. Before running the pipeline, please create Milvus collection first.
@ -41,7 +41,7 @@ index_params = {
collection.create_index(field_name="embedding", index_params=index_params) collection.create_index(field_name="embedding", index_params=index_params)
``` ```
- Create image embedding pipeline and set the configuration.
#### Create image embedding pipeline and set the configuration
> More parameters refer to the Configuration. > More parameters refer to the Configuration.
@ -67,9 +67,9 @@ Then you can run `collection.num_entities` to check the number of the data in Mi
## Configuration ## Configuration
**EnhancedQAInsertConfig**
### **EnhancedQAInsertConfig**
- Configuration for [Text Loader](https://towhee.io/towhee/text-loader)
#### Configuration for [Text Loader](https://towhee.io/towhee/text-loader)
***chunk_size: int*** ***chunk_size: int***
The size of each chunk, defaults to 300. The size of each chunk, defaults to 300.
@ -77,7 +77,7 @@ The size of each chunk, defaults to 300.
***source_type: str*** ***source_type: str***
The type of the soure, defaults to `'file'`, you can also set to `'url'` for you url of your documentation. The type of the soure, defaults to `'file'`, you can also set to `'url'` for you url of your documentation.
- Configuration for Sentence Embedding
#### Configuration for Sentence Embedding
***model: str*** ***model: str***
The model name in the sentence embedding pipeline, defaults to `'all-MiniLM-L6-v2'`. The model name in the sentence embedding pipeline, defaults to `'all-MiniLM-L6-v2'`.
@ -97,7 +97,7 @@ Whether to normalize the embedding vectors, defaults to `True`.
The number of devices, defaults to `-1`, which means using the CPU. The number of devices, defaults to `-1`, which means using the CPU.
If the setting is not `-1`, the specified GPU device will be used. If the setting is not `-1`, the specified GPU device will be used.
- Configuration for [Milvus](https://towhee.io/ann-insert/milvus-client)
#### Configuration for [Milvus](https://towhee.io/ann-insert/milvus-client)
***host: str*** ***host: str***
Host of Milvus vector database, default is `'127.0.0.1'`. Host of Milvus vector database, default is `'127.0.0.1'`.

Loading…
Cancel
Save