add local support in 1.4.0 release (#69)

Author: bonastreyair

CHANGELOG.md

@@ -2,13 +2,19 @@
 
 All notable changes to this project will be documented in this file following a [Semantic Versioning](https://semver.org/spec/v2.0.0.html). The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
 
-## Unreleased
+## [1.4.0] - 2022-11-30
+
+### Added
+
+- Local Mode Support
 
 ### Changed
 
 - Improved code structure
-- Upgraded `node-fetch` to version `3.1.0`
-- Upgraded `pureimage` to version `0.3.6`
+- Upgrade pre-commit dependencies
+- Dependency change from `@tensorflow/tfjs` to `@tensorflow/tfjs-node`
+- Upgraded `node-fetch` to version `3.3.0`
+- Upgraded `pureimage` to version `0.3.14`
 
 ## [1.3.1] - 2021-10-09
 
@@ -243,3 +249,4 @@ All notable changes to this project will be documented in this file following a
 [1.2.2]: https://github.com/bonastreyair/node-red-contrib-teachable-machine/compare/v1.2.1...v1.2.2
 [1.3.0]: https://github.com/bonastreyair/node-red-contrib-teachable-machine/compare/v1.2.2...v1.3.0
 [1.3.1]: https://github.com/bonastreyair/node-red-contrib-teachable-machine/compare/v1.3.0...v1.3.1
+[1.4.0]: https://github.com/bonastreyair/node-red-contrib-teachable-machine/compare/v1.3.1...v1.4.0

README.md

@@ -46,11 +46,25 @@ Select `Tensorflow.js` format and upload your trained model (for free). Once it
 
 ![use_teachable_machine](https://user-images.githubusercontent.com/37800834/79056723-8431a100-7c59-11ea-9488-346f4f8e6004.png)
 
+Once the URL is generated it will show the stored files.
+
+![model_files](https://user-images.githubusercontent.com/37800834/204745026-40cf7cec-6775-4e78-a454-4c82271d613f.png)
+
 ### Step 3
 
-Paste the saved URL into the node configuration. That URL hosts all the information to load your trained model. Make sure you copy all the given URL including the `https://...`.
+#### **Online Mode**
+
+Select Online Mode and paste the saved URL in the node configuration. That URL hosts all the information to load your trained model. Make sure you copy all the given URL including the `https://...` and the `/` in the end.
+
+![online-config](https://user-images.githubusercontent.com/37800834/204746402-2551eb8c-576c-40fa-a250-7f0f93a9d670.png)
+
+#### **Local Mode**
+
+Download all three files from the generated URL and save them locally in a folder maintaning the original filenames.
+
+Select Local Mode and write down the absolute path of the folder that contain the three downloaded files in the node configuration. Make sure it ends with a `/` noting it is a folder.
 
-![config](https://user-images.githubusercontent.com/37800834/80922980-e8d7ab80-8d80-11ea-8c0c-89d1008455da.png)
+![local-config](https://user-images.githubusercontent.com/37800834/204746412-fafc1b81-6431-4cb3-82bb-d4a29e415108.png)
 
 ### Step 4
 

examples/basic.json

@@ -61,7 +61,7 @@
     "z": "17514116325f40c5",
     "name": "",
     "mode": "online",
-    "modelUrl": "https://teachablemachine.withgoogle.com/models/49PRz_c_9/",
+    "modelUri": "https://teachablemachine.withgoogle.com/models/49PRz_c_9/",
     "localModel": "teachable_model",
     "output": "best",
     "activeThreshold": false,

examples/local_test.json

@@ -20,7 +20,7 @@
     "z": "17514116325f40c5",
     "name": "",
     "mode": "online",
-    "modelUrl": "https://teachablemachine.withgoogle.com/models/49PRz_c_9/",
+    "modelUri": "https://teachablemachine.withgoogle.com/models/49PRz_c_9/",
     "localModel": "teachable_model",
     "output": "best",
     "activeThreshold": false,