Adding New Module

A newly trained model is provided together with its corresponding description file. These files belong together and should always be uploaded and handled as one unit.

The steps below cover ctrlX OS and a PC; the screenshots show the ctrlX OS web interface.

  1. Upload the new model and its description file as described in Uploading Data.

    For details about the model files, see Models Folder.

  2. Open the ai-object-matching.json application settings:

    • On ctrlX OS: left-click the ai-object-matching.json file name. The JSON settings open on the right.

    • On a PC: open the file in the settings folder with a text editor.

    ai-object-matching.json settings with the new module file listed

  3. Enter the name of the uploaded module description file in the modules field.

    modules field in ai-object-matching.json highlighting the new module file name
    Currently, only one module is supported at a time. Remove the previous module from the modules field when switching to a new one.

  4. Open the uploaded module description file:

    • On ctrlX OS: left-click its file name. The module settings open on the right.

    • On a PC: open the file with a text editor.

    New module file listing with its JSON content open on the right

  5. Verify that the neuralNetworkConfig parameter points to the newly uploaded model description JSON file.

    neuralNetworkConfig field highlighted in the new module’s JSON content

  6. Verify the remaining settings as described in Module Configuration File.

  7. Save the changes.

Restart the LumiScan AI Object Matching application after changing the configuration.

A module can also be created and activated through the Data Layer, see Adding and removing modules.