├── .gitignore ├── LICENSE ├── README.MD ├── git_media ├── dataset.png ├── header.png ├── homepage.png ├── kangaroo-demo.gif └── webcam.gif ├── models └── kangaroo-detector │ ├── group1-shard1of5.bin │ ├── group1-shard2of5.bin │ ├── group1-shard3of5.bin │ ├── group1-shard4of5.bin │ ├── group1-shard5of5.bin │ └── model.json ├── package-lock.json ├── package.json ├── public └── index.html └── src ├── index.js └── styles.css /.gitignore: -------------------------------------------------------------------------------- 1 | node_modules 2 | .cache -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | 2 | Apache License 3 | Version 2.0, January 2004 4 | https://www.apache.org/licenses/ 5 | 6 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 7 | 8 | 1. Definitions. 9 | 10 | "License" shall mean the terms and conditions for use, reproduction, 11 | and distribution as defined by Sections 1 through 9 of this document. 12 | 13 | "Licensor" shall mean the copyright owner or entity authorized by 14 | the copyright owner that is granting the License. 15 | 16 | "Legal Entity" shall mean the union of the acting entity and all 17 | other entities that control, are controlled by, or are under common 18 | control with that entity. For the purposes of this definition, 19 | "control" means (i) the power, direct or indirect, to cause the 20 | direction or management of such entity, whether by contract or 21 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 22 | outstanding shares, or (iii) beneficial ownership of such entity. 23 | 24 | "You" (or "Your") shall mean an individual or Legal Entity 25 | exercising permissions granted by this License. 26 | 27 | "Source" form shall mean the preferred form for making modifications, 28 | including but not limited to software source code, documentation 29 | source, and configuration files. 30 | 31 | "Object" form shall mean any form resulting from mechanical 32 | transformation or translation of a Source form, including but 33 | not limited to compiled object code, generated documentation, 34 | and conversions to other media types. 35 | 36 | "Work" shall mean the work of authorship, whether in Source or 37 | Object form, made available under the License, as indicated by a 38 | copyright notice that is included in or attached to the work 39 | (an example is provided in the Appendix below). 40 | 41 | "Derivative Works" shall mean any work, whether in Source or Object 42 | form, that is based on (or derived from) the Work and for which the 43 | editorial revisions, annotations, elaborations, or other modifications 44 | represent, as a whole, an original work of authorship. For the purposes 45 | of this License, Derivative Works shall not include works that remain 46 | separable from, or merely link (or bind by name) to the interfaces of, 47 | the Work and Derivative Works thereof. 48 | 49 | "Contribution" shall mean any work of authorship, including 50 | the original version of the Work and any modifications or additions 51 | to that Work or Derivative Works thereof, that is intentionally 52 | submitted to Licensor for inclusion in the Work by the copyright owner 53 | or by an individual or Legal Entity authorized to submit on behalf of 54 | the copyright owner. For the purposes of this definition, "submitted" 55 | means any form of electronic, verbal, or written communication sent 56 | to the Licensor or its representatives, including but not limited to 57 | communication on electronic mailing lists, source code control systems, 58 | and issue tracking systems that are managed by, or on behalf of, the 59 | Licensor for the purpose of discussing and improving the Work, but 60 | excluding communication that is conspicuously marked or otherwise 61 | designated in writing by the copyright owner as "Not a Contribution." 62 | 63 | "Contributor" shall mean Licensor and any individual or Legal Entity 64 | on behalf of whom a Contribution has been received by Licensor and 65 | subsequently incorporated within the Work. 66 | 67 | 2. Grant of Copyright License. Subject to the terms and conditions of 68 | this License, each Contributor hereby grants to You a perpetual, 69 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 70 | copyright license to reproduce, prepare Derivative Works of, 71 | publicly display, publicly perform, sublicense, and distribute the 72 | Work and such Derivative Works in Source or Object form. 73 | 74 | 3. Grant of Patent License. Subject to the terms and conditions of 75 | this License, each Contributor hereby grants to You a perpetual, 76 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 77 | (except as stated in this section) patent license to make, have made, 78 | use, offer to sell, sell, import, and otherwise transfer the Work, 79 | where such license applies only to those patent claims licensable 80 | by such Contributor that are necessarily infringed by their 81 | Contribution(s) alone or by combination of their Contribution(s) 82 | with the Work to which such Contribution(s) was submitted. If You 83 | institute patent litigation against any entity (including a 84 | cross-claim or counterclaim in a lawsuit) alleging that the Work 85 | or a Contribution incorporated within the Work constitutes direct 86 | or contributory patent infringement, then any patent licenses 87 | granted to You under this License for that Work shall terminate 88 | as of the date such litigation is filed. 89 | 90 | 4. Redistribution. You may reproduce and distribute copies of the 91 | Work or Derivative Works thereof in any medium, with or without 92 | modifications, and in Source or Object form, provided that You 93 | meet the following conditions: 94 | 95 | (a) You must give any other recipients of the Work or 96 | Derivative Works a copy of this License; and 97 | 98 | (b) You must cause any modified files to carry prominent notices 99 | stating that You changed the files; and 100 | 101 | (c) You must retain, in the Source form of any Derivative Works 102 | that You distribute, all copyright, patent, trademark, and 103 | attribution notices from the Source form of the Work, 104 | excluding those notices that do not pertain to any part of 105 | the Derivative Works; and 106 | 107 | (d) If the Work includes a "NOTICE" text file as part of its 108 | distribution, then any Derivative Works that You distribute must 109 | include a readable copy of the attribution notices contained 110 | within such NOTICE file, excluding those notices that do not 111 | pertain to any part of the Derivative Works, in at least one 112 | of the following places: within a NOTICE text file distributed 113 | as part of the Derivative Works; within the Source form or 114 | documentation, if provided along with the Derivative Works; or, 115 | within a display generated by the Derivative Works, if and 116 | wherever such third-party notices normally appear. The contents 117 | of the NOTICE file are for informational purposes only and 118 | do not modify the License. You may add Your own attribution 119 | notices within Derivative Works that You distribute, alongside 120 | or as an addendum to the NOTICE text from the Work, provided 121 | that such additional attribution notices cannot be construed 122 | as modifying the License. 123 | 124 | You may add Your own copyright statement to Your modifications and 125 | may provide additional or different license terms and conditions 126 | for use, reproduction, or distribution of Your modifications, or 127 | for any such Derivative Works as a whole, provided Your use, 128 | reproduction, and distribution of the Work otherwise complies with 129 | the conditions stated in this License. 130 | 131 | 5. Submission of Contributions. Unless You explicitly state otherwise, 132 | any Contribution intentionally submitted for inclusion in the Work 133 | by You to the Licensor shall be under the terms and conditions of 134 | this License, without any additional terms or conditions. 135 | Notwithstanding the above, nothing herein shall supersede or modify 136 | the terms of any separate license agreement you may have executed 137 | with Licensor regarding such Contributions. 138 | 139 | 6. Trademarks. This License does not grant permission to use the trade 140 | names, trademarks, service marks, or product names of the Licensor, 141 | except as required for reasonable and customary use in describing the 142 | origin of the Work and reproducing the content of the NOTICE file. 143 | 144 | 7. Disclaimer of Warranty. Unless required by applicable law or 145 | agreed to in writing, Licensor provides the Work (and each 146 | Contributor provides its Contributions) on an "AS IS" BASIS, 147 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 148 | implied, including, without limitation, any warranties or conditions 149 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 150 | PARTICULAR PURPOSE. You are solely responsible for determining the 151 | appropriateness of using or redistributing the Work and assume any 152 | risks associated with Your exercise of permissions under this License. 153 | 154 | 8. Limitation of Liability. In no event and under no legal theory, 155 | whether in tort (including negligence), contract, or otherwise, 156 | unless required by applicable law (such as deliberate and grossly 157 | negligent acts) or agreed to in writing, shall any Contributor be 158 | liable to You for damages, including any direct, indirect, special, 159 | incidental, or consequential damages of any character arising as a 160 | result of this License or out of the use or inability to use the 161 | Work (including but not limited to damages for loss of goodwill, 162 | work stoppage, computer failure or malfunction, or any and all 163 | other commercial damages or losses), even if such Contributor 164 | has been advised of the possibility of such damages. 165 | 166 | 9. Accepting Warranty or Additional Liability. While redistributing 167 | the Work or Derivative Works thereof, You may choose to offer, 168 | and charge a fee for, acceptance of support, warranty, indemnity, 169 | or other liability obligations and/or rights consistent with this 170 | License. However, in accepting such obligations, You may act only 171 | on Your own behalf and on Your sole responsibility, not on behalf 172 | of any other Contributor, and only if You agree to indemnify, 173 | defend, and hold each Contributor harmless for any liability 174 | incurred by, or claims asserted against, such Contributor by reason 175 | of your accepting any such warranty or additional liability. 176 | 177 | END OF TERMS AND CONDITIONS 178 | 179 | Copyright 2013-2018 Docker, Inc. 180 | 181 | Licensed under the Apache License, Version 2.0 (the "License"); 182 | you may not use this file except in compliance with the License. 183 | You may obtain a copy of the License at 184 | 185 | https://www.apache.org/licenses/LICENSE-2.0 186 | 187 | Unless required by applicable law or agreed to in writing, software 188 | distributed under the License is distributed on an "AS IS" BASIS, 189 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 190 | See the License for the specific language governing permissions and 191 | limitations under the License. -------------------------------------------------------------------------------- /README.MD: -------------------------------------------------------------------------------- 1 | # Real-time object detection in the browser using TensorFlow.js 2 | 3 | This repository is part of the tutorial [Custom real-time object detection in the browser using TensorFlow.js](https://blog.tensorflow.org/2021/01/custom-object-detection-in-browser.html). **For a better understanding of how to create a custom object detection model, refer to the post**. 4 | 5 | 6 | This project is a simple web-app that loads a model in the TensorFlow.js layers format using javascript and performs real-time inferences ingesting videos from a PC or mobile camera. 7 | 8 | A Kangaroo detector was trained as a demo, but any object can be recognized following the [tutorial steps](https://medium.com/@zaninihugo/custom-real-time-object-detection-in-the-browser-using-tensorflow-js-5ca90538eace) and it will produce results similar to the shown below: 9 | 10 | ![Object detection demo](./git_media/kangaroo-demo.gif) 11 |
12 | 13 | 14 | 15 | A live demo is available on Glitch:
16 | Qries 18 | 19 | 21 | 22 | 23 | ## Getting started 24 | 25 | The model saved at `models/kangaroo-detector` was trained using the [kangaroo-dataset](https://www.kaggle.com/hugozanini1/kangaroodataset) available on kaggle: 26 | 27 | 28 | Qries 30 | 31 | 33 | 34 | 35 | 36 | You can train your own model, upload it in the `model` folder and load as well. 37 | 38 | #### Serving the model 39 | 40 | To make the model available, it is necessary to define how the model is going to be loaded in the function `load_model` (lines 10–15 in the file `src>index.js`). There are two choices. 41 | 42 | The first option is to create an _HTTP server_ locally that will make the model available in a URL allowing requests and be treated as a REST API. When loading the model, _TensorFlow.js_ will do the following requests: 43 | 44 | ``` 45 | GET /model.json 46 | GET /group1-shard1of5.bin 47 | GET /group1-shard2of5.bin 48 | GET /group1-shard3of5.bin 49 | GET /group1-shardo4f5.bin 50 | GET /group1-shardo5f5.bin 51 | ``` 52 | 53 | If you choose this option, define the `load_model` function as follows: 54 | 55 | 56 | ```js 57 | async function load_model() { 58 | // It's possible to load the model locally or from a repo 59 | const model = await loadGraphModel("http://127.0.0.1:8080/model.json"); 60 | //const model = await loadGraphModel("https://raw.githubusercontent.com/hugozanini/TFJS-object-detection/master/models/kangaroo-detector/model.json"); 61 | return model; 62 | } 63 | ``` 64 | Then install the [http-server](https://www.npmjs.com/package/http-server): 65 | 66 | ``` 67 | npm install http-server -g 68 | ``` 69 | 70 | Go to `models > kangaroo-detector` and run the command below to make the model available at `http://127.0.0.1:8080` . This a good choice when you want to keep the model weights in a safe place and control who can request inferences to it. 71 | 72 | ``` 73 | http-server -c1 --cors . 74 | ``` 75 | The second option is to upload the model files somewhere, in my case, I chose my own Github repo and referenced to the `model.json` URL in the `load_model` function: 76 | homepage.png 77 | ```js 78 | async function load_model() { 79 | // It's possible to load the model locally or from a repo 80 | //const model = await loadGraphModel("http://127.0.0.1:8080/model.json"); 81 | const model = await loadGraphModel("https://raw.githubusercontent.com/hugozanini/TFJS-object-detection/master/models/kangaroo-detector/model.json"); 82 | return model; 83 | } 84 | ``` 85 | 86 | This is a good option because it gives more flexibility to the application and makes it easier to run on some platform as [Glitch](https://glitch.com/). 87 | 88 | #### Running locally 89 | To run the app locally, install the required packages: 90 | 91 | ``` 92 | npm install 93 | ``` 94 | 95 | And start: 96 | 97 | ``` 98 | npm start 99 | ``` 100 | 101 | The application is going to run at `[http://localhost:3000](http://localhost:3000)` and you should see something similar to this: 102 | 103 | ![App home page](./git_media/homepage.png) 104 | 105 | The model takes from 1 to 2 seconds to load and, after that, you can show the objects images to the camera and the application is going to draw bounding boxes around them. 106 | 107 | -------------------------------------------------------------------------------- /git_media/dataset.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/hugozanini/TFJS-object-detection/4735463af4c596ce56434608cba7f30210dfed5b/git_media/dataset.png -------------------------------------------------------------------------------- /git_media/header.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/hugozanini/TFJS-object-detection/4735463af4c596ce56434608cba7f30210dfed5b/git_media/header.png -------------------------------------------------------------------------------- /git_media/homepage.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/hugozanini/TFJS-object-detection/4735463af4c596ce56434608cba7f30210dfed5b/git_media/homepage.png -------------------------------------------------------------------------------- /git_media/kangaroo-demo.gif: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/hugozanini/TFJS-object-detection/4735463af4c596ce56434608cba7f30210dfed5b/git_media/kangaroo-demo.gif -------------------------------------------------------------------------------- /git_media/webcam.gif: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/hugozanini/TFJS-object-detection/4735463af4c596ce56434608cba7f30210dfed5b/git_media/webcam.gif -------------------------------------------------------------------------------- /models/kangaroo-detector/group1-shard1of5.bin: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/hugozanini/TFJS-object-detection/4735463af4c596ce56434608cba7f30210dfed5b/models/kangaroo-detector/group1-shard1of5.bin -------------------------------------------------------------------------------- /models/kangaroo-detector/group1-shard2of5.bin: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/hugozanini/TFJS-object-detection/4735463af4c596ce56434608cba7f30210dfed5b/models/kangaroo-detector/group1-shard2of5.bin -------------------------------------------------------------------------------- /models/kangaroo-detector/group1-shard3of5.bin: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/hugozanini/TFJS-object-detection/4735463af4c596ce56434608cba7f30210dfed5b/models/kangaroo-detector/group1-shard3of5.bin -------------------------------------------------------------------------------- /models/kangaroo-detector/group1-shard4of5.bin: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/hugozanini/TFJS-object-detection/4735463af4c596ce56434608cba7f30210dfed5b/models/kangaroo-detector/group1-shard4of5.bin -------------------------------------------------------------------------------- /models/kangaroo-detector/group1-shard5of5.bin: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/hugozanini/TFJS-object-detection/4735463af4c596ce56434608cba7f30210dfed5b/models/kangaroo-detector/group1-shard5of5.bin -------------------------------------------------------------------------------- /package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "tensorflowjs-real-time-object-detection", 3 | "version": "1.0.0", 4 | "description": "", 5 | "keywords": [], 6 | "main": "src/index.js", 7 | "dependencies": { 8 | "@tensorflow/tfjs": "^1.7.4", 9 | "@tensorflow/tfjs-converter": "^1.7.4", 10 | "@tensorflow/tfjs-core": "^1.7.4", 11 | "@tensorflow/tfjs-node": "^1.7.4", 12 | "react": "16.5.2", 13 | "react-dom": "16.5.2", 14 | "react-magic-dropzone": "1.0.1", 15 | "react-scripts": "2.0.3" 16 | }, 17 | "devDependencies": {}, 18 | "scripts": { 19 | "start": "react-scripts start", 20 | "build": "react-scripts build", 21 | "test": "react-scripts test --env=jsdom", 22 | "eject": "react-scripts eject" 23 | }, 24 | "browserslist": [ 25 | ">0.2%", 26 | "not dead", 27 | "not ie <= 11", 28 | "not op_mini all" 29 | ] 30 | } 31 | -------------------------------------------------------------------------------- /public/index.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 7 | 8 | 9 | 10 | 11 | 20 | Object detection 21 | 22 | 23 | 24 | 27 |
28 |
29 | 39 | 40 | 41 | -------------------------------------------------------------------------------- /src/index.js: -------------------------------------------------------------------------------- 1 | import React from "react"; 2 | import ReactDOM from "react-dom"; 3 | import * as tf from '@tensorflow/tfjs'; 4 | import {loadGraphModel} from '@tensorflow/tfjs-converter'; 5 | import "./styles.css"; 6 | tf.setBackend('webgl'); 7 | 8 | const threshold = 0.75; 9 | 10 | async function load_model() { 11 | // It's possible to load the model locally or from a repo 12 | // You can choose whatever IP and PORT you want in the "http://127.0.0.1:8080/model.json" just set it before in your https server 13 | //const model = await loadGraphModel("http://127.0.0.1:8080/model.json"); 14 | const model = await loadGraphModel("https://raw.githubusercontent.com/hugozanini/TFJS-object-detection/master/models/kangaroo-detector/model.json"); 15 | return model; 16 | } 17 | 18 | let classesDir = { 19 | 1: { 20 | name: 'Kangaroo', 21 | id: 1, 22 | }, 23 | 2: { 24 | name: 'Other', 25 | id: 2, 26 | } 27 | } 28 | 29 | class App extends React.Component { 30 | videoRef = React.createRef(); 31 | canvasRef = React.createRef(); 32 | 33 | 34 | componentDidMount() { 35 | if (navigator.mediaDevices && navigator.mediaDevices.getUserMedia) { 36 | const webCamPromise = navigator.mediaDevices 37 | .getUserMedia({ 38 | audio: false, 39 | video: { 40 | facingMode: "user" 41 | } 42 | }) 43 | .then(stream => { 44 | window.stream = stream; 45 | this.videoRef.current.srcObject = stream; 46 | return new Promise((resolve, reject) => { 47 | this.videoRef.current.onloadedmetadata = () => { 48 | resolve(); 49 | }; 50 | }); 51 | }); 52 | 53 | const modelPromise = load_model(); 54 | 55 | Promise.all([modelPromise, webCamPromise]) 56 | .then(values => { 57 | this.detectFrame(this.videoRef.current, values[0]); 58 | }) 59 | .catch(error => { 60 | console.error(error); 61 | }); 62 | } 63 | } 64 | 65 | detectFrame = (video, model) => { 66 | tf.engine().startScope(); 67 | model.executeAsync(this.process_input(video)).then(predictions => { 68 | this.renderPredictions(predictions, video); 69 | requestAnimationFrame(() => { 70 | this.detectFrame(video, model); 71 | }); 72 | tf.engine().endScope(); 73 | }); 74 | }; 75 | 76 | process_input(video_frame){ 77 | const tfimg = tf.browser.fromPixels(video_frame).toInt(); 78 | const expandedimg = tfimg.transpose([0,1,2]).expandDims(); 79 | return expandedimg; 80 | }; 81 | 82 | buildDetectedObjects(scores, threshold, boxes, classes, classesDir) { 83 | const detectionObjects = [] 84 | var video_frame = document.getElementById('frame'); 85 | 86 | scores[0].forEach((score, i) => { 87 | if (score > threshold) { 88 | const bbox = []; 89 | const minY = boxes[0][i][0] * video_frame.offsetHeight; 90 | const minX = boxes[0][i][1] * video_frame.offsetWidth; 91 | const maxY = boxes[0][i][2] * video_frame.offsetHeight; 92 | const maxX = boxes[0][i][3] * video_frame.offsetWidth; 93 | bbox[0] = minX; 94 | bbox[1] = minY; 95 | bbox[2] = maxX - minX; 96 | bbox[3] = maxY - minY; 97 | detectionObjects.push({ 98 | class: classes[i], 99 | label: classesDir[classes[i]].name, 100 | score: score.toFixed(4), 101 | bbox: bbox 102 | }) 103 | } 104 | }) 105 | return detectionObjects 106 | } 107 | 108 | renderPredictions = predictions => { 109 | const ctx = this.canvasRef.current.getContext("2d"); 110 | ctx.clearRect(0, 0, ctx.canvas.width, ctx.canvas.height); 111 | 112 | // Font options. 113 | const font = "16px sans-serif"; 114 | ctx.font = font; 115 | ctx.textBaseline = "top"; 116 | 117 | //Getting predictions 118 | const boxes = predictions[4].arraySync(); 119 | const scores = predictions[5].arraySync(); 120 | const classes = predictions[6].dataSync(); 121 | const detections = this.buildDetectedObjects(scores, threshold, 122 | boxes, classes, classesDir); 123 | 124 | detections.forEach(item => { 125 | const x = item['bbox'][0]; 126 | const y = item['bbox'][1]; 127 | const width = item['bbox'][2]; 128 | const height = item['bbox'][3]; 129 | 130 | // Draw the bounding box. 131 | ctx.strokeStyle = "#00FFFF"; 132 | ctx.lineWidth = 4; 133 | ctx.strokeRect(x, y, width, height); 134 | 135 | // Draw the label background. 136 | ctx.fillStyle = "#00FFFF"; 137 | const textWidth = ctx.measureText(item["label"] + " " + (100 * item["score"]).toFixed(2) + "%").width; 138 | const textHeight = parseInt(font, 10); // base 10 139 | ctx.fillRect(x, y, textWidth + 4, textHeight + 4); 140 | }); 141 | 142 | detections.forEach(item => { 143 | const x = item['bbox'][0]; 144 | const y = item['bbox'][1]; 145 | 146 | // Draw the text last to ensure it's on top. 147 | ctx.fillStyle = "#000000"; 148 | ctx.fillText(item["label"] + " " + (100*item["score"]).toFixed(2) + "%", x, y); 149 | }); 150 | }; 151 | 152 | render() { 153 | return ( 154 |
155 |

Real-Time Object Detection: Kangaroo

156 |

MobileNetV2

157 |
175 | ); 176 | } 177 | } 178 | 179 | const rootElement = document.getElementById("root"); 180 | ReactDOM.render(, rootElement); 181 | -------------------------------------------------------------------------------- /src/styles.css: -------------------------------------------------------------------------------- 1 | .size { 2 | position: fixed; 3 | top: 0; 4 | left: 0; 5 | } --------------------------------------------------------------------------------