From c7ad6efe38e79ab1118c42e72e42af9c20c2d751 Mon Sep 17 00:00:00 2001 From: Vladimir Mandic Date: Sat, 7 Nov 2020 09:39:54 -0500 Subject: [PATCH] created wiki --- CHANGELOG.md | 170 --------------- README.md | 585 ++------------------------------------------------- changelog.js | 2 +- package.json | 1 + wiki | 1 + 5 files changed, 26 insertions(+), 733 deletions(-) delete mode 100644 CHANGELOG.md create mode 160000 wiki diff --git a/CHANGELOG.md b/CHANGELOG.md deleted file mode 100644 index 7924105f..00000000 --- a/CHANGELOG.md +++ /dev/null @@ -1,170 +0,0 @@ - -# @vladmandic/human - -Version: **0.7.3** -Description: **human: 3D Face Detection, Body Pose, Hand & Finger Tracking, Iris Tracking, Age & Gender Prediction, Emotion Prediction & Gesture Recognition** - -Author: **Vladimir Mandic ** -License: **MIT** -Repository: **** - -## Changelog - -### **HEAD -> main** 2020/11/05 mandic00@live.com - -### **0.7.3** 2020/11/05 mandic00@live.com -- optimized camera and mobile layout -- fixed worker and filter compatibility -- removed test code - -### **0.7.2** 2020/11/04 mandic00@live.com -- major work on handpose model - -### **0.7.1** 2020/11/04 mandic00@live.com -- changed demo build process - -### **0.6.7** 2020/11/04 mandic00@live.com -- implemented simple gesture recognition - -### **0.6.6** 2020/11/04 mandic00@live.com -- remove debug code - -### **0.6.5** 2020/11/04 mandic00@live.com -- redo hand detection - -### **0.6.4** 2020/11/03 mandic00@live.com -- added manifest - -### **0.6.3** 2020/11/03 mandic00@live.com -- enhanced processing resolution -- fix pause restart -- complete model refactoring -- fixed typo - -### **0.6.2** 2020/11/02 mandic00@live.com -- optimized demo -- package update - -### **0.6.1** 2020/11/02 mandic00@live.com -- major performance improvements for all models -- revert "optimized canvas handling" -- optimized canvas handling -- minor optimization to imagefx -- fix demo image sample -- added tfjs-vis to distribution - -### **0.5.5** 2020/11/01 mandic00@live.com -- changed defaults - -### **0.5.4** 2020/11/01 mandic00@live.com -- implemented memory profiler - -### **0.5.3** 2020/10/30 mandic00@live.com -- improved debug logging - -### **0.5.2** 2020/10/30 mandic00@live.com -- added wasm and webgpu backends - -### **0.5.1** 2020/10/30 mandic00@live.com -- improve demo line continous draws - -### **0.4.10** 2020/10/30 mandic00@live.com -- fix for seedrandom - -### **0.4.9** 2020/10/29 mandic00@live.com - -### **0.4.8** 2020/10/28 mandic00@live.com -- revert "updated menu handler" -- fix webpack compatibility issue - -### **0.4.7** 2020/10/27 mandic00@live.com - -### **0.4.6** 2020/10/27 mandic00@live.com -- fix firefox compatibility bug - -### **0.4.5** 2020/10/27 mandic00@live.com - -### **0.4.4** 2020/10/27 mandic00@live.com -- implelented input resizing - -### **0.4.3** 2020/10/22 mandic00@live.com - -### **0.4.2** 2020/10/20 mandic00@live.com -- log initialization - -### **0.4.1** 2020/10/19 mandic00@live.com -- breaking change: convert to object class -- compatibility notes - -### **0.3.9** 2020/10/18 mandic00@live.com -- implemented image filters -- pure tensor pipeline without image converts -- autodetect skipframes - -### **0.3.8** 2020/10/17 mandic00@live.com -- new menu layout - -### **0.3.7** 2020/10/17 mandic00@live.com -- added diagnostics output -- parallelized agegender operations - -### **0.3.6** 2020/10/17 mandic00@live.com -- fixed webcam initialization -- fixed memory leaks and added scoped runs -- modularized draw -- added state handling -- refactored package file layout - -### **0.3.5** 2020/10/16 mandic00@live.com -- added auto-generated changelog - -### **0.3.4** 2020/10/16 mandic00@live.com -- added camera selection -- optimized blazeface anchors -- added error handling - -### **0.3.3** 2020/10/15 mandic00@live.com -- added blazeface back and front models - -### **0.3.2** 2020/10/15 mandic00@live.com -- reduced web worker latency -- added debugging and versioning -- optimized demos and added scoped runs -- added multi backend support - -### **0.3.1** 2020/10/14 mandic00@live.com - -### **0.2.10** 2020/10/14 mandic00@live.com -- added emotion backend -- module parametrization and performance monitoring -- implemented multi-hand support -- fixed documentation typos - -### **0.2.9** 2020/10/13 mandic00@live.com -- added node build and demo - -### **0.2.8** 2020/10/13 mandic00@live.com -- added example image - -### **0.2.7** 2020/10/13 mandic00@live.com -- new examples - -### **0.2.6** 2020/10/13 mandic00@live.com -- enable all models by default - -### **0.2.5** 2020/10/12 mandic00@live.com -- fixed memory leak - -### **0.2.4** 2020/10/12 mandic00@live.com -- removed extra files - -### **0.2.3** 2020/10/12 mandic00@live.com - -### **0.2.2** 2020/10/12 mandic00@live.com - -### **tag: 1.0** 2020/10/12 mandic00@live.com - -### **0.2.1** 2020/10/12 mandic00@live.com -- added sample image -- initial public commit -- initial commit diff --git a/README.md b/README.md index 5597d93d..ac5ee664 100644 --- a/README.md +++ b/README.md @@ -2,69 +2,39 @@ ## 3D Face Detection, Body Pose, Hand & Finger Tracking, Iris Tracking, Age & Gender Prediction, Emotion Prediction & Gesture Recognition -- [**Documentation**](https://github.com/vladmandic/human#readme) +### Project pages: + +- [**Live Demo**](https://vladmandic.github.io/human/demo/index.html) - [**Code Repository**](https://github.com/vladmandic/human) - [**NPM Package**](https://www.npmjs.com/package/@vladmandic/human) - [**Issues Tracker**](https://github.com/vladmandic/human/issues) -- [**Change Log**](./CHANGELOG.md) -- [**Live Demo**](https://vladmandic.github.io/human/demo/index.html) +- [**Change Log**](https://github.com/vladmandic/human/wiki/Change-Log) + +### Wiki pages: + +- [**Home**](wiki) +- [**Installation**](wiki/Install) +- [**Usage**](wiki/Usage) +- [**Configuration**](wiki/Configuration) +- [**Outputs**](wiki/Outputs) +- [**Demos**](wiki/Demos) +- [**Development Server**](wiki/Development-Server) +- [**Build Process**](wiki/Build-Process) +- [**Profiling**](wiki/Profiling) +- [**Performance Notes**](wiki/Performance) +- [**Credits**](wiki/Credits) Compatible with *Browser*, *WebWorker* and *NodeJS* execution -Compatible with *CPU*, *WebGL*, *WASM* and *WebGPU* backends +- Browser/WebWorker: Compatible with *CPU*, *WebGL*, *WASM* and *WebGPU* backends +- NodeJS: Compatible with software *tfjs-node* and CUSA accelerated backends *tfjs-node-gpu* + (and maybe with React-Native as it doesn't use any DOM objects) *This is a pre-release project, see [issues](https://github.com/vladmandic/human/issues) for list of known limitations and planned enhancements* -*Suggestions are welcome!* +*Suggestions are welcome!* -
- -## Demo - -Demos are included in `/demo`: - -**Browser**: -- `index.html`: Full demo using Browser with ESM module, includes selectable backends and webworkers - it loads `dist/demo-browser-index.js` which is built from sources in `demo`, starting with `demo/browser` - alternatively you can load `demo/browser.js` directly - -*You can run browser demo either live from git pages, by serving demo folder from your web server or use -included micro http2 server with source file monitoring and dynamic rebuild* - -### Dev Server - -To start micro http2 dev server, you must provide your own SSL certificate (production or self-signed) -and place them in `dev-server.js` - -Once SSL certificates have been provided, simply run -```shell -npm run dev -``` -On first start, it will install all development dependencies required to rebuild `Human` library - -```log -> @vladmandic/human@0.7.5 dev /home/vlado/dev/human -> npm install && node --trace-warnings --unhandled-rejections=strict --trace-uncaught --no-deprecation dev-server.js - -audited 321 packages in 2.506s -found 0 vulnerabilities - -2020-11-06 16:19:09 INFO: @vladmandic/human version 0.7.5 -2020-11-06 16:19:09 INFO: User: vlado Platform: linux Arch: x64 Node: v15.0.1 -2020-11-06 16:19:09 STATE: HTTP2 server listening: 8000 -2020-11-06 16:19:09 STATE: Monitoring: [ 'package.json', 'config.js', 'demo', 'src', [length]: 4 ] -2020-11-06 16:19:16 DATA: GET/2.0 200 text/html 4866 / ::ffff:192.168.0.200 -2020-11-06 16:19:16 DATA: GET/2.0 200 text/javascript 1708910 /dist/demo-browser-index.js ::ffff:192.168.0.200 -``` - -*If you want to test `wasm` or `webgpu` backends, enable loading in `index.html`* - -**NodeJS**: -- `node.js`: Demo using NodeJS with CommonJS module - This is a very simple demo as althought `Human` library is compatible with NodeJS execution - and is able to load images and models from local filesystem, - -
+
## Examples @@ -74,512 +44,3 @@ found 0 vulnerabilities **Using webcam:** ![Example Using WebCam](assets/screenshot2.jpg) -
- -## Installation - -**Important** -*The packaged (IIFE and ESM) version of `Human` includes `TensorFlow/JS (TFJS) 2.7.0` library which can be accessed via `human.tf`* -*You should NOT manually load another instance of `tfjs`, but if you do, be aware of possible version conflicts* - -There are multiple ways to use `Human` library, pick one that suits you: - -### Included - -- `dist/human.js`: IIFE format bundle with TFJS for Browsers -- `dist/human.esm.js`: ESM format bundle with TFJS for Browsers -- `dist/human.esm-nobundle.js`: ESM format bundle without TFJS for Browsers -- `dist/human.node.js`: CommonJS format bundle with TFJS for NodeJS -- `dist/human.node-nobundle.js`: CommonJS format bundle without TFJS for NodeJS - -All versions include `sourcemap` *(.map)* and build `manifest` *(.json)* -While `Human` is in pre-release mode, all bundles are non-minified - -Defaults: -```json - { - "main": "dist/human.node.js", - "module": "dist/human.esm.js", - "browser": "dist/human.esm.js", - } -``` - -### 1. [IIFE](https://developer.mozilla.org/en-US/docs/Glossary/IIFE) script - -*Simplest way for usage within Browser* - -Simply download `dist/human.js`, include it in your `HTML` file & it's ready to use. - -```html -