Browse Source
Optimize README
Signed-off-by: Jael Gu <mengjia.gu@zilliz.com>
test
1 changed files with
10 additions and
9 deletions
-
README.md
|
|
|
@ -63,20 +63,21 @@ It is related to model and dataset. |
|
|
|
|
|
|
|
***skip_preprocess***: *bool* |
|
|
|
|
|
|
|
Flag to control whether to skip image preprocess, defaults to False. |
|
|
|
If set to True, image preprocess steps such as transform, normalization will be skipped. |
|
|
|
In this case, the user should guarantee that all the input images are already reprocessed properly, and thus can be fed to model directly. |
|
|
|
The flag to control whether to skip image preprocess. |
|
|
|
The default value is False. |
|
|
|
If set to True, it will skip image preprocessing steps (transforms). |
|
|
|
In this case, input image data must be prepared in advance in order to properly fit the model. |
|
|
|
|
|
|
|
|
|
|
|
## Interface |
|
|
|
|
|
|
|
An image embedding operator takes an image in ndarray as input. |
|
|
|
An image embedding operator takes a [towhee image](link/to/towhee/image/api/doc) as input. |
|
|
|
It uses the pre-trained model specified by model name to generate an image embedding in ndarray. |
|
|
|
|
|
|
|
|
|
|
|
**Parameters:** |
|
|
|
|
|
|
|
***img***: *[towhee.types.Image]()* |
|
|
|
***img***: *towhee.types.Image* |
|
|
|
|
|
|
|
The decoded image data in towhee.types.Image (numpy.ndarray). |
|
|
|
|
|
|
|
|
