From a67b266ef4b2fe7c2353e94ebf25fb874d4893a0 Mon Sep 17 00:00:00 2001 From: Jael Gu Date: Thu, 7 Apr 2022 17:07:34 +0800 Subject: [PATCH] Update README Signed-off-by: Jael Gu --- README.md | 20 ++++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 52dc9f4..36c7f9e 100644 --- a/README.md +++ b/README.md @@ -53,20 +53,20 @@ Create the operator via the following factory method **Parameters:** -  ***model_name***: *str* +***model_name***: *str* -  The model name in string. The default value is "resnet34". +The model name in string. The default value is "resnet34". Refer [Timm Docs](https://fastai.github.io/timmdocs/#List-Models-with-Pretrained-Weights) to get a full list of supported models. -  ***num_classes***: *int* +***num_classes***: *int* -  The number of classes. The default value is 1000. +The number of classes. The default value is 1000. It is related to model and dataset. -  ***skip_preprocess***: *bool* +***skip_preprocess***: *bool* -  The flag to control whether to skip image preprocess. +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. @@ -81,17 +81,17 @@ It uses the pre-trained model specified by model name to generate an image embed **Parameters:** -  ***img***: *towhee.types.Image (a sub-class of numpy.ndarray)* +***img***: *towhee.types.Image (a sub-class of numpy.ndarray)* -  The decoded image data in numpy.ndarray. +The decoded image data in numpy.ndarray. **Returns**: -  *numpy.ndarray* +*numpy.ndarray* -  The image embedding extracted by model. +The image embedding extracted by model.