diff --git a/README.md b/README.md index 572c71f..f37c9ba 100644 --- a/README.md +++ b/README.md @@ -16,17 +16,17 @@ ## Note -This is updated **face-api.js** with latest available TensorFlow/JS as the original face-api.js is not compatible with **tfjs 2.0+**. +This is updated **face-api.js** with latest available TensorFlow/JS as the original is not compatible with **tfjs 2.0+**. Forked from [face-api.js](https://github.com/justadudewhohacks/face-api.js) version **0.22.2** which was released on March 22nd, 2020 Currently based on **`TensorFlow/JS` 3.3.0** -### Why? - -Because I needed Face-API that does not cause version conflict with newer TFJS 2.0 that I use accross my projects +*Why?* I needed Face-API that does not cause version conflict with newer versions of TensorFlow And since original Face-API was open-source, I've released this version as well -Changes ended up being too large for a simple pull request on original Face-API and it ended up being a full-fledged version on its own +Changes ended up being too large for a simple pull request +and it ended up being a full-fledged version on its own +Plus many features were added since original inception


@@ -381,11 +381,15 @@ npm run build ![facemesh](example/facemesh.png) +
+ ## Documentation - [**Tutorial**](TUTORIAL.md) - [**API Documentation**](https://justadudewhohacks.github.io/face-api.js/docs/globals.html) +
+ ## Differences - Compatible with `TensorFlow/JS 2.0+ & 3.0+` @@ -411,6 +415,8 @@ npm run build Which means valid models are **tinyFaceDetector** and **mobileNetv1** +
+ ## Credits - Original project: [Face-API](https://github.com/justadudewhohacks/face-api.js) diff --git a/TODO.md b/TODO.md index eff6fcb..4c7902b 100644 --- a/TODO.md +++ b/TODO.md @@ -1,3 +1,4 @@ # To-do List for FaceAPI - Improve examples and reference them in readme +- Add TypeDoc