Package: learning-loop-node
Learning Loop NodeThis Python library helps to write Nodes that interact with the Zauberzeug Learning Loop. There are 4 types of Nodes:TypePurposeTrainerRuns training using the latest training dataDetectorLoads latest models from Loop and performs inferenceAnnotatorUsed for custom annotation inside the LoopConverterConverts between different model formatsGeneral UsageTo start a node you have to implement the logic by inheriting from the corresponding base logic class. We provide samples in the 'mock' folders and recommend to follow that scheme. A complete trainer and detector example can be foundhere.Environment variablesYou can configure connection to our Learning Loop by specifying the following environment variables before starting:NameAliasPurposeRequired byLOOP_HOSTHOSTLearning Loop address (e.g. learning-loop.ai)allLOOP_USERNAMEUSERNAMELearning Loop user nameall besides DetectorLOOP_PASSWORDPASSWORDLearning Loop passwordall besides DetectorLOOP_ORGANIZATIONORGANIZATIONOrganization nameDetectorLOOP_PROJECTPROJECTProject nameDetectorMIN_UNCERTAIN_THRESHOLDPROJECTsmallest confidence (float) at which auto-upload will happenDetectorMAX_UNCERTAIN_THRESHOLDPROJECTlargest confidence (float) at which auto-upload will happenDetectorINFERENCE_BATCH_SIZE-Batch size of trainer when calculating detectionsTrainer (opt.)RESTART_AFTER_TRAINING-Restart the trainer after training (set to 1)Trainer (opt.)KEEP_OLD_TRAININGS-Do not delete old trainings (set to 1)Trainer (opt.)TestingWe use github actions for CI. Tests can also be executed locally by runningLOOP_HOST=XXXXXXXX LOOP_USERNAME=XXXXXXXX LOOP_PASSWORD=XXXXXXXX python -m pytest -vfrom learning_loop_node/learning_loop_nodeDetector NodeDetector Nodes are normally deployed on edge devices like robots or machinery but can also run in the cloud to provide backend services for an app or similar. These nodes register themself at the Learning Loop. They provide REST and Socket.io APIs to run inference on images. The processed images can automatically be used for active learning: e.g. uncertain predictions will be send to the Learning Loop.Images can be send to the detector node via socketio or rest.
The later approach can be used via curl,Example usage:curl --request POST -F 'file=@test.jpg' localhost:8004/detectWhere 8804 is the specified port in this example.
You can additionally provide the following camera parameters:autoupload: configures auto-submission to the learning loop;filtered(default),all,disabled(example curl parameter-H 'autoupload: all')camera-id: a string which groups images for submission together (example curl parameter-H 'camera-id: front_cam')The detector also has a sioupload endpointthat can be used to upload images and detections to the learning loop. The function receives a json dictionary, with the following entries:image: the image data in jpg formattags: a list of strings. If not provided the tag ispicked_by_systemdetections: a dictionary representing the detections. UUIDs for the classes are automatically determined based on the category names. This field is optional. If not provided, no detections are uploaded.The endpoint returns None if the upload was successful and an error message otherwise.Trainer NodeTrainers fetch the images and anntoations from the Learning Loop to train new models.if the command line tool "jpeginfo" is installed, the downloader will drop corrupted images automaticallyConverter NodeA Conveter Node converts models from one format into another.Annotator Node...Test operabilityAssumend there is a Converter Node which converts models of format 'format_a' into 'format_b'.
Upload a model withcurl --request POST -F 'files=@my_model.zip' https://learning-loop.ai/api/zauberzeug/projects/demo/format_aThe model should now be available for the format 'format_a'curl "https://learning-loop.ai/api/zauberzeug/projects/demo/models?format=format_a"{
"models": [
{
"id": "3c20d807-f71c-40dc-a996-8a8968aa5431",
"version": "4.0",
"formats": [
"format_a"
],
"created": "2021-06-01T06:28:21.289092",
"comment": "uploaded at 2021-06-01 06:28:21.288442",
...
}
]
}

```

but not in the format_b
`curl "https://learning-loop.ai/api/zauberzeug/projects/demo/models?format=format_b"`

```

{
"models": []
}

```

Connect the Node to the Learning Loop by simply starting the container.
After a short time the converted model should be available as well.
`curl https://learning-loop.ai/api/zauberzeug/projects/demo/models?format=format_b`

```

{
"models": [
{
"id": "3c20d807-f71c-40dc-a996-8a8968aa5431",
"version": "4.0",
"formats": [
"format_a",
"format_b",
],
"created": "2021-06-01T06:28:21.289092",
"comment": "uploaded at 2021-06-01 06:28:21.288442",
...
}
]
}

```

## About Models (the currency between Nodes)

- Models are packed in zips and saved on the Learning Loop (one for each format)
- Nodes and users can upload and download models with which they want to work
- In each zip there is a file called `model.json` which contains the metadata to interpret the other files in the package
- for base models (pretrained models from external sources) no `model.json` has to be sent, ie. these models should simply be zipped in such a way that the respective trainer can work with them.
- the loop adds or corrects the following properties in the `model.json` after receiving; it also creates the file if it is missing:
  - `host`: uri to the loop
  - `organization`: the ID of the organization
  - `project`: the id of the project
  - `version`: the version number that the loop assigned for this model (e.g. 1.3)
  - `id`: the model UUID (currently not needed by anyone, since host, org, project, version clearly identify the model)
  - `format`: the format e.g. yolo, tkdnn, yolor etc.
- Nodes add properties to `model.json`, which contains all the information which are needed by subsequent nodes. These are typically the properties:
  - `resolution`: resolution in which the model expects images (as `int`, since the resolution is mostly square - later, ` resolution_x`` resolution_y ` would also be conceivable or `resolutions` to give a list of possible resolutions)
  - `categories`: list of categories with name, id, (later also type), in the order in which they are used by the model -- this is neccessary to be robust about renamings
```