From bac0ef10cf7e82cde4f5c7ee61e93bd05a5a844c Mon Sep 17 00:00:00 2001 From: Vladimir Mandic Date: Tue, 26 Jul 2022 07:27:52 -0400 Subject: [PATCH] update readme --- README.md | 13 +++++-------- 1 file changed, 5 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 59378c7..d921e23 100644 --- a/README.md +++ b/README.md @@ -443,14 +443,10 @@ Build process uses `@vladmandic/build` module that creates optimized build for e 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 using **`TensorFlow/JS` 3.19.0** - *Why?* I needed FaceAPI that does not cause version conflict with newer versions of TensorFlow And since original FaceAPI was open-source, I've released this version as well -Changes ended up being too large for a simple pull request -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 Although a lot of work has gone into this version of `FaceAPI` and it will continue to be maintained, @@ -467,10 +463,11 @@ but extends it with newer AI models, additional detection details, compatibility Compared to [face-api.js](https://github.com/justadudewhohacks/face-api.js) version **0.22.2**: - Compatible with `TensorFlow/JS 2.0+ & 3.0+` - Original `face-api.js` is based on `TFJS` **1.7.4** + Currently using **`TensorFlow/JS` 3.19.0** + Original `face-api.js` is based on `TFJS` **1.7.4** - Compatible with `WebGL`, `CPU` and `WASM` TFJS Browser backends - Compatible with both `tfjs-node` and `tfjs-node-gpu` TFJS NodeJS backends -- Updated all type castings for TypeScript type checking to `TypeScript 4.6` +- Updated all type castings for TypeScript type checking to `TypeScript 4.7` - Switched bundling from `UMD` to `ESM` + `CommonJS` with fallback to `IIFE` Resulting code is optimized per-platform instead of being universal Fully tree shakable when imported as an `ESM` module @@ -492,7 +489,7 @@ Compared to [face-api.js](https://github.com/justadudewhohacks/face-api.js) vers - Added `face angle` calculations that returns `roll`, `yaw` and `pitch` - Added `typdoc` automatic API specification generation during build - Added `changelog` automatic generation during build -- Created new process to generate **TypeDocs** bundle using API-Extractor +- New process to generate **TypeDocs** bundle using API-Extractor