learning-loop-node 0.27.2__tar.gz → 0.29.0__tar.gz

{learning_loop_node-0.27.2 → learning_loop_node-0.29.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: learning_loop_node
-Version: 0.27.2
+Version: 0.29.0
 Summary: Python Library for Nodes which connect to the Zauberzeug Learning Loop
 Author-email: Zauberzeug GmbH <info@zauberzeug.com>
 License: MIT
@@ -129,6 +129,8 @@ The `batch_detect` endpoint receives a dictionary, with the same entries as the
 
 - `images`: List of image data dictionaries, each with the same structure as the `image` entry in the `detect` endpoint
 
+The entries `camera_id`, `tags`, `source` and `creation_date` apply to every image of the batch. An image data dictionary may also carry its own: its `tags` are added to those of the batch, while its `camera_id`, `source` and `creation_date` replace those of the batch. This way a batch can hold images of several cameras, each filtered and uploaded as its own camera's.
+
 Sending a camera's JPEG as it is (`format: 'jpeg'`) saves the bandwidth of a raw pixel array and spares the detector a re-encode for the upload.
 
 Example code can be found [in the rosys implementation](https://github.com/zauberzeug/rosys/blob/main/rosys/vision/detector_hardware.py).
@@ -256,6 +258,17 @@ Trainers fetch the images and anntoations from the Learning Loop to train new mo
 
 - if the command line tool "jpeginfo" is installed, the downloader will drop corrupted images automatically
 
+### Training results
+
+Together with its model, a trainer uploads the results of the training to the Learning Loop, e.g. the
+metrics per epoch, the evaluation curves and the confusion matrix. The trainer decides which files
+they are, grouped into the parts `core`, `examples` and `logs`; a trainer that names none uploads
+only its model. `core` is always uploaded, the examples and the raw training log only if the
+training's `upload_examples` and `upload_logs` hyperparameters are true (both default to false).
+The results are sent right after the model and never stop the training: results the Learning Loop
+does not store, e.g. beyond the 5 GiB it keeps per training, are logged and skipped, and a part
+that gets no answer or a server error is sent up to three times.
+
 ### Several trainers on one GPU
 
 Trainers that share a GPU (say, one per model architecture on the same machine) coordinate through

{learning_loop_node-0.27.2 → learning_loop_node-0.29.0}/README.md

@@ -96,6 +96,8 @@ The `batch_detect` endpoint receives a dictionary, with the same entries as the
 
 - `images`: List of image data dictionaries, each with the same structure as the `image` entry in the `detect` endpoint
 
+The entries `camera_id`, `tags`, `source` and `creation_date` apply to every image of the batch. An image data dictionary may also carry its own: its `tags` are added to those of the batch, while its `camera_id`, `source` and `creation_date` replace those of the batch. This way a batch can hold images of several cameras, each filtered and uploaded as its own camera's.
+
 Sending a camera's JPEG as it is (`format: 'jpeg'`) saves the bandwidth of a raw pixel array and spares the detector a re-encode for the upload.
 
 Example code can be found [in the rosys implementation](https://github.com/zauberzeug/rosys/blob/main/rosys/vision/detector_hardware.py).
@@ -223,6 +225,17 @@ Trainers fetch the images and anntoations from the Learning Loop to train new mo
 
 - if the command line tool "jpeginfo" is installed, the downloader will drop corrupted images automatically
 
+### Training results
+
+Together with its model, a trainer uploads the results of the training to the Learning Loop, e.g. the
+metrics per epoch, the evaluation curves and the confusion matrix. The trainer decides which files
+they are, grouped into the parts `core`, `examples` and `logs`; a trainer that names none uploads
+only its model. `core` is always uploaded, the examples and the raw training log only if the
+training's `upload_examples` and `upload_logs` hyperparameters are true (both default to false).
+The results are sent right after the model and never stop the training: results the Learning Loop
+does not store, e.g. beyond the 5 GiB it keeps per training, are logged and skipped, and a part
+that gets no answer or a server error is sent up to three times.
+
 ### Several trainers on one GPU
 
 Trainers that share a GPU (say, one per model architecture on the same machine) coordinate through

{learning_loop_node-0.27.2 → learning_loop_node-0.29.0}/learning_loop_node/data_classes/__init__.py

@@ -26,10 +26,11 @@ from .general import (
     NodeState,
     NodeStatus,
 )
-from .image_metadata import ImageMetadata, ImagesMetadata
+from .image_metadata import CaptureMetadata, ImageMetadata, ImagesMetadata
 from .socket_response import SocketResponse
 from .training import (
     Errors,
+    Hyperparameter,
     PretrainedModel,
     Training,
     TrainingError,
@@ -43,8 +44,8 @@ __all__ = [
     'BoxDetection', 'ClassificationDetection', 'ImageMetadata', 'Observation', 'Point', 'PointDetection',
     'SegmentationDetection', 'Shape', 'Detections',
     'AnnotationNodeStatus', 'Category', 'Context', 'DetectorStatus', 'ErrorConfiguration',
-    'ModelInformation', 'NodeState', 'NodeStatus', 'ModelVersionResponse', 'ImagesMetadata',
+    'ModelInformation', 'NodeState', 'NodeStatus', 'ModelVersionResponse', 'ImagesMetadata', 'CaptureMetadata',
     'SocketResponse',
-    'Errors', 'PretrainedModel', 'Training',
+    'Errors', 'Hyperparameter', 'PretrainedModel', 'Training',
     'TrainingError', 'TrainingOut', 'TrainingStateData', 'TrainingStatus',
 ]

{learning_loop_node-0.27.2 → learning_loop_node-0.29.0}/learning_loop_node/data_classes/image_metadata.py

@@ -56,3 +56,16 @@ class ImageMetadata():
 @dataclass(**KWONLY_SLOTS)
 class ImagesMetadata():
     items: List[ImageMetadata] = field(default_factory=list, metadata={'description': 'List of image metadata'})
+
+
+@dataclass(**KWONLY_SLOTS)
+class CaptureMetadata:
+    """Where an image comes from and how it is tagged."""
+    camera_id: str | None = field(default=None, metadata={
+        'description': 'Camera the image was taken with; selects the history of the relevance filter'})
+    tags: list[str] = field(default_factory=list, metadata={
+        'description': 'Tags of the image'})
+    source: str | None = field(default=None, metadata={
+        'description': 'Source of the image'})
+    creation_date: str | None = field(default=None, metadata={
+        'description': 'Creation date of the image'})

{learning_loop_node-0.27.2 → learning_loop_node-0.29.0}/learning_loop_node/data_classes/training.py

@@ -3,7 +3,7 @@ import sys
 import time
 from dataclasses import dataclass, field
 from pathlib import Path
-from typing import Any, Dict, List, Optional
+from typing import Any, Dict, List, Literal, Optional
 from uuid import uuid4
 
 from ..enums import TrainerState
@@ -22,6 +22,28 @@ class PretrainedModel():
     description: str
 
 
+HyperparameterType = Literal['int', 'float', 'bool', 'str', 'pairs']
+
+
+@dataclass(**KWONLY_SLOTS)
+class Hyperparameter:
+    """One hyperparameter a trainer accepts, reported to the loop so it can offer it in the project settings.
+
+    Plain data only, so it reaches the loop as it is. ``minimum`` and ``maximum`` apply to ``int`` and ``float``,
+    ``choices`` to ``str``. A ``pairs`` value is text of the form ``"key:value,..."``, which ``parse_pairs`` reads.
+    ``notes`` help whoever sets the value. ``expert`` ones are offered behind an expansion.
+    Whether a value can be changed when a training is started is the project's choice, not the trainer's.
+    """
+    name: str
+    type: HyperparameterType
+    default: Any
+    minimum: float | None = None
+    maximum: float | None = None
+    choices: list[str] | None = None
+    notes: str = ''
+    expert: bool = False
+
+
 @dataclass(**KWONLY_SLOTS)
 class TrainingStatus():
     id: str  # NOTE this must not be changed, but tests wont detect a change -> update tests!
@@ -33,6 +55,7 @@ class TrainingStatus():
     progress: Optional[float]
 
     pretrained_models: List[PretrainedModel] = field(default_factory=list)
+    hyperparameters: list[Hyperparameter] = field(default_factory=list)
     architecture: Optional[str] = None
     context: Optional[Context] = None
 

{learning_loop_node-0.27.2 → learning_loop_node-0.29.0}/learning_loop_node/data_exchanger.py

@@ -14,7 +14,12 @@ import aiofiles  # type: ignore
 from .data_classes import Context
 from .helpers.misc import create_resource_paths, create_task, is_valid_image, is_valid_uuid4
 from .loop_communication import LoopCommunicator
-from .trainer.exceptions import CriticalError, ModelUploadFailedError
+from .trainer.exceptions import (
+    CriticalError,
+    ModelUploadFailedError,
+    TrainingResultsNotAnsweredError,
+    TrainingResultsUploadFailedError,
+)
 
 logger = logging.getLogger(__name__)
 
@@ -207,6 +212,23 @@ class DataExchanger():
                     training_number, mformat, uploaded_model)
         return uploaded_model['id']
 
+    async def upload_training_results(self, context: Context, training_number: int, part: str, zip_path: str) -> None:
+        """Store one part of a training's results beside its latest model; a part sent again replaces the stored one.
+
+        :raise TrainingResultsUploadFailedError: If the loop answered with a client error other than 408.
+        :raise TrainingResultsNotAnsweredError: If the loop answered 408 or a server error.
+        """
+        path = (f'/{context.organization}/projects/{context.project}/trainings/{training_number}'
+                f'/training_results/{part}')
+        response = await self.loop_communicator.put(path, files=[zip_path], timeout=60*10)
+        if response.status_code == HTTPStatus.REQUEST_TIMEOUT or response.status_code >= 500:
+            raise TrainingResultsNotAnsweredError(f'The loop did not answer the upload of the {part} results of '
+                                                  f'training {training_number}: {response.status_code} {response.text}')
+        if response.status_code != HTTPStatus.OK:
+            raise TrainingResultsUploadFailedError(f'The loop did not store the {part} results of training '
+                                                   f'{training_number}: {response.status_code} {response.text}')
+        logger.info('Uploaded the %s results of training %s', part, training_number)
+
 
 def _rejects_upload(status_code: int) -> bool:
     """A client error other than 408 and 429 answers the same however often the upload is sent."""

{learning_loop_node-0.27.2 → learning_loop_node-0.29.0}/learning_loop_node/detector/detector_node.py

@@ -19,6 +19,7 @@ from socketio import AsyncClient
 
 from ..data_classes import (
     AboutResponse,
+    CaptureMetadata,
     Context,
     DetectorStatus,
     ImageMetadata,
@@ -272,10 +273,16 @@ class DetectorNode(Node):
 
             Data dict follows the schema of the detect endpoint,
             but 'images' is a list of image dicts.
+            Each image dict may also carry its own:
+            - camera_id: replaces the camera_id of the batch
+            - tags: added to the tags of the batch
+            - source: replaces the source of the batch
+            - creation_date: replaces the creation_date of the batch
             """
             try:
                 images_data = data['images']
                 images = [image_from_dict(image) for image in images_data]
+                capture_metadata = [_capture_metadata(data, image) for image in images_data]
             except Exception:
                 self.log.exception('could not parse images from socketio')
                 return {'error': 'could not parse images from data'}
@@ -283,11 +290,8 @@ class DetectorNode(Node):
             try:
                 det = await self.get_batch_detections(
                     images=images,
-                    tags=data.get('tags', []),
-                    camera_id=data.get('camera_id', None),
-                    source=data.get('source', None),
+                    capture_metadata=capture_metadata,
                     autoupload=data.get('autoupload', 'filtered'),
-                    creation_date=data.get('creation_date', None),
                 )
                 return jsonable_encoder(asdict(det))
             except DetectorUnavailableError as e:
@@ -638,35 +642,17 @@ class DetectorNode(Node):
         array = await _pixel_array(image)
         async with self.detection_lock:
             detector = _unwrap_detector(self._detector)
-            metadata = await run.io_bound(detector.logic.evaluate, array)
-
-        metadata.tags.extend(tags)
-        metadata.source = source
-        metadata.created = creation_date
-
-        fix_shape_detections(metadata)
-        n_bo, n_cl = len(metadata.box_detections), len(metadata.classification_detections)
-        n_po, n_se = len(metadata.point_detections), len(metadata.segmentation_detections)
-        self.log.debug('Detected: %d boxes, %d points, %d segs, %d classes', n_bo, n_po, n_se, n_cl)
+            detections = await run.io_bound(detector.logic.evaluate, array)
 
-        if autoupload == 'filtered':
-            background_tasks.create(self.relevance_filter.may_upload_detections(metadata, camera_id, image))
-        elif autoupload == 'all':
-            background_tasks.create(self.outbox.save(image, metadata))
-        elif autoupload == 'disabled':
-            pass
-        else:
-            self.log.error('unknown autoupload value %s', autoupload)
-        return metadata
+        capture = CaptureMetadata(camera_id=camera_id, tags=tags, source=source, creation_date=creation_date)
+        self._finish_detection(detections, image, capture, autoupload)
+        return detections
 
     async def get_batch_detections(self,
                                    images: Sequence[ImageData],
-                                   tags: List[str],
+                                   capture_metadata: Sequence[CaptureMetadata],
                                    *,
-                                   camera_id: Optional[str] = None,
-                                   source: Optional[str] = None,
-                                   autoupload: str = 'filtered',
-                                   creation_date: Optional[str] = None) -> ImagesMetadata:
+                                   autoupload: str = 'filtered') -> ImagesMetadata:
         """
         Processing function for the detector node when a batch inference is requested via SocketIO.
 
@@ -674,35 +660,45 @@ class DetectorNode(Node):
         cares about uploading to the loop and returns the detections as a list of ImageMetadata.
         Each image is a pixel array or JPEG bytes; JPEG bytes are decoded for the inference
         and stored as they are if the image is uploaded.
+        `capture_metadata` holds the camera, tags, source and creation date of each image.
         Raises exception if no model is loaded.
         """
+        if len(capture_metadata) != len(images):
+            raise ValueError(f'got {len(capture_metadata)} capture metadata for {len(images)} images')
         _unwrap_detector(self._detector)  # fails fast, before the decode
         arrays = await asyncio.gather(*(_pixel_array(image) for image in images))
         async with self.detection_lock:
             detector = _unwrap_detector(self._detector)
             all_detections = await run.io_bound(detector.logic.batch_evaluate, arrays)
 
-        for metadata in all_detections.items:
-            metadata.tags.extend(tags)
-            metadata.source = source
-            metadata.created = creation_date
-
-        for detections, image in zip(all_detections.items, images):
-            fix_shape_detections(detections)
-            n_bo, n_cl = len(detections.box_detections), len(detections.classification_detections)
-            n_po, n_se = len(detections.point_detections), len(detections.segmentation_detections)
-            self.log.debug('Detected: %d boxes, %d points, %d segs, %d classes', n_bo, n_po, n_se, n_cl)
-
-            if autoupload == 'filtered':
-                background_tasks.create(self.relevance_filter.may_upload_detections(detections, camera_id, image))
-            elif autoupload == 'all':
-                background_tasks.create(self.outbox.save(image, detections))
-            elif autoupload == 'disabled':
-                pass
-            else:
-                self.log.error('unknown autoupload value %s', autoupload)
+        for detections, image, capture in zip(all_detections.items, images, capture_metadata):
+            self._finish_detection(detections, image, capture, autoupload)
         return all_detections
 
+    def _finish_detection(self,
+                          detections: ImageMetadata,
+                          image: ImageData,
+                          capture: CaptureMetadata,
+                          autoupload: str) -> None:
+        detections.tags.extend(capture.tags)
+        detections.source = capture.source
+        detections.created = capture.creation_date
+
+        fix_shape_detections(detections)
+        n_bo, n_cl = len(detections.box_detections), len(detections.classification_detections)
+        n_po, n_se = len(detections.point_detections), len(detections.segmentation_detections)
+        self.log.debug('Detected: %d boxes, %d points, %d segs, %d classes', n_bo, n_po, n_se, n_cl)
+
+        if autoupload == 'filtered':
+            background_tasks.create(
+                self.relevance_filter.may_upload_detections(detections, capture.camera_id, image))
+        elif autoupload == 'all':
+            background_tasks.create(self.outbox.save(image, detections))
+        elif autoupload == 'disabled':
+            pass
+        else:
+            self.log.error('unknown autoupload value %s', autoupload)
+
     async def upload_images(
             self, *,
             images: Sequence[ImageData],
@@ -785,6 +781,23 @@ async def _pixel_array(image: ImageData) -> np.ndarray:
     return await run.io_bound(jpg_bytes_to_numpy_array, image)
 
 
+def _capture_metadata(batch_data: dict, image_data: dict) -> CaptureMetadata:
+    """The values of one image dict of a batch: its own where it sets them, the batch's otherwise, and both tags."""
+    image_tags = image_data.get('tags') or []
+    if not isinstance(image_tags, list):
+        raise ValueError(f'tags of an image must be a list, got {type(image_tags).__name__}')
+    return CaptureMetadata(camera_id=_own_or_batch('camera_id', image_data, batch_data),
+                           tags=[*batch_data.get('tags', []), *image_tags],
+                           source=_own_or_batch('source', image_data, batch_data),
+                           creation_date=_own_or_batch('creation_date', image_data, batch_data))
+
+
+def _own_or_batch(key: str, image_data: dict, batch_data: dict) -> str | None:
+    """`None` counts as not set, so an image cannot clear a value of the batch."""
+    own = image_data.get(key)
+    return own if own is not None else batch_data.get(key)
+
+
 def _unwrap_detector(state: '_DetectorState') -> _ActiveDetector:
     """Return the active detector or raise DetectorUnavailableError."""
     match state:

{learning_loop_node-0.27.2 → learning_loop_node-0.29.0}/learning_loop_node/trainer/exceptions.py

@@ -11,10 +11,29 @@ class ModelUploadFailedError(Exception):
     """
 
 
+class TrainingResultsUploadFailedError(Exception):
+    """Raised when the loop answered the upload of a part of a training's results with a client error other than 408.
+    The answer is final: sending the part again would get the same answer.
+    """
+
+
+class TrainingResultsNotAnsweredError(Exception):
+    """Raised when the loop gave up waiting for a part of a training's results (408) or answered with a server error;
+    the part may be sent again.
+    """
+
+
 class TrainingRefusedError(Exception):
     """Raised when a trainer cannot take on a training it was asked to begin; nothing was set up."""
 
 
+class HyperparameterMismatchError(Exception):
+    """Raised when a training's hyperparameters do not fit the trainer's declaration; nothing was set up.
+
+    Unlike a refusal, the training would fail on any trainer of the same declaration.
+    """
+
+
 class TrainingSlotTakenError(TrainingRefusedError):
     """Raised when a sibling node holds the training slot."""
 

learning_loop_node-0.29.0/learning_loop_node/trainer/hyperparameters.py

@@ -0,0 +1,180 @@
+"""Resolving the hyperparameters a training was sent against the ones its trainer declares.
+
+The loop sends only what the project sets, plus what the job overrides. Everything else comes from
+the trainer's declared defaults, so after :func:`resolve` a training holds the full set it runs
+with, and that is what gets reported back to the loop.
+"""
+
+import contextlib
+import logging
+import math
+from collections.abc import Mapping, Sequence
+from typing import Any, get_args
+
+from ..data_classes import Hyperparameter
+from ..data_classes.training import HyperparameterType
+from .batch_size import REQUESTED_BATCH_SIZE
+from .exceptions import CriticalError
+from .validation_set import COMPUTE_VALIDATION_SET
+
+logger = logging.getLogger(__name__)
+
+LIBRARY_NAMES = (REQUESTED_BATCH_SIZE, COMPUTE_VALIDATION_SET)
+"""Hyperparameters the library reads itself, so a trainer that does not declare them still uses them."""
+
+BOOL_STRINGS = {'true': True, '1': True, 'yes': True, 'on': True,
+                'false': False, '0': False, 'no': False, 'off': False}
+
+
+def resolve(declared: Sequence[Hyperparameter], received: Mapping[str, Any]) -> dict[str, Any]:
+    """Coerce and check ``received`` against ``declared`` and fill in the declared defaults.
+
+    ``declared`` is trusted to have passed :func:`check_declaration`. Names the trainer does not declare are kept
+    unchanged: old project configurations still carry them, and a resolved training carries the values its trainer
+    reported. An unset hyperparameter with a default of ``None`` is left out, so the trainer's own fallback applies.
+    Resolving twice gives the same result.
+
+    :raises CriticalError: If a value cannot be coerced to its type, is out of range or not one of its choices.
+    """
+    resolved = dict(received)
+    for hyperparameter in declared:
+        value = received.get(hyperparameter.name)
+        if _is_unset(hyperparameter, value):
+            if hyperparameter.default is None:
+                resolved.pop(hyperparameter.name, None)
+            else:
+                resolved[hyperparameter.name] = _coerce(hyperparameter, hyperparameter.default)
+        else:
+            resolved[hyperparameter.name] = _check(hyperparameter, _coerce(hyperparameter, value))
+    return resolved
+
+
+def check_declaration(declared: Sequence[Hyperparameter]) -> None:
+    """Check that ``declared`` is consistent, so that :func:`resolve` can rely on it.
+
+    A trainer's declaration does not change while it runs, so the node checks it once, when it is built. A default of
+    ``None`` stands for "the trainer decides" and is not checked.
+
+    :raises ValueError: If a name is declared twice, a hyperparameter contradicts itself or its default does not fit.
+    """
+    names = [h.name for h in declared]
+    if duplicates := sorted({name for name in names if names.count(name) > 1}):
+        raise ValueError(f'the trainer declares these hyperparameters twice: {", ".join(duplicates)}')
+    for hyperparameter in declared:
+        _check_one_declaration(hyperparameter)
+
+
+def parse_pairs(text: str) -> list[tuple[str, str]]:
+    """The ``key:value`` items of a ``pairs`` hyperparameter such as ``"uuid:uuid,uuid:uuid"``.
+
+    Empty items and the spaces around keys and values are skipped, so ``''`` holds no pairs.
+
+    :raises ValueError: If an item is not a key and a value separated by a single colon.
+    """
+    pairs = []
+    for item in (i.strip() for i in text.split(',')):
+        if not item:
+            continue
+        key, _, value = (part.strip() for part in item.partition(':'))
+        if not key or not value or ':' in value:
+            raise ValueError(f'"{item}" is not of the form "key:value"')
+        pairs.append((key, value))
+    return pairs
+
+
+def warn_about_undeclared(declared: Sequence[Hyperparameter], received: Mapping[str, Any]) -> None:
+    """Log the names in ``received`` that neither the trainer nor the library knows; they are not rejected."""
+    unknown = sorted(set(received) - {h.name for h in declared} - set(LIBRARY_NAMES))
+    if unknown:
+        logger.warning('these hyperparameters are not declared by this trainer: %s', ', '.join(unknown))
+
+
+def _check_one_declaration(hyperparameter: Hyperparameter) -> None:
+    def contradiction(reason: str) -> ValueError:
+        return ValueError(f"the trainer declares hyperparameter '{hyperparameter.name}' {reason}")
+
+    if hyperparameter.type not in get_args(HyperparameterType):
+        raise contradiction(f'with the unknown type {hyperparameter.type!r}')
+    if hyperparameter.type not in ('int', 'float') and (hyperparameter.minimum is not None or
+                                                        hyperparameter.maximum is not None):
+        raise contradiction(f'as {hyperparameter.type} with a minimum or maximum')
+    if hyperparameter.type != 'str' and hyperparameter.choices:
+        raise contradiction(f'as {hyperparameter.type} with choices')
+    for bound in (hyperparameter.minimum, hyperparameter.maximum):
+        if bound is not None and (isinstance(bound, bool) or not isinstance(bound, (int, float))):
+            raise contradiction(f'with the bound {bound!r}, which is not a number')
+    if (hyperparameter.minimum is not None and hyperparameter.maximum is not None and
+            hyperparameter.minimum > hyperparameter.maximum):
+        raise contradiction('with a minimum above its maximum')
+    if hyperparameter.default is not None:
+        try:
+            _check(hyperparameter, _coerce(hyperparameter, hyperparameter.default))
+        except CriticalError as e:
+            raise contradiction(f'with a default that does not fit: {e}') from None
+
+
+def _is_unset(hyperparameter: Hyperparameter, value: Any) -> bool:
+    """``None``, or the empty value the loop sends for a field left blank, unless it fits as a value of its own."""
+    if value is None:
+        return True
+    if value != '':
+        return False
+    try:
+        _check(hyperparameter, _coerce(hyperparameter, value))
+    except CriticalError:
+        return True
+    return False
+
+
+def _invalid(hyperparameter: Hyperparameter, requirement: str, value: Any) -> CriticalError:
+    return CriticalError(f"hyperparameter '{hyperparameter.name}' {requirement}, got {value!r}")
+
+
+def _coerce(hyperparameter: Hyperparameter, value: Any) -> Any:
+    if hyperparameter.type == 'pairs':
+        if not isinstance(value, str):
+            raise _invalid(hyperparameter, 'must be text of key:value pairs', value)
+        try:
+            return ','.join(f'{key}:{item}' for key, item in parse_pairs(value))
+        except ValueError as e:
+            raise CriticalError(f"hyperparameter '{hyperparameter.name}': {e}") from None
+    if hyperparameter.type == 'str':
+        if isinstance(value, bool) or not isinstance(value, (str, int, float)):
+            raise _invalid(hyperparameter, 'must be text', value)
+        return str(value)
+    if hyperparameter.type == 'bool':
+        if isinstance(value, bool):
+            return value
+        if isinstance(value, str) and (word := value.strip().lower()) in BOOL_STRINGS:
+            return BOOL_STRINGS[word]
+        with contextlib.suppress(TypeError, ValueError):
+            number = float(value)
+            if math.isfinite(number):
+                return number != 0
+        raise _invalid(hyperparameter, 'must be true or false', value)
+    if isinstance(value, bool):
+        raise _invalid(hyperparameter, 'must be a number', value)
+    if hyperparameter.type == 'int' and isinstance(value, (int, str)):
+        with contextlib.suppress(ValueError):
+            return int(value)
+    try:
+        number = float(value)
+    except (TypeError, ValueError):
+        raise _invalid(hyperparameter, 'must be a number', value) from None
+    if not math.isfinite(number):
+        raise _invalid(hyperparameter, 'must be finite', value)
+    if hyperparameter.type == 'float':
+        return number
+    if not number.is_integer():
+        raise _invalid(hyperparameter, 'must be a whole number', value)
+    return int(number)
+
+
+def _check(hyperparameter: Hyperparameter, value: Any) -> Any:
+    if hyperparameter.minimum is not None and value < hyperparameter.minimum:
+        raise _invalid(hyperparameter, f'must be at least {hyperparameter.minimum}', value)
+    if hyperparameter.maximum is not None and value > hyperparameter.maximum:
+        raise _invalid(hyperparameter, f'must be at most {hyperparameter.maximum}', value)
+    if hyperparameter.choices and value not in hyperparameter.choices:
+        raise _invalid(hyperparameter, f"must be one of {', '.join(hyperparameter.choices)}", value)
+    return value

{learning_loop_node-0.27.2 → learning_loop_node-0.29.0}/learning_loop_node/trainer/trainer_logic.py

@@ -26,7 +26,6 @@ class TrainerLogic(TrainerLogicGeneric):
         self._detection_progress: Optional[float] = None
         self._executor: Optional[Executor] = None
         self._process_started: bool = False
-        self._stop_requested: bool = False
         self.start_training_task: Optional[Coroutine] = None
         self.inference_batch_size = self._environment_vars.inference_batch_size