FAQ

Short answers to common questions and error messages for LumiScan Training. Each entry links to the page with the details.

Search this page for the exact error message. Each entry has a fixed anchor (for example #faq-json-paths-null).

Requirements and installation

What are the system requirements?

Answer
  • Windows 11 Professional or Windows 11 Enterprise

  • NVIDIA RTX graphics card

  • CUDA Toolkit 11.8

  • CodeMeter 9.00 or later

More

Requirements

How do I install LumiScan Training, and do I need Python?

Answer

Run the setup program (file name starts with Installer_ and ends with the version number, for example Installer_LumiScanTrainingFramework_v2_1_0_0.exe) and confirm the prompt for administrator rights; they are required for the default location under C:\Program Files. The setup program contains its own Python environment, so a separate Python or Anaconda installation is not required. English and German are available as installation languages.

More

LumiScan Training Installation

In which order do I install the components for a Hailo TPU?

Answer

Only needed if a Hailo TPU is used. Keep this order: the Hailo PlugIn checks its prerequisites one after another and stops at the first missing one, so a different order may require additional installation attempts.

  1. Podman CLI 6.0.x for Windows, with Windows Hyper-V as the virtualization provider (the Hailo PlugIn image is built for Podman 6.0; newer CLIs are not tested).

  2. The Hailo PlugIn (setup file name begins with Installer-LumiScanTraining-HailoPlugIn). The installation can take 10 to 20 minutes or longer; do not interrupt it.

  3. LumiScan Training.

More

Installing Podman, Installing the Hailo PlugIn

What does the computer need for the Hailo PlugIn?

Answer

At least 24 GB of system memory (DRAM), because the model conversion runs in a virtual machine configured with 18 GB of memory, and hardware that supports Hyper-V. Hyper-V does not need to be enabled beforehand; the Hailo PlugIn installer offers to enable it. Hyper-V is not available on Windows Home editions, so the Hailo PlugIn cannot be used there.

More

Requirements, Installing Podman

Windows Firewall asks whether podman.exe may access the network. What should I do?

Answer

It is recommended to decline the request with Cancel. Model conversion runs entirely on the local computer and also works if network access is declined.

More

Installing the Hailo PlugIn

Configuration and training

How do I write paths and empty values in the JSON configuration?

Answer

Use forward slashes (/) instead of backslashes (\) in paths, for example C:/Users/user_name/Desktop/recordings/raw. For a parameter that supports an empty value, write null exactly like this, without quotation marks or capital letters (for example "networkBase": null to train without an existing network).

More

JSON Parameters Description

Which value do I use for networkType?

Applies to

LumiScan VGR and AI Object Matching

Answer
  • LumiScan VGR: ORTML, ORTMM, ORTMS or ORTMXS (oriented models) if the object has a meaningful orientation that must be identified; RRTML, RRTMM, RRTMS or RRTMXS (rotated models) if only the rotation is needed. The suffix sets the size (L, M, S, XS); ORTM and RRTM without suffix are not valid.

  • AI Object Matching: OOD for objects with a meaningful orientation, ROD if only the rotation is needed.

More

JSON Parameters Description

Where are the trained models and results stored?

Answer

Exported ONNX models and other training results are stored in exportDirectory; if no path is specified, in the directory of the training data (trainingData). Start Testing stores its results in the export folder, and Start Inference saves the predictions in the predictions folder within the export directory.

More

JSON Parameters Description, User Interface

What do the messages in Process Status mean?

Answer
  • Waiting for configuration file!: no configuration file has been selected yet (use Select Config File/Browse).

  • Testing Network!: an existing network is being tested with the test data set after Start Testing.

  • Waiting for deployment!: after training, the network is being prepared for conversion and export to an ONNX file.

  • Finished cleanup: the process has finished.

  • Latest test scores: a metric to compare networks tested with the same data set, not an absolute measure of performance.

More

User Interface

Model conversion (ONNX to Hailo)

Which calibration images do I need for the model conversion?

Answer

The calibration images must have the same resolution as the training images; otherwise the model can be unusable. Record them under real production conditions (same camera, optics, working distance and objects) and include representative lighting conditions. Store them in a single folder; supported formats include .png, .jpg, .jpeg, .bmp and .tiff.

More

Model Conversion: ONNX to Hailo

Which files does the conversion create?

Answer

After Conversion finished successfully., the output folder contains <name>.hef (model for the Hailo TPU), <name>.har (intermediate archive), <name>_hailo.onnx (ONNX model adapted for Hailo) and convert_parameters.json (conversion parameters), where <name> is the name of the ONNX file. By default, the output folder is the folder containing the ONNX file.

More

Model Conversion Parameters

Shared backend

How can several computers use one LumiScan Training backend?

Answer

On the server, open App Settings, keep Start backend locally enabled, set Backend bind address to the computer’s network IP address or 0.0.0.0 (all interfaces) (not localhost (127.0.0.1)), enable Autostart backend as a service, click Save and restart. Clients either open http://<server-ip>:8420 in a web browser, or disable Start backend locally in their own installation and enter the server under Remote backend address.

More

Setting Up a Shared Backend Server, Connecting from a Client Computer

Licensing and support

How is LumiScan Training licensed?

Answer

LumiScan Training needs CodeMeter 9.00 or later. Bought from HD Vision Systems, the licence is on the LumiScan Key and is an annual subscription. Bought in the ctrlX Store for Windows 11, it uses ctrlX WORKS together with the LumiScan Key. One LumiScan Key is needed per device that runs the software at the same time; keys can be exchanged between devices.

More

Requirements, Licensing FAQ

Where can I get further help?

Answer

See the site-wide LumiScan FAQ. Contact customer support at customer.success@hdvisionsystems.com or +49 6221 6721905. For licences, write to licenses@hdvisionsystems.com.