Minor updates

Author: lanreolokoba

.github/workflows/publish.yml

@@ -0,0 +1,19 @@
+name: Publish to NPM
+
+on:
+  release:
+    types: [published]
+  workflow_dispatch:
+
+jobs:
+  npm:
+    runs-on: ubuntu-latest
+    env:
+      NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
+    steps:
+    - uses: actions/checkout@v2
+    - uses: actions/setup-node@v2
+      with:
+        registry-url: 'https://registry.npmjs.org'
+    - run: npm publish --access public
+      working-directory: Packages/ai.natml.vision.nanodet

Assets/NanoDetDetection.cs

@@ -3,7 +3,7 @@
 *   Copyright (c) 2022 NatML Inc. All Rights Reserved.
 */
 
-namespace NatML.Visualizers {
+namespace NatML.Examples.Visualizers {
 
     using UnityEngine;
     using UnityEngine.UI;

Assets/NanoDetSample.cs

@@ -10,19 +10,19 @@ namespace NatML.Examples {
     using NatML.Devices.Outputs;
     using NatML.Features;
     using NatML.Vision;
-    using NatML.Visualizers;
+    using Visualizers;
 
     public sealed class NanoDetSample : MonoBehaviour {
 
         [Header(@"UI")]
         public NanoDetVisualizer visualizer;
 
-        CameraDevice cameraDevice;
-        TextureOutput textureOutput;
+        private CameraDevice cameraDevice;
+        private TextureOutput cameraTextureOutput;
 
-        MLModelData modelData;
-        MLModel model;
-        NanoDetPredictor predictor;
+        private MLModelData modelData;
+        private MLModel model;
+        private NanoDetPredictor predictor;
 
         async void Start () {
             // Request permissions
@@ -35,11 +35,11 @@ async void Start () {
             var query = new MediaDeviceQuery(MediaDeviceCriteria.CameraDevice);
             cameraDevice = query.current as CameraDevice;
             // Start the preview
-            textureOutput = new TextureOutput();
-            cameraDevice.StartRunning(textureOutput);
+            cameraTextureOutput = new TextureOutput();
+            cameraDevice.StartRunning(cameraTextureOutput);
             // Display the camera preview
-            var previewTexture = await textureOutput;
-            visualizer.Render(previewTexture);
+            var cameraTexture = await cameraTextureOutput;
+            visualizer.image = cameraTexture;
             // Create the NanoDet predictor
             modelData = await MLModelData.FromHub("@natsuite/nanodet");
             model = modelData.Deserialize();
@@ -51,15 +51,18 @@ void Update () {
             if (predictor == null)
                 return;
             // Create input feature
-            var inputFeature = new MLImageFeature(textureOutput.texture);
-            (inputFeature.mean, inputFeature.std) = modelData.normalization;
-            inputFeature.aspectMode = modelData.aspectMode;
+            var imageFeature = new MLImageFeature(cameraTextureOutput.texture);
+            (imageFeature.mean, imageFeature.std) = modelData.normalization;
+            imageFeature.aspectMode = modelData.aspectMode;
             // Detect
-            var detections = predictor.Predict(inputFeature);
+            var detections = predictor.Predict(imageFeature);
             // Visualize
-            visualizer.Render(textureOutput.texture, detections);
+            visualizer.Render(detections);
         }
 
-        void OnDisable () => model?.Dispose();
+        void OnDisable () {
+            // Dispose the model
+            model?.Dispose();
+        }
     }
 }

Assets/NanoDetVisualizer.cs

@@ -3,7 +3,7 @@
 *   Copyright (c) 2022 NatML Inc. All Rights Reserved.
 */
 
-namespace NatML.Visualizers {
+namespace NatML.Examples.Visualizers {
 
     using System.Collections.Generic;
     using UnityEngine;
@@ -14,22 +14,33 @@ namespace NatML.Visualizers {
     [RequireComponent(typeof(RawImage), typeof(AspectRatioFitter))]
     public sealed class NanoDetVisualizer : MonoBehaviour {
 
+        #region --Inspector--
+        public NanoDetDetection detectionPrefab;
+        #endregion
+
+
         #region --Client API--
+        /// <summary>
+        /// Detection source image.
+        /// </summary>
+        public Texture2D image {
+            get => rawImage.texture as Texture2D;
+            set {
+                rawImage.texture = value;
+                aspectFitter.aspectRatio = (float)value.width / value.height;
+            }
+        }
+
         /// <summary>
         /// Render a set of object detections.
         /// </summary>
         /// <param name="image">Image which detections are made on.</param>
         /// <param name="detections">Detections to render.</param>
-        public void Render (Texture image, params (Rect rect, string label, float score)[] detections) {
+        public void Render (params (Rect rect, string label, float score)[] detections) {
             // Delete current
             foreach (var rect in currentRects)
                 GameObject.Destroy(rect.gameObject);
             currentRects.Clear();
-            // Display image
-            var rawImage = GetComponent<RawImage>();
-            var aspectFitter = GetComponent<AspectRatioFitter>();
-            rawImage.texture = image;
-            aspectFitter.aspectRatio = (float)image.width / image.height;
             // Render rects
             var imageRect = new Rect(0, 0, image.width, image.height);
             foreach (var detection in detections) {
@@ -43,8 +54,14 @@ public void Render (Texture image, params (Rect rect, string label, float score)
 
 
         #region --Operations--
-        [SerializeField] NanoDetDetection detectionPrefab;
-        List<NanoDetDetection> currentRects = new List<NanoDetDetection>();
+        private RawImage rawImage;
+        private AspectRatioFitter aspectFitter;
+        private readonly List<NanoDetDetection> currentRects = new List<NanoDetDetection>();
+
+        void Awake () {
+            rawImage = GetComponent<RawImage>();
+            aspectFitter = GetComponent<AspectRatioFitter>();
+        }
         #endregion
     }
 }

Packages/ai.natml.vision.nanodet/Changelog.md

@@ -1,8 +1,2 @@
-## 1.0.2
-+ Upgraded to NatML 1.0.11.
-
-## 1.0.1
-+ Upgraded to NatML 1.0.9.
-
 ## 1.0.0
 + First release.

Packages/ai.natml.vision.nanodet/README.md

@@ -1,5 +1,23 @@
 # NanoDet
-[NanoDet](https://github.com/RangiLyu/nanodet) high performance general object detection. This package requires [NatML](https://github.com/natmlx/NatML).
+[NanoDet](https://github.com/RangiLyu/nanodet) high performance general object detection.
+
+## Installing NanoDet
+Add the following items to your Unity project's `Packages/manifest.json`:
+```json
+{
+  "scopedRegistries": [
+    {
+      "name": "NatML",
+      "url": "https://registry.npmjs.com",
+      "scopes": ["ai.natml"]
+    }
+  ],
+  "dependencies": {
+    "ai.natml.vision.nanodet": "1.0.0"
+  }
+}
+```
+
 
 ## Detecting Objects in an Image
 First, create the NanoDet predictor:
@@ -16,7 +34,7 @@ Then detect objects in the image:
 ```csharp
 // Create image feature
 Texture2D image = ...;
-var imageFeature = new MLImageFeature(image); // This also accepts a `Color32[]` or `byte[]`
+var imageFeature = new MLImageFeature(image);
 (imageFeature.mean, imageFeature.std) = modelData.normalization;
 imageFeature.aspectMode = modelData.aspectMode;
 // Detect objects
@@ -27,13 +45,12 @@ imageFeature.aspectMode = modelData.aspectMode;
 ___
 
 ## Requirements
-- Unity 2020.3+
-- [NatML 1.0.11+](https://github.com/natmlx/NatML)
+- Unity 2021.2+
 
 ## Quick Tips
+- Join the [NatML community on Discord](https://hub.natml.ai/community).
 - Discover more ML models on [NatML Hub](https://hub.natml.ai).
 - See the [NatML documentation](https://docs.natml.ai/unity).
-- Join the [NatML community on Discord](https://discord.gg/y5vwgXkz2f).
 - Discuss [NatML on Unity Forums](https://forum.unity.com/threads/open-beta-natml-machine-learning-runtime.1109339/).
 - Contact us at [hi@natml.ai](mailto:hi@natml.ai).
 

Packages/ai.natml.vision.nanodet/Runtime/NanoDetPredictor.cs

@@ -43,6 +43,9 @@ public NanoDetPredictor (MLModel model, string[] labels, float minScore = 0.35f,
             this.anchors8 = GenerateAnchors(inputType.width, inputType.height, 8);
             this.anchors16 = GenerateAnchors(inputType.width, inputType.height, 16);
             this.anchors32 = GenerateAnchors(inputType.width, inputType.height, 32);
+            this.candidateBoxes = new List<Rect>();
+            this.candidateScores = new List<float>();
+            this.candidateLabels = new List<string>();
         }
 
         /// <summary>
@@ -70,13 +73,13 @@ public unsafe (Rect rect, string label, float score)[] Predict (params MLFeature
             var displacements8 = new MLArrayFeature<float>(outputFeatures[3]);      // (1,1600,32)
             var displacements16 = new MLArrayFeature<float>(outputFeatures[4]);     // (1,400,32)
             var displacements32 = new MLArrayFeature<float>(outputFeatures[5]);     // (1,100,32)
-            var candidateBoxes = new List<Rect>();
-            var candidateScores = new List<float>();
-            var candidateLabels = new List<string>();
             var softmax = stackalloc float[8];
             var boxEdges = stackalloc float[4];
             var featureWidthInv = 1f / inputType.width;
             var featureHeightInv = 1f / inputType.height;
+            candidateBoxes.Clear();
+            candidateScores.Clear();
+            candidateLabels.Clear();
             foreach (var (stride, logits, displacements, anchors) in new [] {
                 (8, logits8, displacements8, anchors8),
                 (16, logits16, displacements16, anchors16),
@@ -136,6 +139,9 @@ public unsafe (Rect rect, string label, float score)[] Predict (params MLFeature
         private readonly Vector2[] anchors8;
         private readonly Vector2[] anchors16;
         private readonly Vector2[] anchors32;
+        private readonly List<Rect> candidateBoxes;
+        private readonly List<float> candidateScores;
+        private readonly List<string> candidateLabels;
 
         void IDisposable.Dispose () { } // Not used
 

Packages/ai.natml.vision.nanodet/package.json

@@ -3,9 +3,9 @@
     "version": "1.0.0",
     "displayName": "NanoDet",
     "description": "Anchor-free ultra-fast object detection.",
-    "unity": "2020.3",
+    "unity": "2021.2",
     "dependencies": {
-        "ai.natml.natml": "1.0.17"
+        "ai.natml.natml": "1.0.18"
     },
     "keywords": [
         "natml",
@@ -24,5 +24,5 @@
         "url": "https://github.com/natmlx"
     },
     "license": "Apache-2.0",
-    "repository": "github:natmlx/NatML"
+    "repository": "github:natmlx/NanoDet"
 }

Packages/manifest.json

@@ -7,7 +7,7 @@
     }
   ],
   "dependencies": {
-    "ai.natml.natdevice": "1.2.3",
+    "ai.natml.natdevice": "1.2.5",
     "com.unity.collab-proxy": "1.15.17",
     "com.unity.feature.development": "1.0.1",
     "com.unity.ide.rider": "3.0.14",

Packages/packages-lock.json

@@ -2,22 +2,22 @@
   "dependencies": {
     "ai.natml.hub": {
       "version": "1.0.12",
-      "depth": 2,
+      "depth": 1,
       "source": "registry",
       "dependencies": {},
       "url": "https://registry.npmjs.com"
     },
     "ai.natml.natdevice": {
-      "version": "1.2.3",
+      "version": "1.2.5",
       "depth": 0,
       "source": "registry",
       "dependencies": {
-        "ai.natml.hub": "1.0.10"
+        "ai.natml.hub": "1.0.12"
       },
       "url": "https://registry.npmjs.com"
     },
     "ai.natml.natml": {
-      "version": "1.0.17",
+      "version": "1.0.18",
       "depth": 1,
       "source": "registry",
       "dependencies": {
@@ -30,7 +30,7 @@
       "depth": 0,
       "source": "embedded",
       "dependencies": {
-        "ai.natml.natml": "1.0.17"
+        "ai.natml.natml": "1.0.18"
       }
     },
     "com.unity.collab-proxy": {

ProjectSettings/ProjectSettings.asset

@@ -137,7 +137,8 @@ PlayerSettings:
     16:9: 1
     Others: 1
   bundleVersion: 0.1
-  preloadedAssets: []
+  preloadedAssets:
+  - {fileID: 0}
   metroInputSource: 0
   wsaTransparentSwapchain: 0
   m_HolographicPauseOnTrackingLoss: 1
@@ -791,12 +792,12 @@ PlayerSettings:
   webGLNameFilesAsHashes: 0
   webGLDataCaching: 1
   webGLDebugSymbols: 0
-  webGLEmscriptenArgs: 
+  webGLEmscriptenArgs: ' --bind '
   webGLModulesDirectory: 
   webGLTemplate: APPLICATION:Default
   webGLAnalyzeBuildSize: 0
   webGLUseEmbeddedResources: 0
-  webGLCompressionFormat: 1
+  webGLCompressionFormat: 2
   webGLWasmArithmeticExceptions: 0
   webGLLinkerTarget: 1
   webGLThreadsSupport: 0

README.md

@@ -1,2 +1,37 @@
 # NanoDet
-*INCOMPLETE*
+
+![demo](demo.gif)
+
+Anchor-free ultra-fast object detection.
+
+## Running the Sample
+Retrieve your access key from [NatML Hub](https://hub.natml.ai/profile) and add it to your Project Settings. Note that running the sample code requires an active [NatML Cloud](https://www.natml.ai/pricing) subscription:
+
+![project settings](https://github.com/natmlx/NatDevice/raw/main/.media/key.png)
+
+## Using the Predictor in a Different Project
+[See the predictor README for more details](Packages/ai.natml.vision.nanodet/README.md).
+
+## Requirements
+- Unity 2021.2+
+
+## Supported Platforms
+- Android API level 24+
+- iOS 13+
+- macOS 10.15+ (Apple Silicon and Intel)
+- Windows 10+ (64-bit only)
+- WebGL:
+    - Chrome 91+
+    - Firefox 90+
+
+## Resources
+- Join the [NatML community on Discord](https://hub.natml.ai/community).
+- See the [NatML documentation](https://docs.natml.ai/unity).
+- See the [NatDevice documentation](https://docs.natml.ai/natdevice).
+- Check out [NatML on GitHub](https://github.com/natmlx).
+- Read the [NatML blog](https://blog.natml.ai/).
+- Discuss [NatML on Unity Forums](https://forum.unity.com/threads/open-beta-natml-machine-learning-runtime.1109339/).
+- Discuss [NatDevice on Unity Forums](https://forum.unity.com/threads/natdevice-media-device-api.374690/).
+- Contact us at [hi@natml.ai](mailto:hi@natml.ai).
+
+Thank you very much!