Readme update

README.md

@@ -1,2 +1,92 @@
-# deepface
+# Face Embeddings using Deepface
+  *Author: Krishna katyal*
 
+<br />
+
+
+
+## Description
+The pipeline is used to extract the feature vector of detected faces in images. It uses the  for face embeddings   [`Deepface`](https://github.com/serengil/deepface).
+
+
+<br />
+
+
+## Code Example
+Load an image from path './test_face'. 
+
+ *Write the pipeline in simplified style*:
+
+```python
+import towhee 
+towhee.glob('./test_face.jpg') \
+  .image_decode.cv2() \
+  .face_embedding.deepface(model_name = 'DeepFace').tolist()
+```
+
+
+<img src="./image.png" height="200px"/>
+
+*Write a pipeline with explicit inputs/outputs name specifications:*
+
+
+```python
+import towhee
+
+towhee.glob['path']('./test_face.jpgg') \
+  .image_decode.cv2['path', 'img']() \
+  .face_embedding.deepface['img', 'vec']() \
+  .select['img','vec']() \
+  .show()
+```
+
+<br />
+
+
+
+
+## Factory Constructor
+
+Create the operator via the following factory method
+
+***face_embedding.deepface(model_name = 'which  model to use')***
+
+Model options: 
+- VGG-Face
+- FaceNet
+- OpenFace
+- DeepFace
+- ArcFace
+- Dlib
+- DeepID
+
+
+<br />
+
+
+
+## Interface
+
+A face embedding operator takes a face image as input. It extracts the embedding in ndarray.
+
+**Parameters:**
+
+​	***img:*** *towhee.types.Image (a sub-class of numpy.ndarray)*
+
+​	The input image.
+
+**Returns:** *numpy.ndarray*
+
+​	The extracted image embedding.
+
+
+<br />
+
+
+
+
+**Reference**
+
+https://github.com/serengil/deepface
+
+You can refer to [Getting Started with Towhee](https://towhee.io/) for more details. If you have any questions, you can [submit an issue to the towhee repository](https://github.com/towhee-io/towhee/issues).

node_modules/.yarn-integrity

@@ -0,0 +1,10 @@
+{
+  "systemParams": "darwin-x64-83",
+  "modulesFolders": [],
+  "flags": [],
+  "linkedModules": [],
+  "topLevelPatterns": [],
+  "lockfileEntries": {},
+  "files": [],
+  "artifacts": {}
+}

yarn.lock

@@ -0,0 +1,4 @@
+# THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY.
+# yarn lockfile v1
+
+