From 0f279fea603a83c57314aa26a84f671a395a78c4 Mon Sep 17 00:00:00 2001
From: Filip Haltmayer <filip.haltmayer@zilliz.com>
Date: Thu, 27 Jan 2022 16:11:04 -0800
Subject: [PATCH] readme

---
 README.md | 54 +++++++++++++++++++++++++++++++++++++++++++++++++++++-
 1 file changed, 53 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 77c3d0f..aa1961e 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,54 @@
-# animegan-style-transfer
+# AnimeGanV2 Style-Transfer Operator
 
+Authors: filip
+
+## Overview
+
+AnimeGanV2 is a style transfer net that transforms images to looking like they fit in an anime movie.
+
+## Interface
+
+```python
+__init__(self, model_name: str, framework: str = 'pytorch')
+```
+
+**Args:**
+
+- model_name:
+  - which weights to use for inference.
+  - supports 'celeba', 'facepaintv1', 'facepaitv2', 'hayao', 'paprika', 'shinkai'
+- framework:
+  - the framework of the model
+  - supported types: `str`, default is 'pytorch'
+
+```python
+__call__(self,  image: 'towhee.types.Image')
+```
+
+**Args:**
+
+- image:
+  - the input image
+  - supported types: `towhee.types.Image`
+
+**Returns:**
+
+The Operator returns a tuple `Tuple[('styled_image', numpy.ndarray)]` containing following fields:
+
+- styled_image:
+  - styled photo
+  - data type: `numpy.ndarray`
+  - shape: (3, x, x)
+  - format: RGB
+  - values: [0,1]
+
+## Requirements
+
+You can get the required python package by [requirements.txt](./requirements.txt).
+
+
+## Reference
+
+Jie Chen, Gang Liu, Xin Chen
+"AnimeGAN: A Novel Lightweight GAN for Photo Animation."
+ISICA 2019: Artificial Intelligence Algorithms and Applications pp 242-256, 2019.