near_ir_person

README

near-ir-person

This is a standalone ml service module that only detects people seen by a near infrared camera. The underlying model is an SSD mobilenet V2 architecture exported to an ONNX format. The bundles the ONNX runtime within it.

Configure this mlmodel service as a modular resource and link it with the built-in mlmodel vision service to detect people when using a near infrared camera.

Getting started

The first step is to configure a camera on your robot. Here is an example of how to configure a webcam. The next step is to configure both the mlmodel service and a vision service.

[!NOTE]
Before configuring your mlmodel service or vision service, you must create a robot.

Configuration

Navigate to the Config tab of your robot’s page in the Viam app. Click on the Services subtab and click Create service. Select the mlmodel type, then select the near-ir-person model. Enter a name for your service and click Create.

The ML Model service is configured fully upon creation, there are no attributes to fill out.

In order to see the detections from the model you will also need to create a vision service. Click on the Services subtab and click Create service. Select the vision type, then select the mlmodel model. Enter a name for your service and click Create. Then you should see the ml model service you configured in the drop down.

Example Configuration

{
  "modules": [
    {
      "type": "registry",
      "name": "viam_near-ir-person-detector",
      "module_id": "viam-labs:near-ir-person-detector",
      "version": "0.0.2"
    }
  ],
  "services": [
    {
      "name": "ir-person-mlmodel",
      "type": "mlmodel",
      "namespace": "rdk",
      "model": "viam-labs:mlmodel:near-ir-person",
      "attributes": {}
    },
    {
      "name": "ir-people",
      "type": "vision",
      "model": "mlmodel",
      "attributes": {
        "mlmodel_name": "ir-person-mlmodel"
      }
    }
  ]
}

[!NOTE]
For more information, see Configure a Robot.

Attributes

There are no attributes associated with this module. It only runs the person detector for near IR cameras.

Usage

This module is made for use with the following methods of the mlmodel service API:

• Infer()
• Metadata()

This module expects one input tensor of the form [1, 300, 300, 3] i.e. a single RGB 300 x 300 resolution image.

Visualize

Once the viam-labs:mlmodel:near-ir-person and viam:vision:mlmodel services are in use, configure a transform camera detections appear in your robot's field of vision.

Documentation

Index

• Variables
• func InitModel(name resource.Name, logger logging.Logger) (*nearIRPerson, error)
• type Config

Variables

var Model = resource.ModelNamespace("viam-labs").WithFamily("mlmodel").WithModel("near-ir-person")

Functions

func InitModel

func InitModel(name resource.Name, logger logging.Logger) (*nearIRPerson, error)

Types

type Config

type Config struct {
	resource.TriviallyValidateConfig
}