From 987912e69aa22e984e8591ddeff2d892c1d48cd5 Mon Sep 17 00:00:00 2001 From: Vladimir Mandic Date: Wed, 9 Sep 2020 09:29:24 -0400 Subject: [PATCH] updated docs --- README.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 162a989..efe9efe 100644 --- a/README.md +++ b/README.md @@ -30,8 +30,10 @@ Due to reduced code and changed build process, resulting bundle is about **>5x s ## Installation -**Imporant!**: This version of **face-api** does not embedd full version of **TensorFlow/JS (tfjs)** to enable dynamic loading of different versions of tfjs as well as to enable reusability of tfjs for different purposes. +**Imporant!**: This version of **face-api** does not embedd full version of **TensorFlow/JS (tfjs)** to keep package as small as possible (322KB minified), enable dynamic loading of different tfjs backends as well as to enable reusability of tfjs for different purposes. + *Load tfjs explicitly before loading face-api.* +*Note: package `@tensorflow/tfjs` is bundle, if you want to keep your project small, import `@tensorflow/tfjs-core` plus a specific backend such as `@tensorflow/tfjs-backend-cpu`, `@tensorflow/tfjs-backend-webgl` or `@tensorflow/tfjs-node`* For example as a script: @@ -101,4 +103,6 @@ For documentation refer to original project at +*Note: Photos shown below are taken by me* + ![alt text](example/screenshot.png)