KI-GESTÜTZTE DOKUMENTATION
Was möchten Sie wissen?
Snapshots & Changelog
Parameter-Snapshot
Jede veröffentlichte Version speichert einen Parameter-Snapshot: die Rezept- und Testset-Parameter, erfasst gegen ein festes, versioniertes Schema, sodass eine Version den vollständigen strukturierten Inhalt enthält. Jede Version verfügt außerdem über eine README-Datei, die diesen Snapshot in lesbarer Form darstellt.
Eine Version besitzt zwei Snapshot-Dateien:
parameters/recipe/<version>.json— der Rezept-Snapshotparameters/testset/<version>.json— der Testset-Snapshot
Beide enthalten eine schema_version, welche die Struktur der Datei beschreibt (derzeit 1.1). Felder verwenden unten Punkt-Pfade; [] kennzeichnet eine Liste, sodass blocks[].type_config.labels[].name der name jedes Labels jedes Blocks ist.
Rezept-Snapshot
parameters/recipe/<version>.json
| Feld | Typ | Bedeutung |
|---|---|---|
schema_version | string | Schema-Version dieser Datei. |
extracted_at | string | Zeitpunkt, zu dem der Snapshot erstellt wurde. |
recipe_name | string | Name des Rezepts. |
description | string | null | Beschreibung des Rezepts. |
plc_recipe_id | integer | null | PLC-Rezept-ID. |
meta_version | integer | Metadaten-Version des Rezepts. |
database_version | integer | Datenbankversion des Rezepts. |
software_version | string | Softwareversion des Rezepts. |
imaging.preview_image.sha | string | SHA des Vorschaubilds. |
imaging.preview_image.path | string | Pfad des Vorschaubilds. |
imaging.exposure | integer | null | Belichtungszeit. |
imaging.gain | number | null | Sensor-Gain. |
imaging.brightness | integer | null | Helligkeit. |
imaging.gamma | integer | null | Gamma. |
imaging.focal_length | number | null | Brennweite. |
imaging.focus | number | null | Fokus. |
imaging.focus_distance | number | null | Fokusabstand. |
imaging.rotation_mode | integer | null | Bildrotationsmodus. |
imaging.acq_mode | integer | null | Aufnahmemodus. |
imaging.hdr_mode_enabled | boolean | null | HDR-Modus ein/aus. |
imaging.led_mode | integer | null | LED-Beleuchtungsmodus. |
imaging.led_gain | integer | null | LED-Gain. |
imaging.led_strobe_mode | boolean | null | LED-Strobe ein/aus. |
imaging.lens_correct | boolean | null | Korrektur der Objektivverzerrung ein/aus. |
imaging.photometric_enabled | boolean | null | Photometrische Korrektur ein/aus. |
imaging.photometric_mode | integer | null | Photometrischer Modus. |
imaging.awb_red | integer | null | Automatischer Weißabgleich – Rotkanal. |
imaging.awb_green | integer | null | Automatischer Weißabgleich – Grünkanal. |
imaging.awb_blue | integer | null | Automatischer Weißabgleich – Blaukanal. |
imaging.awb_op | boolean | null | Automatischer Weißabgleich aktiviert. |
imaging.calibration_pixels_per_unit | number | null | Kalibrierungsskala (Pixel pro Einheit). |
imaging.calibration_unit | string | null | Kalibrierungseinheit. |
imaging.trigger_debounce | integer | null | Trigger-Entprellung. |
imaging.trigger_delay | integer | null | Trigger-Verzögerung. |
imaging.raw | object | Vollständige, unverarbeitete Imaging-Quelle. |
blocks[].block_type | string | Block-Typ (alignment, classification, segmentation, measurement, ocr, unsupervised). |
blocks[].uuid | string | Stabile Block-Identität. |
blocks[].name | string | Block-Name. |
blocks[].status | string | Block-Status. |
blocks[].is_enabled | boolean | Ob der Block ausgeführt wird. |
blocks[].has_model | boolean | Ob ein trainiertes Modell zugewiesen ist. |
blocks[].search_area.search_area_id | integer | null | Suchbereichs-ID. |
blocks[].search_area.search_area_bbox | list of number | null | Bounding Box des Suchbereichs. |
blocks[].search_area.roi_regions[].bbox | list of number | ROI-Bounding-Box. |
blocks[].search_area.roi_regions[].angle | number | ROI-Rotationswinkel. |
blocks[].type_config | object | Typspezifische Konfiguration (siehe unten). |
blocks[].model_ref.sha | string | SHA der trainierten Modelldatei. |
blocks[].model_ref.path | string | Pfad der trainierten Modelldatei. |
blocks[].model_ref.file_extension | string | Dateierweiterung der trainierten Modelldatei. |
aligner_reference_image.sha | string | SHA des Ausrichtungs-Referenzbilds. |
aligner_reference_image.path | string | Pfad des Ausrichtungs-Referenzbilds. |
aligner_reference_image.full_repo_path | string | Pfad des Ausrichtungs-Referenzbilds innerhalb des Repositorys. |
node_red_flow.basic_mode | boolean | Ob sich der Flow im Basic-Modus befindet. |
node_red_flow.basic_flow_id | string | null | Flow-ID im Basic-Modus. |
node_red_flow.basic_flow_metadata | object | null | Flow-Metadaten im Basic-Modus. |
node_red_flow.nodes[].id | string | Node-ID. |
node_red_flow.nodes[].node_type | string | Node-Typ. |
node_red_flow.nodes[].name | string | Node-Name. |
node_red_flow.nodes[].x | integer | null | X-Position der Node auf dem Canvas. |
node_red_flow.nodes[].y | integer | null | Y-Position der Node auf dem Canvas. |
node_red_flow.nodes[].wires | list of list of string | Ausgehende Verbindungen (pro Ausgang, Ziel-Node-IDs). |
node_red_flow.nodes[].func | string | null | Code der Function-Node. |
node_red_flow.nodes[].raw | object | Vollständige, unverarbeitete Node-Quelle. |
Blockkonfiguration
Die Felder unter blocks[].type_config hängen von blocks[].block_type ab.
| Feld | Typ | Bedeutung |
|---|---|---|
blocks[].type_config.angle_tolerance_left | number | null | alignment — linke Winkeltoleranz. |
blocks[].type_config.angle_tolerance_right | number | null | alignment — rechte Winkeltoleranz. |
blocks[].type_config.confidence_score_threshold | number | null | alignment / segmentation / unsupervised — Übereinstimmungs-/Konfidenzschwelle. |
blocks[].type_config.sensitivity | number | null | alignment / unsupervised — Empfindlichkeit. |
blocks[].type_config.version | integer | null | alignment — Konfigurationsversion. |
blocks[].type_config.scale_invariant | boolean | null | alignment — Skaleninvariante Übereinstimmung ein/aus. |
blocks[].type_config.inference_mode | string | null | alignment — Inferenzmodus. |
blocks[].type_config.dl_performance_mode | integer | null | alignment — Deep-Learning-Leistungsmodus. |
blocks[].type_config.skip_block | boolean | null | alignment — Diesen Block überspringen. |
blocks[].type_config.template_image_id_path | string | null | alignment — Referenzpfad des Vorlagenbilds. |
blocks[].type_config.labels[].name | string | classification — Label-Name. |
blocks[].type_config.labels[].confidence_threshold | number | null | classification — Konfidenzschwelle pro Label. |
blocks[].type_config.labels[].is_positive | boolean | null | classification — Ob das Label als Pass gewertet wird. |
blocks[].type_config.labels[].inspection_type | integer | null | classification — Inspektionstyp. |
blocks[].type_config.labels[].color | string | null | classification — Anzeigefarbe. |
blocks[].type_config.segmentation_type | string | null | segmentation — Segmentierungstyp. |
blocks[].type_config.classes[].class_name | string | segmentation — Klassenname. |
blocks[].type_config.classes[].mask_pixel_value | integer | null | segmentation — Maskenpixelwert. |
blocks[].type_config.classes[].color | string | null | segmentation — Anzeigefarbe. |
blocks[].type_config.classes[].mask_sha | string | null | segmentation — SHA der Maskendatei. |
blocks[].type_config.classes[].mask_path | string | null | segmentation — Pfad der Maskendatei. |
blocks[].type_config.measurement_regions[] | object | measurement — Messbereiche. |
blocks[].type_config.min_text_area | integer | null | ocr — Minimale Textfläche. |
blocks[].type_config.text_segmentation_threshold | number | null | ocr — Schwelle für Textsegmentierung. |
blocks[].type_config.unclip_ratio | number | null | ocr — Unclip-Verhältnis. |
blocks[].type_config.unclip_ceiling | number | null | ocr — Unclip-Obergrenze. |
blocks[].type_config.unsupervised_type | string | null | unsupervised — Methodentyp. |
blocks[].type_config.epochs | integer | null | unsupervised — Trainings-Epochen. |
blocks[].type_config.encoder | string | null | unsupervised — Encoder. |
blocks[].type_config.learning_rate | number | null | unsupervised — Lernrate. |
blocks[].type_config.downsampling_ratio | number | null | unsupervised — Downsampling-Verhältnis. |
blocks[].type_config.tiled_mode | boolean | null | unsupervised — Tiled-Modus ein/aus. |
blocks[].type_config.min_blob_area | number | null | unsupervised — Minimale Blob-Fläche. |
blocks[].type_config.max_blob_area | number | null | unsupervised — Maximale Blob-Fläche. |
blocks[].type_config.hyperparameters | object | classification / segmentation / measurement / ocr / unsupervised — Trainings-Hyperparameter. |
Test-Set-Snapshot
parameters/testset/<version>.json
| Feld | Typ | Bedeutung |
|---|---|---|
schema_version | string | Schema-Version dieser Datei. |
extracted_at | string | Zeitpunkt der Snapshot-Erstellung. |
name | string | Name des Test-Sets. |
description | string | null | Beschreibung des Test-Sets. |
author | string | null | Autor des Test-Sets. |
image_count | integer | Anzahl der Bilder. |
images_with_ground_truth | integer | Anzahl der Bilder mit Ground Truth. |
search_area_ids[] | string | Vom Test-Set referenzierte Search-Area-IDs. |
per_class_distribution[].class_name | string | Klassenname. Reserviert; derzeit stets leer (als "Verteilung nicht verfügbar" zu behandeln). |
per_class_distribution[].count | integer | Bildanzahl für die Klasse. Reserviert; derzeit stets leer. |
images[].image_id | string | Bild-ID. |
images[].ground_truth_fingerprint | string | null | Fingerprint der Ground Truth des Bildes. |
images[].has_ground_truth | boolean | Ob das Bild eine Ground Truth besitzt. |
README
Jede Version besitzt zudem eine eingecheckte README.md, die den Snapshot in lesbarer Form darstellt. Ihre Abschnitte sind:
- Imaging Settings — eine Tabelle der Imaging-Parameter.
- Aligner Reference Image — das Ausrichtungs-Referenzbild und dessen SHA-256 (nur, wenn das Rezept eines hat).
- Inspection Blocks — ein Unterabschnitt pro Block, überschrieben mit
<name> (<block type>), mit UUID, Status und Enabled-Flag des Blocks, gefolgt von einem typspezifischen Bereich — Classification Labels, Segmentation Classes, OCR Parameters, Unsupervised Parameters, Alignment Parameters oder einer Zählung der Messregionen. - Node-RED Flow — Basic-Mode-Flag, Knotenanzahl und eine Tabelle der Nodes (ID, Type, Name).
- Test Set — Name, Beschreibung, Autor, Bildanzahl, Bilder mit Ground Truth und Suchbereiche.
Changelog
Wenn eine Version veröffentlicht wird, wird ihr Parameter-Snapshot mit dem der vorherigen Version verglichen, um das Changelog zu erzeugen. Der Vergleich ist strukturell — Feld für Feld über das oben beschriebene Schema hinweg, wobei Listen (Blocks, Labels, Klassen, Node-RED-Nodes) über eine stabile Identität statt über die Position abgeglichen werden, sodass eine Umsortierung nie als Änderung erscheint. Recipe und Test Set werden unabhängig voneinander verglichen, und das Changelog wird bei Bedarf aus den eingecheckten Snapshots abgeleitet, sodass es für jedes beliebige Versionspaar verfügbar ist.
Änderungen werden in dieselben Abschnitte wie der Snapshot gruppiert, und ein Abschnitt erscheint nur, wenn sich darin etwas geändert hat. Eine Version ohne Unterschiede wird entsprechend gekennzeichnet, und die erste Version zeigt eine vollständige initiale Ausgabe anstelle eines Diffs.