DOCUMENTACIÓN CON IA
¿Qué desea saber?
Snapshots y Changelog
Snapshot de Parámetros
Cada versión publicada almacena un snapshot de parámetros: los parámetros de la receta y del conjunto de prueba capturados contra un esquema fijo y versionado, de modo que una versión contiene el contenido estructurado completo de lo que hay dentro de ella. Cada versión también tiene un archivo README que presenta ese snapshot en forma legible.
Una versión tiene dos archivos de snapshot:
parameters/recipe/<version>.json— el snapshot de la recetaparameters/testset/<version>.json— el snapshot del conjunto de prueba
Ambos incluyen un schema_version que describe la forma del archivo (actualmente 1.1). Los campos usan rutas con puntos a continuación; [] indica una lista, por lo que blocks[].type_config.labels[].name es el name de cada etiqueta de cada bloque.
Snapshot de receta
parameters/recipe/<version>.json
| Campo | Tipo | Significado |
|---|---|---|
schema_version | string | Versión de forma del esquema de este archivo. |
extracted_at | string | Cuándo se tomó el snapshot. |
recipe_name | string | Nombre de la receta. |
description | string | null | Descripción de la receta. |
plc_recipe_id | integer | null | ID de receta del PLC. |
meta_version | integer | Versión de metadatos de la receta. |
database_version | integer | Versión de base de datos de la receta. |
software_version | string | Versión de software de la receta. |
imaging.preview_image.sha | string | SHA de la imagen de vista previa. |
imaging.preview_image.path | string | Ruta de la imagen de vista previa. |
imaging.exposure | integer | null | Tiempo de exposición. |
imaging.gain | number | null | Ganancia del sensor. |
imaging.brightness | integer | null | Brillo. |
imaging.gamma | integer | null | Gamma. |
imaging.focal_length | number | null | Distancia focal. |
imaging.focus | number | null | Enfoque. |
imaging.focus_distance | number | null | Distancia de enfoque. |
imaging.rotation_mode | integer | null | Modo de rotación de imagen. |
imaging.acq_mode | integer | null | Modo de adquisición. |
imaging.hdr_mode_enabled | boolean | null | Modo HDR activado/desactivado. |
imaging.led_mode | integer | null | Modo de iluminación LED. |
imaging.led_gain | integer | null | Ganancia de LED. |
imaging.led_strobe_mode | boolean | null | Estroboscopio LED activado/desactivado. |
imaging.lens_correct | boolean | null | Corrección de distorsión de lente activada/desactivada. |
imaging.photometric_enabled | boolean | null | Corrección fotométrica activada/desactivada. |
imaging.photometric_mode | integer | null | Modo fotométrico. |
imaging.awb_red | integer | null | Canal rojo de balance de blancos automático. |
imaging.awb_green | integer | null | Canal verde de balance de blancos automático. |
imaging.awb_blue | integer | null | Canal azul de balance de blancos automático. |
imaging.awb_op | boolean | null | Balance de blancos automático habilitado. |
imaging.calibration_pixels_per_unit | number | null | Escala de calibración (píxeles por unidad). |
imaging.calibration_unit | string | null | Unidad de calibración. |
imaging.trigger_debounce | integer | null | Debounce del disparador. |
imaging.trigger_delay | integer | null | Retardo del disparador. |
imaging.raw | object | Fuente completa sin procesar de imagen. |
blocks[].block_type | string | Tipo de bloque (alignment, classification, segmentation, measurement, ocr, unsupervised). |
blocks[].uuid | string | Identidad estable del bloque. |
blocks[].name | string | Nombre del bloque. |
blocks[].status | string | Estado del bloque. |
blocks[].is_enabled | boolean | Si el bloque se ejecuta. |
blocks[].has_model | boolean | Si hay un modelo entrenado adjunto. |
blocks[].search_area.search_area_id | integer | null | ID del área de búsqueda. |
blocks[].search_area.search_area_bbox | list of number | null | Bounding box del área de búsqueda. |
blocks[].search_area.roi_regions[].bbox | list of number | Bounding box del ROI. |
blocks[].search_area.roi_regions[].angle | number | Ángulo de rotación del ROI. |
blocks[].type_config | object | Configuración específica del tipo (ver abajo). |
blocks[].model_ref.sha | string | SHA del archivo del modelo entrenado. |
blocks[].model_ref.path | string | Ruta del archivo del modelo entrenado. |
blocks[].model_ref.file_extension | string | Extensión del archivo del modelo entrenado. |
aligner_reference_image.sha | string | SHA de la imagen de referencia de alineación. |
aligner_reference_image.path | string | Ruta de la imagen de referencia de alineación. |
aligner_reference_image.full_repo_path | string | Ruta de la imagen de referencia de alineación dentro del repositorio. |
node_red_flow.basic_mode | boolean | Si el flujo está en modo básico. |
node_red_flow.basic_flow_id | string | null | ID del flujo en modo básico. |
node_red_flow.basic_flow_metadata | object | null | Metadatos del flujo en modo básico. |
node_red_flow.nodes[].id | string | ID del nodo. |
node_red_flow.nodes[].node_type | string | Tipo de nodo. |
node_red_flow.nodes[].name | string | Nombre del nodo. |
node_red_flow.nodes[].x | integer | null | Posición X del nodo en el lienzo. |
node_red_flow.nodes[].y | integer | null | Posición Y del nodo en el lienzo. |
node_red_flow.nodes[].wires | list of list of string | Conexiones salientes (por salida, IDs de nodos destino). |
node_red_flow.nodes[].func | string | null | Código del nodo de función. |
node_red_flow.nodes[].raw | object | Fuente completa sin procesar del nodo. |
Configuración del bloque
Los campos bajo blocks[].type_config dependen de blocks[].block_type.
| Campo | Tipo | Significado |
|---|---|---|
blocks[].type_config.angle_tolerance_left | number | null | alineación — tolerancia de ángulo izquierdo. |
blocks[].type_config.angle_tolerance_right | number | null | alineación — tolerancia de ángulo derecho. |
blocks[].type_config.confidence_score_threshold | number | null | alineación / segmentación / no supervisado — umbral de coincidencia/confianza. |
blocks[].type_config.sensitivity | number | null | alineación / no supervisado — sensibilidad. |
blocks[].type_config.version | integer | null | alineación — versión de configuración. |
blocks[].type_config.scale_invariant | boolean | null | alineación — coincidencia invariante de escala activada/desactivada. |
blocks[].type_config.inference_mode | string | null | alineación — modo de inferencia. |
blocks[].type_config.dl_performance_mode | integer | null | alineación — modo de rendimiento de deep learning. |
blocks[].type_config.skip_block | boolean | null | alineación — omitir este bloque. |
blocks[].type_config.template_image_id_path | string | null | alineación — ruta de referencia de la imagen de plantilla. |
blocks[].type_config.labels[].name | string | clasificación — nombre de la etiqueta. |
blocks[].type_config.labels[].confidence_threshold | number | null | clasificación — umbral de confianza por etiqueta. |
blocks[].type_config.labels[].is_positive | boolean | null | clasificación — si la etiqueta cuenta como aprobado. |
blocks[].type_config.labels[].inspection_type | integer | null | clasificación — tipo de inspección. |
blocks[].type_config.labels[].color | string | null | clasificación — color de visualización. |
blocks[].type_config.segmentation_type | string | null | segmentación — tipo de segmentación. |
blocks[].type_config.classes[].class_name | string | segmentación — nombre de la clase. |
blocks[].type_config.classes[].mask_pixel_value | integer | null | segmentación — valor de píxel de la máscara. |
blocks[].type_config.classes[].color | string | null | segmentación — color de visualización. |
blocks[].type_config.classes[].mask_sha | string | null | segmentación — SHA del archivo de máscara. |
blocks[].type_config.classes[].mask_path | string | null | segmentación — ruta del archivo de máscara. |
blocks[].type_config.measurement_regions[] | object | medición — regiones de medición. |
blocks[].type_config.min_text_area | integer | null | ocr — área mínima de texto. |
blocks[].type_config.text_segmentation_threshold | number | null | ocr — umbral de segmentación de texto. |
blocks[].type_config.unclip_ratio | number | null | ocr — proporción de unclip. |
blocks[].type_config.unclip_ceiling | number | null | ocr — límite superior de unclip. |
blocks[].type_config.unsupervised_type | string | null | no supervisado — tipo de método. |
blocks[].type_config.epochs | integer | null | no supervisado — épocas de entrenamiento. |
blocks[].type_config.encoder | string | null | no supervisado — encoder. |
blocks[].type_config.learning_rate | number | null | no supervisado — tasa de aprendizaje. |
blocks[].type_config.downsampling_ratio | number | null | no supervisado — proporción de submuestreo. |
blocks[].type_config.tiled_mode | boolean | null | no supervisado — modo en mosaico activado/desactivado. |
blocks[].type_config.min_blob_area | number | null | no supervisado — área mínima de blob. |
blocks[].type_config.max_blob_area | number | null | no supervisado — área máxima de blob. |
blocks[].type_config.hyperparameters | object | clasificación / segmentación / medición / ocr / no supervisado — hiperparámetros de entrenamiento. |
Instantánea del conjunto de prueba
parameters/testset/<version>.json
| Campo | Tipo | Significado |
|---|---|---|
schema_version | string | Versión del esquema de este archivo. |
extracted_at | string | Cuándo se tomó la instantánea. |
name | string | Nombre del conjunto de prueba. |
description | string | null | Descripción del conjunto de prueba. |
author | string | null | Autor del conjunto de prueba. |
image_count | integer | Número de imágenes. |
images_with_ground_truth | integer | Número de imágenes que tienen verdad fundamental. |
search_area_ids[] | string | IDs de áreas de búsqueda referenciadas por el conjunto de prueba. |
per_class_distribution[].class_name | string | Nombre de la clase. Reservado; actualmente siempre vacío (trátese como "distribución no disponible"). |
per_class_distribution[].count | integer | Conteo de imágenes para la clase. Reservado; actualmente siempre vacío. |
images[].image_id | string | ID de la imagen. |
images[].ground_truth_fingerprint | string | null | Huella de la verdad fundamental de la imagen. |
images[].has_ground_truth | boolean | Si la imagen tiene verdad fundamental. |
README
Cada versión también tiene un README.md confirmado que muestra la instantánea de forma legible. Sus secciones son:
- Imaging Settings — una tabla de los parámetros de imagen.
- Aligner Reference Image — la imagen de referencia de alineación y su SHA-256 (solo si la receta tiene una).
- Inspection Blocks — una subsección por bloque, encabezada
<name> (<block type>), con el UUID del bloque, el estado y el indicador de habilitado, seguida de un bloque específico del tipo — Classification Labels, Segmentation Classes, OCR Parameters, Unsupervised Parameters, Alignment Parameters, o un conteo de regiones de medición. - Node-RED Flow — indicador de modo básico, conteo de nodos y una tabla de nodos (ID, Type, Name).
- Test Set — nombre, descripción, autor, conteo de imágenes, imágenes con verdad fundamental y áreas de búsqueda.
Registro de cambios
Cuando se publica una versión, su instantánea de parámetros se compara con la de la versión anterior para generar el registro de cambios. La comparación es estructural — campo por campo a través del esquema anterior, con listas (bloques, etiquetas, clases, nodos de Node-RED) coincididas por identidad estable en lugar de por posición, de modo que la reordenación nunca se muestra como un cambio. La receta y el conjunto de prueba se comparan de forma independiente, y el registro de cambios se deriva de las instantáneas confirmadas bajo demanda, por lo que está disponible para cualquier par de versiones.
Los cambios se agrupan en las mismas secciones que la instantánea, y una sección aparece solo si algo en ella cambió. Una versión sin diferencias se indica como tal, y la primera versión muestra una lectura inicial completa en lugar de una diferencia.