Update

Signed-off-by: shiyu22 <shiyu.chen@zilliz.com>

.gitattributes

@@ -0,0 +1,35 @@
+# .gitattributes
+
+# Source files
+# ============
+*.pxd    text diff=python
+*.py     text diff=python
+*.py3    text diff=python
+*.pyw    text diff=python
+*.pyx    text diff=python
+*.pyz    text diff=python
+*.pyi    text diff=python
+
+# Binary files
+# ============
+*.db     binary
+*.p      binary
+*.pkl    binary
+*.pickle binary
+*.pyc    binary export-ignore
+*.pyo    binary export-ignore
+*.pyd    binary
+
+# Jupyter notebook
+*.ipynb  text
+
+# Model files
+*.bin.* filter=lfs diff=lfs merge=lfs -text
+*.lfs.* filter=lfs diff=lfs merge=lfs -text
+*.bin filter=lfs diff=lfs merge=lfs -text
+*.h5 filter=lfs diff=lfs merge=lfs -text
+*.tflite filter=lfs diff=lfs merge=lfs -text
+*.tar.gz filter=lfs diff=lfs merge=lfs -text
+*.ot filter=lfs diff=lfs merge=lfs -text
+*.onnx filter=lfs diff=lfs merge=lfs -text
+*.msgpack filter=lfs diff=lfs merge=lfs -text

.gitignore

@@ -0,0 +1,209 @@
+### Linux ###
+*~
+
+# temporary files which can be created if a process still has a handle open of a deleted file
+.fuse_hidden*
+
+# KDE directory preferences
+.directory
+
+# Linux trash folder which might appear on any partition or disk
+.Trash-*
+
+# .nfs files are created when an open file is removed but is still being accessed
+.nfs*
+
+### OSX ###
+# General
+.DS_Store
+.AppleDouble
+.LSOverride
+
+# Icon must end with two \r
+Icon
+
+
+# Thumbnails
+._*
+
+# Files that might appear in the root of a volume
+.DocumentRevisions-V100
+.fseventsd
+.Spotlight-V100
+.TemporaryItems
+.Trashes
+.VolumeIcon.icns
+.com.apple.timemachine.donotpresent
+
+# Directories potentially created on remote AFP share
+.AppleDB
+.AppleDesktop
+Network Trash Folder
+Temporary Items
+.apdisk
+
+### Python ###
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+### Windows ###
+# Windows thumbnail cache files
+Thumbs.db
+Thumbs.db:encryptable
+ehthumbs.db
+ehthumbs_vista.db
+
+# Dump file
+*.stackdump
+
+# Folder config file
+[Dd]esktop.ini
+
+# Recycle Bin used on file shares
+$RECYCLE.BIN/
+
+# Windows Installer files
+*.cab
+*.msi
+*.msix
+*.msm
+*.msp
+
+# Windows shortcuts
+*.lnk

README.md

@@ -1,3 +1,53 @@
-# transform-image-operator-template
+# **Template: Image Preprocessing Operator**
 
-This is another test repo
+Authors:
+
+## **Overview**
+
+> <font style="color: red">**Note:** this is just a **template**, not a runnable pipeline.</font>
+
+This **transform image operator class** defines image embedding functions, as well as the standard inputs and outputs. You can complete the operator by filling in functions (`__init__` &  `__call__`) in [transform_image_operator_template.py](http://./transform_image_operator_template.py) and update this README file. FYI, [transform-image](https://hub.towhee.io/towhee/transform-image) is based on this template.
+
+This operator is used to transform the image, such as cropping, PIL.Image and Tensor conversion, normalization and other operations on the image.
+
+## **Interface**
+
+```python
+__init__(self, size: int)
+```
+
+**Args:**
+
+- size:
+  - The size of the output image
+  - supported types: `int`
+
+```python
+int__call__(self, img: Union[Image.Image, torch.Tensor, str])
+```
+
+**Args:**
+
+- img:
+  - the input image to be processed
+  - supported type:  `PIL.image`, `torch.Tensor` or `str` (path of the image)
+
+**Returns:**
+
+The Operator returns a tuple `Tuple[('img_transformed', torch.Tensor)]` containing following fields:
+
+- img_transformed:
+  - the tensor of the transformed image
+  - data type: `torch.Tensor`
+
+## **Requirements**
+
+You can get the required python package by [requirements.txt](https://zilliverse.feishu.cn/docs/requirements.txt).
+
+## **How it works**
+
+The `towhee/transform-image-operator-template` Operator is used for image transformation and is an important part of data preprocessing. It can be added to the pipeline and is usually used as the first custom operator of the pipeline. For example, it's the first Operator named processing within [image-embedding-pipeline-template](https://hub.towhee.io/towhee/image-embedding-pipeline-template) pipeline, and it is the red box in the picture below.
+
+![img](./readme_res/operator.png)
+
+## **Reference**

__init__.py

@@ -0,0 +1,13 @@
+# Copyright 2021 Zilliz. All rights reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.

config.py

@@ -0,0 +1 @@
+TEST_IMG = './test_data/test.jpg'

test_transform_image_operator_template.py

@@ -0,0 +1,29 @@
+import unittest
+from PIL import Image
+from torchvision import transforms
+from transform_image_operator_template import TransformImageOperatorTemplate
+from config import TEST_IMG, SIZE
+
+
+class TestTransformImageOperatorTemplate(unittest.TestCase):
+    test_img = Image.open(TEST_IMG)
+    tfms = transforms.Compose(
+        [
+            transforms.Resize(SIZE),
+            transforms.CenterCrop(224),
+            transforms.ToTensor(),
+            transforms.Normalize([0.485, 0.456, 0.406], [0.229, 0.224, 0.225]),
+        ]
+    )
+    img1 = tfms(test_img).unsqueeze(0)
+
+    def test_transform_image(self):
+        op = TransformImageOperatorTemplate(SIZE)
+        outputs = op(self.test_img)
+        print("The output tyep of operator:", type(outputs.img_transformed))
+        c = (self.img1.numpy() == outputs.img_transformed.numpy())
+        self.assertEqual(c.all(), True)
+
+
+if __name__ == '__main__':
+    unittest.main()

transform_image_operator_template.py

@@ -0,0 +1,35 @@
+# Copyright 2021 Zilliz. All rights reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+from typing import NamedTuple, Union
+from towhee.operator import Operator
+
+
+class TransformImageOperatorTemplate(Operator):
+    """
+    Transform an image (resize, crop, normalize, etc...)
+
+    Args:
+        size (`int`):
+            Image size to use. A resize to `size x size` followed by center crop and
+            image normalization will be done.
+    """
+    def __init__(self, size: int) -> None:
+        super().__init__()
+        #user defined initialization
+
+    def __call__(self, img: Union[Image.Image, torch.Tensor, str]) -> NamedTuple('Outputs', [('img_transformed', torch.Tensor)]):
+        results =  #user defined function: get the transformed image
+        Outputs = NamedTuple('Outputs', [('img_transformed', torch.Tensor)])
+        return Outputs(results)

transform_image_operator_template.yaml

@@ -0,0 +1,13 @@
+name: 'transform-image'
+labels: 
+  recommended_framework: #the recommend framework, such as 'pytorch1.2.0'
+  class: image-transform
+  others:
+operator: 'towhee/transform-image-operator-class'
+init:
+  size: int
+call:
+  input:
+    img: Union[np.ndarray, Image.Image, torch.Tensor, str]
+  output:
+    img_transformed: torch.Tensor