learning-loop-node 0.20.0__py3-none-any.whl → 0.20.2__py3-none-any.whl

learning_loop_node/data_classes/general.py

@@ -185,3 +185,4 @@ class DetectorStatus():
     target_model: Optional[str]
     errors: Dict
     operation_mode: str
+    node_version: Optional[str] = None

learning_loop_node/detector/detector_node.py

@@ -52,6 +52,7 @@ class DetectorNode(Node):
                  uuid: Optional[str] = None, use_backdoor_controls: bool = False) -> None:
         super().__init__(name, uuid=uuid, node_type='detector', needs_login=False, needs_sio=False)
         self._detector_factory = detector_factory
+        self.node_version: Optional[str] = os.environ.get('NODE_VERSION')
         self._detector: _DetectorState = _Initializing()
         self._exclusive_model_build: bool = os.environ.get('EXCLUSIVE_MODEL_BUILD', '0').lower() in ('1', 'true')
         self._remaining_init_attempts: int = 2
@@ -409,6 +410,7 @@ class DetectorNode(Node):
             current_model=current_model,
             target_model=target_model_version,
             model_format=self._detector_factory.model_format,
+            node_version=self.node_version,
         )
 
         self.log_status_on_change(status.state, status)

learning_loop_node/detector/rest/operation_mode.py

@@ -19,7 +19,7 @@ async def put_operation_mode(request: Request):
 
     Example Usage
 
-        curl -X PUT -d "check_for_updates" http://localhost/operation_mode
+        curl -X PUT -d "idle" http://localhost/operation_mode
         curl -X PUT -d "detecting" http://localhost/operation_mode
     '''
 

learning_loop_node/trainer/trainer_logic.py

@@ -79,9 +79,12 @@ class TrainerLogic(TrainerLogicGeneric):
 
         except TrainingError:
             logging.exception('Exception in trainer_logic._train')
-            await self.executor.stop_and_wait()
             self.training.training_state = previous_state
             raise
+        finally:
+            # shield so the subprocess is stopped even when the task is cancelled (e.g. on abort())
+            if self._executor and self._executor.is_running():
+                await asyncio.shield(self.executor.stop_and_wait())
 
     async def _do_detections(self) -> None:
         context = self.training.context

{learning_loop_node-0.20.0.dist-info → learning_loop_node-0.20.2.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: learning_loop_node
-Version: 0.20.0
+Version: 0.20.2
 Summary: Python Library for Nodes which connect to the Zauberzeug Learning Loop
 Author-email: Zauberzeug GmbH <info@zauberzeug.com>
 License: MIT
@@ -140,6 +140,27 @@ The endpoint returns None if the upload was successful and an error message othe
 
 For both ways to upload an image, the tag `picked_by_system` is automatically added to the image metadata.
 
+### Node and model information
+
+The detector has a REST endpoint that reports what the node is currently doing and which model it has loaded:
+
+`curl http://localhost/about`
+
+The response contains:
+
+- `operation_mode`: the current operation mode (`startup`, `idle` or `detecting`)
+- `state`: the state of the node (e.g. `idle`, `online`, `detecting`)
+- `model_info`: information about the loaded model (id, organization, project, version, categories, resolution, model size), or `null` if no model is loaded yet
+- `target_model`: the model version the detector is trying to load, or `null` if none is set
+- `version_control`: the model versioning mode (`follow_loop`, `specific_version` or `pause`)
+
+The same information is available via the socketio event `about`:
+`sio.emit('about')`
+
+Use this endpoint if you need the model uuid or its categories. If you only need the version numbers, use `/model_version` (see below).
+
+All REST endpoints of the node are also listed in the automatically generated API documentation at `http://localhost/docs`.
+
 ### Changing the model versioning mode
 
 The detector can be configured to one of the following behaviors:
@@ -167,6 +188,22 @@ The model versioning configuration can also be changed via a socketio event:
 There is also a GET endpoint to fetch the current model versioning configuration:
 `sio.emit('get_model_version')` or `curl http://localhost/model_version`
 
+### Changing the operation mode
+
+The operation mode controls whether the detector may load a new model:
+
+- `startup`: used until the first model is loaded
+- `idle`: the detector checks for and performs model updates
+- `detecting`: the detector runs detections and does not load new models
+
+The mode can be read and changed via a REST endpoint. Example Usage:
+
+- Fetch the current operation mode: `curl http://localhost/operation_mode`
+- Allow model updates: `curl -X PUT -d "idle" http://localhost/operation_mode`
+- Block model updates: `curl -X PUT -d "detecting" http://localhost/operation_mode`
+
+The GET request returns the mode as plain text. The PUT request returns status code 422 if the given value is not one of the three modes above.
+
 ### Changing the outbox mode
 
 If the autoupload is set to `all` or `filtered` (selected) images and the corresponding detections are saved on HDD (the outbox). A background thread will upload the images and detections to the Learning Loop. The outbox is located in the `outbox` folder in the root directory of the node. The outbox can be cleared by deleting the files in the folder.

{learning_loop_node-0.20.0.dist-info → learning_loop_node-0.20.2.dist-info}/RECORD

@@ -12,13 +12,13 @@ learning_loop_node/data_classes/__init__.py,sha256=_2dxfVkkI9kNM955Y7ZE8RLgfpegZ
 learning_loop_node/data_classes/annotation_data.py,sha256=NfMlTv2_5AfVY_JDM4tbjETFjSN2S2I2LJJPMMcDT50,966
 learning_loop_node/data_classes/annotations.py,sha256=ha7uuWmZqW-LU2vYrkvfnaVpvf5C2xdm826IVVBu0w0,1848
 learning_loop_node/data_classes/detections.py,sha256=hGSKc1elk4Drp4XUjQ3F9HGeRpyLvA0q064b-S9lIug,5335
-learning_loop_node/data_classes/general.py,sha256=GQ6vPEIm4qqBV4RZT_YS_dPeKMdbCKo6Pe5-e4Cg3_k,7295
+learning_loop_node/data_classes/general.py,sha256=y_seXgqCWGoUCFzwZKt8eG8rAlANIG8VhzVVivZLklU,7334
 learning_loop_node/data_classes/image_metadata.py,sha256=4FFs89iZAfr2Jh-40QqZ_GGmJ8hl_W61eHcCqHflJLE,2293
 learning_loop_node/data_classes/socket_response.py,sha256=tIdt-oYf6ULoJIDYQCecNM9OtWR6_wJ9tL0Ksu83Vko,655
 learning_loop_node/data_classes/training.py,sha256=TybwcCDf_NUaDUaOj30lPm-7Z3Qk9XFRibEX5qIv96Y,5737
 learning_loop_node/detector/__init__.py,sha256=wroy0W1X5MX16C-peA-UHYrcdXet7GhleIlC_Pqa6hI,128
 learning_loop_node/detector/detector_logic.py,sha256=XJaHNiw5PaHoCWnJ-qsxdUELLevvztYx54TQ8KcHl18,1479
-learning_loop_node/detector/detector_node.py,sha256=CIHbBmKf49wxxxhrITCENeL72Wm-sJdZQV5x9_6ZlUc,35716
+learning_loop_node/detector/detector_node.py,sha256=As8QW2LaR81hsZePONAuf0RBNfoDEBEF18tIRM_-evs,35834
 learning_loop_node/detector/exceptions.py,sha256=C6KbNPlSbtfgDrZx2Hbhm7Suk9jVoR3fMRCO0CkrMsQ,196
 learning_loop_node/detector/outbox.py,sha256=6F0MjFM-zNX-xWP_YGbmU0UYuyb0odsX_OcAxMPSzS0,12288
 learning_loop_node/detector/inbox_filter/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
@@ -29,7 +29,7 @@ learning_loop_node/detector/rest/about.py,sha256=evHJ2svUZY_DFz0FSef5u9c5KW4Uc3G
 learning_loop_node/detector/rest/backdoor_controls.py,sha256=ZNaFOvC0OLWNtcLiG-NIqS_y1kkLP4csgk3CHhp8Gis,885
 learning_loop_node/detector/rest/detect.py,sha256=BHcQbSuC1sYHRKl2wNchiasb3A4HJk9tVia11e9TS6Y,2597
 learning_loop_node/detector/rest/model_version_control.py,sha256=P4FOG0U9HT6QtCoNt-1s1pT6drtgdVjGZWEuCAyuNmA,1370
-learning_loop_node/detector/rest/operation_mode.py,sha256=1_xfutA_6nzdb4Q_jZiHQ5m_wA83bcG5jSIy-sfNIvk,1575
+learning_loop_node/detector/rest/operation_mode.py,sha256=eHOqbPdyfgzLtlz8sYs3WjESQ_kvxEIEP-cMuDQnsDI,1562
 learning_loop_node/detector/rest/outbox_mode.py,sha256=H8coDNbgLGEfXmKQrhtXWeUHBAHpnrdZktuHXQz0xis,1148
 learning_loop_node/detector/rest/upload.py,sha256=MditQ4Tu9PRzW6vhO-I9TJcnjOFpD83XnHx-6uUURkU,1708
 learning_loop_node/enums/__init__.py,sha256=tjSrhztIQ8W656_QuXfTbbVNtH_wDXP5hpYZgzfgRhc,285
@@ -50,12 +50,12 @@ learning_loop_node/trainer/exceptions.py,sha256=vbuoE6kssLQuA8zd3LiDHmZglP6E2IJJ
 learning_loop_node/trainer/executor.py,sha256=XQ1TwgOF2pQv7bgzSaljDWG4I1ySjYXL8r9c_p9MX1Q,3947
 learning_loop_node/trainer/io_helpers.py,sha256=zWl0-HLP8zxOG3ybm76vXgEozULj_1QRl95jkrF126k,7255
 learning_loop_node/trainer/test_executor.py,sha256=6BVGDN_6f5GEMMEvDLSG1yzMybSvgXaP5uYpSfsVPP0,2224
-learning_loop_node/trainer/trainer_logic.py,sha256=pcVQXVICEZ0Tu6WbMtuciOCETMeQAq8SAoCj3sEF0-Y,8479
+learning_loop_node/trainer/trainer_logic.py,sha256=BgkeDEVaRVuRETYMt2rKe5cspExTgnO7LXNVYVbIcsw,8679
 learning_loop_node/trainer/trainer_logic_generic.py,sha256=IRP68ZGpnOX4OS03OwB7HmTUvk6nbBRmCjMCVupGE_Q,27196
 learning_loop_node/trainer/trainer_node.py,sha256=ZnydfHJ2ehAhb821Xke_09qthCE3vDf7iqeYUrliSSo,4938
 learning_loop_node/trainer/rest/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 learning_loop_node/trainer/rest/backdoor_controls.py,sha256=ZnK8ypY5r_q0-YZbtaOxhQThzuZvMsQHM5gJGESd_dE,5131
-learning_loop_node-0.20.0.dist-info/METADATA,sha256=mrnQ8e97A5zQTk8HSj_LxVzZ9rQq711XRQteman88lw,15383
-learning_loop_node-0.20.0.dist-info/WHEEL,sha256=aeYiig01lYGDzBgS8HxWXOg3uV61G9ijOsup-k9o1sk,91
-learning_loop_node-0.20.0.dist-info/top_level.txt,sha256=nS5qiFc4stVF_VXVCVJxZnrqVOv3IGX5-_E3sLby6OE,19
-learning_loop_node-0.20.0.dist-info/RECORD,,
+learning_loop_node-0.20.2.dist-info/METADATA,sha256=wx_DLGWg99OEC3AUymtRgjVo7k1BHz-aOSPCjPunCg4,17175
+learning_loop_node-0.20.2.dist-info/WHEEL,sha256=K260EYznzXsJYBQGqmI8VTxEdiZYNvDZwW9cBh9-_MA,91
+learning_loop_node-0.20.2.dist-info/top_level.txt,sha256=nS5qiFc4stVF_VXVCVJxZnrqVOv3IGX5-_E3sLby6OE,19
+learning_loop_node-0.20.2.dist-info/RECORD,,

{learning_loop_node-0.20.0.dist-info → learning_loop_node-0.20.2.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: setuptools (82.0.1)
+Generator: setuptools (83.0.0)
 Root-Is-Purelib: true
 Tag: py3-none-any