diff --git a/README.md b/README.md index 76b518a..510e108 100644 --- a/README.md +++ b/README.md @@ -4,15 +4,15 @@ Authors: derekdqc ## Overview -The pipeline is used to **extract the feature vector of a given image**. It first normalizes the image and then uses Resnet50 model to generate the vector. +The pipeline is used to **extract the feature vector of a given image**. It uses Resnet50 model to generate the vector. ## Interface **Input Arguments:** - img_path: - - the input image to be encoded - - supported types: `str` (path of the image) + - path to the input image + - supported types: `str` **Pipeline Output:** @@ -38,12 +38,13 @@ $ pip3 install towhee >>> from towhee import pipeline >>> embedding_pipeline = pipeline('towhee/image-embedding-resnet50') ->>> embedding = embedding_pipeline('path/to/your/image') +>>> embedding = embedding_pipeline('path/to/your/image') #such as './readme_res/pipeline.png' ``` ## How it works -This pipeline includes two main operators: [transform image](https://hub.towhee.io/towhee/transform-image-operator-template) (implemented as [towhee/transform-image](https://hub.towhee.io/towhee/transform-image)) and [image embedding](https://hub.towhee.io/towhee/image-embedding-operator-template) (implemented as [towhee/resnet-image-embedding](https://hub.towhee.io/towhee/resnet-image-embedding)). The transform image operator will first convert the original image into a normalized format, such as with 512x512 resolutions. Then, the normalized image will be encoded via image embedding operator, and finally we get a feature vector of the given image. +This pipeline includes one operator: [image embedding](https://hub.towhee.io/towhee/image-embedding-operator-template) (implemented as [towhee/resnet-image-embedding](https://hub.towhee.io/towhee/resnet-image-embedding)). The image will be encoded via image embedding operator, then we can get a feature vector of the given image. + > Refer [Towhee architecture](https://github.com/towhee-io/towhee#towhee-architecture) for basic concepts in Towhee: pipeline, operator, dataframe. diff --git a/readme_res/pipeline.png b/readme_res/pipeline.png index 5dbc0d7..5d6f762 100644 Binary files a/readme_res/pipeline.png and b/readme_res/pipeline.png differ