Spaces:
Paused
Paused
File size: 36,814 Bytes
5e0b58b | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 | """Typed data models used by the Brain-5D operator dashboard."""
from __future__ import annotations
from dataclasses import dataclass, field
from dataclasses import fields as dataclass_fields
from typing import Any, cast
from src.embodiment.models import EmbodimentMetrics
from src.version import BRAIN5D_VERSION_DISPLAY
JSONScalar = str | int | float | bool | None
JSONValue = JSONScalar | list["JSONValue"] | dict[str, "JSONValue"]
# ============================================================================
# Core Metrics
# ============================================================================
@dataclass(frozen=True, slots=True)
class SystemMetrics:
"""Core simulation metrics presented on the dashboard."""
tick: int = 0
neurons: int = 0
synapses: int = 0
spikes_total: int = 0
spikes_last_tick: int = 0
core_step_ms: float = 0.0
mean_energy: float = 0.0
def to_json(self) -> dict[str, JSONValue]:
"""Return a JSON-serializable representation."""
return {
"tick": self.tick,
"neurons": self.neurons,
"synapses": self.synapses,
"spikes_total": self.spikes_total,
"spikes_last_tick": self.spikes_last_tick,
"core_step_ms": self.core_step_ms,
"mean_energy": self.mean_energy,
}
@dataclass(frozen=True, slots=True)
class LearningMetrics:
"""Learning counters exposed by the dashboard."""
stdp_updates: int = 0
reward_updates: int = 0
rewards_received: int = 0
rewards_applied: int = 0
pending_rewards: int = 0
update_ms: float = 0.0
engine_attached: bool = False
stdp_enabled: bool = False
eligibility_enabled: bool = False
reward_enabled: bool = False
def to_json(self) -> dict[str, JSONValue]:
"""Return a JSON-serializable representation."""
return {
"stdp_updates": self.stdp_updates,
"reward_updates": self.reward_updates,
"rewards_received": self.rewards_received,
"rewards_applied": self.rewards_applied,
"pending_rewards": self.pending_rewards,
"update_ms": self.update_ms,
"engine_attached": self.engine_attached,
"stdp_enabled": self.stdp_enabled,
"eligibility_enabled": self.eligibility_enabled,
"reward_enabled": self.reward_enabled,
}
@dataclass(frozen=True, slots=True)
class StorageMetrics:
"""Persistence metrics exposed by storage telemetry.
All numeric fields default to ``None`` to distinguish
"not available / not connected" from "measured and zero".
The dashboard should display ``—`` for ``None`` fields.
"""
available: bool = False
queue_depth: int | None = None
queue_capacity: int | None = None
batches_enqueued: int | None = None
batches_written: int | None = None
deltas_written: int | None = None
bytes_written: int | None = None
dropped_batches: int | None = None
write_latency_ms: float | None = None
commit_latency_ms: float | None = None
journal_size_bytes: int | None = None
worker_failed: bool | None = None
def to_json(self) -> dict[str, JSONValue]:
"""Return a JSON-serializable representation."""
return {
"available": self.available,
"queue_depth": self.queue_depth,
"queue_capacity": self.queue_capacity,
"batches_enqueued": self.batches_enqueued,
"batches_written": self.batches_written,
"deltas_written": self.deltas_written,
"bytes_written": self.bytes_written,
"dropped_batches": self.dropped_batches,
"write_latency_ms": self.write_latency_ms,
"commit_latency_ms": self.commit_latency_ms,
"journal_size_bytes": self.journal_size_bytes,
"worker_failed": self.worker_failed,
}
@dataclass(frozen=True, slots=True)
class SelfOrganizationMetrics:
"""Structural self-organization counters.
All numeric fields default to ``None`` to distinguish
"not configured / not connected" from "measured and zero".
"""
available: bool = False
neurons_created: int | None = None
neurons_removed: int | None = None
synapses_created: int | None = None
synapses_pruned: int | None = None
def to_json(self) -> dict[str, JSONValue]:
"""Return a JSON-serializable representation."""
return {
"available": self.available,
"neurons_created": self.neurons_created,
"neurons_removed": self.neurons_removed,
"synapses_created": self.synapses_created,
"synapses_pruned": self.synapses_pruned,
}
# ============================================================================
# Homeostasis Metrics
# ============================================================================
@dataclass(frozen=True, slots=True)
class HomeostasisMetrics:
"""Backward-compatible homeostasis metrics for dashboard consumers.
``actual_rate_hz`` / ``rate_error_hz`` are the alpha.6 names. The
``mean_*`` fields are the v0.5 regulator names. Both contracts remain
available during the v0.5 transition so older dashboard tests, scripts,
and saved API consumers do not break.
"""
enabled: bool = False
target_rate_hz: float = 0.0
actual_rate_hz: float = 0.0
rate_error_hz: float = 0.0
mean_rate_hz: float = 0.0
mean_rate_error_hz: float = 0.0
mean_threshold_adaptation: float = 0.0
target_energy: float = 0.0
mean_energy: float = 0.0
mean_energy_error: float = 0.0
active_neurons: int = 0
updates: int = 0
def _resolved_rate(self) -> float:
"""Resolve the canonical rate while honoring the legacy alias."""
if self.mean_rate_hz != 0.0 or self.actual_rate_hz == 0.0:
return self.mean_rate_hz
return self.actual_rate_hz
def _resolved_error(self) -> float:
"""Resolve the canonical rate error while honoring the legacy alias."""
if self.mean_rate_error_hz != 0.0 or self.rate_error_hz == 0.0:
return self.mean_rate_error_hz
return self.rate_error_hz
def to_json(self) -> dict[str, JSONValue]:
"""Return both the legacy and canonical JSON field names."""
rate = self._resolved_rate()
error = self._resolved_error()
return {
"enabled": self.enabled,
"target_rate_hz": self.target_rate_hz,
"actual_rate_hz": rate,
"rate_error_hz": error,
"mean_rate_hz": rate,
"mean_rate_error_hz": error,
"mean_threshold_adaptation": self.mean_threshold_adaptation,
"target_energy": self.target_energy,
"mean_energy": self.mean_energy,
"mean_energy_error": self.mean_energy_error,
"active_neurons": self.active_neurons,
"updates": self.updates,
}
# ============================================================================
# Structural Metrics (for adapters.py)
# ============================================================================
@dataclass(frozen=True, slots=True)
class StructuralMetrics:
"""Structural plasticity metrics for dashboard display.
These metrics are consumed by the structural_metrics() adapter
and provide insight into network growth and pruning dynamics.
"""
neuron_count: int = 0
synapse_count: int = 0
new_neurons: int = 0
pruned_neurons: int = 0
new_synapses: int = 0
pruned_synapses: int = 0
growth_budget: float = 0.0
used_budget: float = 0.0
structural_changes: int = 0
def to_json(self) -> dict[str, JSONValue]:
"""Return a JSON-serializable representation."""
return {
"neuron_count": self.neuron_count,
"synapse_count": self.synapse_count,
"new_neurons": self.new_neurons,
"pruned_neurons": self.pruned_neurons,
"new_synapses": self.new_synapses,
"pruned_synapses": self.pruned_synapses,
"growth_budget": self.growth_budget,
"used_budget": self.used_budget,
"structural_changes": self.structural_changes,
}
# ============================================================================
# Spike Metrics (for adapters.py)
# ============================================================================
@dataclass(frozen=True, slots=True)
class SpikeMetrics:
"""Spike recording metrics for dashboard display.
These metrics are consumed by the spike_metrics() adapter
and provide insight into network activity patterns.
"""
total_spikes: int = 0
active_neurons: int = 0
mean_firing_rate_hz: float = 0.0
burst_index: float = 0.0
synchrony: float = 0.0
spike_count_last_tick: int = 0
def to_json(self) -> dict[str, JSONValue]:
"""Return a JSON-serializable representation."""
return {
"total_spikes": self.total_spikes,
"active_neurons": self.active_neurons,
"mean_firing_rate_hz": self.mean_firing_rate_hz,
"burst_index": self.burst_index,
"synchrony": self.synchrony,
"spike_count_last_tick": self.spike_count_last_tick,
}
# ============================================================================
# Network Metrics
# ============================================================================
@dataclass(frozen=True, slots=True)
class NetworkMetrics:
"""Comprehensive network metrics for dashboard display.
Provides a holistic view of the network state including
activity, structure, and energy consumption.
"""
tick: int = 0
neuron_count: int = 0
synapse_count: int = 0
active_neurons: int = 0
silent_neurons: int = 0
mean_firing_rate_hz: float = 0.0
burst_index: float = 0.0
synchrony: float = 0.0
mean_energy: float = 0.0
mean_threshold_adaptation: float = 0.0
e_i_ratio: float = 0.0
clustering_coefficient: float = 0.0
mean_path_length: float = 0.0
def to_json(self) -> dict[str, JSONValue]:
"""Return a JSON-serializable representation."""
return {
"tick": self.tick,
"neuron_count": self.neuron_count,
"synapse_count": self.synapse_count,
"active_neurons": self.active_neurons,
"silent_neurons": self.silent_neurons,
"mean_firing_rate_hz": self.mean_firing_rate_hz,
"burst_index": self.burst_index,
"synchrony": self.synchrony,
"mean_energy": self.mean_energy,
"mean_threshold_adaptation": self.mean_threshold_adaptation,
"e_i_ratio": self.e_i_ratio,
"clustering_coefficient": self.clustering_coefficient,
"mean_path_length": self.mean_path_length,
}
# ============================================================================
# Language Organ Metrics
# ============================================================================
@dataclass(frozen=True, slots=True)
class LanguageOrganMetrics:
"""Metrics for the Language Organ (LLM integration).
Tracks the status and performance of the optional LLM component
as it translates between symbolic and subsymbolic representations.
"""
enabled: bool = False
active: bool = False
backend_type: str = "null"
model_name: str = ""
inference_count: int = 0
inference_time_ms: float = 0.0
avg_inference_time_ms: float = 0.0
errors: int = 0
last_error: str | None = None
queue_depth: int = 0
max_queue_depth: int = 0
def to_json(self) -> dict[str, JSONValue]:
"""Return a JSON-serializable representation."""
result: dict[str, JSONValue] = {
"enabled": self.enabled,
"active": self.active,
"backend_type": self.backend_type,
"model_name": self.model_name,
"inference_count": self.inference_count,
"inference_time_ms": self.inference_time_ms,
"avg_inference_time_ms": self.avg_inference_time_ms,
"errors": self.errors,
"queue_depth": self.queue_depth,
"max_queue_depth": self.max_queue_depth,
}
if self.last_error is not None:
result["last_error"] = self.last_error
return result
# ============================================================================
# Knowledge Intake Metrics
# ============================================================================
@dataclass(frozen=True, slots=True)
class KnowledgeIntakeMetrics:
"""Metrics for the Knowledge Intake Engine.
Tracks external knowledge ingestion and provenance for
controlled learning experiments.
"""
items_ingested: int = 0
items_processed: int = 0
items_failed: int = 0
learning_stimuli_created: int = 0
sources_cached: int = 0
deduplication_hits: int = 0
trust_failures: int = 0
intake_queue_depth: int = 0
intake_queue_capacity: int = 0
last_ingestion_time: str | None = None
active_sources: int = 0
def to_json(self) -> dict[str, JSONValue]:
"""Return a JSON-serializable representation."""
result: dict[str, JSONValue] = {
"items_ingested": self.items_ingested,
"items_processed": self.items_processed,
"items_failed": self.items_failed,
"learning_stimuli_created": self.learning_stimuli_created,
"sources_cached": self.sources_cached,
"deduplication_hits": self.deduplication_hits,
"trust_failures": self.trust_failures,
"intake_queue_depth": self.intake_queue_depth,
"intake_queue_capacity": self.intake_queue_capacity,
"active_sources": self.active_sources,
}
if self.last_ingestion_time is not None:
result["last_ingestion_time"] = self.last_ingestion_time
return result
# ============================================================================
# Signal Metrics (for Signal Bridge)
# ============================================================================
@dataclass(frozen=True, slots=True)
class SignalMetrics:
"""Metrics for the Signal Bridge layer.
Tracks the transformation between spike events and SignalFrames,
as well as the interpretation pipeline.
"""
frames_processed: int = 0
frames_generated: int = 0
avg_frame_size: int = 0
interpretation_count: int = 0
interpretation_time_ms: float = 0.0
active_regions: int = 0
spike_events_processed: int = 0
burst_detections: int = 0
synchrony_events: int = 0
def to_json(self) -> dict[str, JSONValue]:
"""Return a JSON-serializable representation."""
return {
"frames_processed": self.frames_processed,
"frames_generated": self.frames_generated,
"avg_frame_size": self.avg_frame_size,
"interpretation_count": self.interpretation_count,
"interpretation_time_ms": self.interpretation_time_ms,
"active_regions": self.active_regions,
"spike_events_processed": self.spike_events_processed,
"burst_detections": self.burst_detections,
"synchrony_events": self.synchrony_events,
}
# ============================================================================
# Experiment Metrics
# ============================================================================
@dataclass(frozen=True, slots=True)
class ExperimentMetrics:
"""Metrics for controlled learning experiments.
Tracks the progress and outcomes of knowledge learning experiments
where external information is presented to the SNN.
"""
experiment_id: str = ""
episode_count: int = 0
learning_episodes: int = 0
evaluation_episodes: int = 0
recall_accuracy: float = 0.0
retention_score: float = 0.0
generalization_score: float = 0.0
contradiction_detections: int = 0
source_switches: int = 0
last_evaluation_tick: int = 0
active: bool = False
def to_json(self) -> dict[str, JSONValue]:
"""Return a JSON-serializable representation."""
return {
"experiment_id": self.experiment_id,
"episode_count": self.episode_count,
"learning_episodes": self.learning_episodes,
"evaluation_episodes": self.evaluation_episodes,
"recall_accuracy": self.recall_accuracy,
"retention_score": self.retention_score,
"generalization_score": self.generalization_score,
"contradiction_detections": self.contradiction_detections,
"source_switches": self.source_switches,
"last_evaluation_tick": self.last_evaluation_tick,
"active": self.active,
}
# ============================================================================
# Component Status Model (Operator Workbench)
# ============================================================================
VALID_COMPONENT_STATUS = {
"enabled",
"active",
"degraded",
"unavailable",
"error",
"stale",
"disabled",
}
VALID_MATURITY = {
"implemented",
"integrated",
"verified",
"evidenced",
}
@dataclass(frozen=True, slots=True)
class ComponentStatus:
"""Standardized status for any dashboard-relevant component.
Attributes:
component: Logical component identifier (e.g. "runtime", "storage").
status: One of the VALID_COMPONENT_STATUS values.
reason: Human-readable explanation of the status.
last_update: ISO timestamp of the last update.
source: Origin of the status (e.g. "OperatorBridge", "GateStatusBuilder").
last_error: Optional last error message.
maturity: Maturity level from VALID_MATURITY.
"""
component: str
status: str = "unavailable"
reason: str = ""
last_update: str | None = None
source: str = ""
last_error: str | None = None
maturity: str = "implemented"
def __post_init__(self) -> None:
if self.status not in VALID_COMPONENT_STATUS:
raise ValueError(f"invalid component status: {self.status!r}")
if self.maturity not in VALID_MATURITY:
raise ValueError(f"invalid maturity: {self.maturity!r}")
def to_json(self) -> dict[str, JSONValue]:
"""Return a JSON-serializable representation."""
result: dict[str, JSONValue] = {
"component": self.component,
"status": self.status,
"reason": self.reason,
"last_update": self.last_update,
"source": self.source,
"maturity": self.maturity,
}
if self.last_error is not None:
result["last_error"] = self.last_error
return result
# ============================================================================
# Parameter Schema Model (Operator Workbench)
# ============================================================================
@dataclass(frozen=True, slots=True)
class ParameterSchema:
"""Metadata for a single runtime or configuration parameter.
Attributes:
name: Parameter identifier.
value: Current value.
default: Factory/default value.
min: Optional minimum value.
max: Optional maximum value.
unit: Optional unit suffix.
description: Human-readable description.
source: Where the value originates (e.g. "config", "runtime").
runtime_mutable: Whether the parameter can be changed at runtime.
requires_restart: Whether a restart is required after change.
scientific_sensitive: Whether the parameter is scientifically sensitive.
"""
name: str
value: JSONScalar | list[JSONValue] | dict[str, JSONValue]
default: JSONScalar | list[JSONValue] | dict[str, JSONValue] | None = None
min: JSONScalar | None = None
max: JSONScalar | None = None
unit: str | None = None
description: str = ""
source: str = ""
runtime_mutable: bool = False
requires_restart: bool = False
scientific_sensitive: bool = False
def to_json(self) -> dict[str, JSONValue]:
"""Return a JSON-serializable representation."""
return {
"name": self.name,
"value": self.value,
"default": self.default,
"min": self.min,
"max": self.max,
"unit": self.unit,
"description": self.description,
"source": self.source,
"runtime_mutable": self.runtime_mutable,
"requires_restart": self.requires_restart,
"scientific_sensitive": self.scientific_sensitive,
}
@dataclass(frozen=True, slots=True)
class PendingParameterChange:
"""One pending parameter change waiting for operator confirmation.
Attributes:
name: Parameter identifier.
current_value: Value currently in effect.
proposed_value: Value proposed by the operator.
default_value: Factory/default value.
timestamp: ISO timestamp when the change was proposed.
requires_restart: Whether applying this change needs a restart.
scientific_sensitive: Whether the parameter is scientifically sensitive.
applied: Whether this change has already been applied.
"""
name: str
current_value: JSONScalar | list[JSONValue] | dict[str, JSONValue] | None = None
proposed_value: JSONScalar | list[JSONValue] | dict[str, JSONValue] | None = None
default_value: JSONScalar | list[JSONValue] | dict[str, JSONValue] | None = None
timestamp: str | None = None
requires_restart: bool = False
scientific_sensitive: bool = False
applied: bool = False
def to_json(self) -> dict[str, JSONValue]:
"""Return a JSON-serializable representation."""
return {
"name": self.name,
"current_value": self.current_value,
"proposed_value": self.proposed_value,
"default_value": self.default_value,
"timestamp": self.timestamp,
"requires_restart": self.requires_restart,
"scientific_sensitive": self.scientific_sensitive,
"applied": self.applied,
}
@dataclass(frozen=True, slots=True)
class ParameterChangeRecord:
"""Immutable record of one applied or cancelled parameter change.
Attributes:
name: Parameter identifier.
action: One of 'applied' or 'cancelled'.
old_value: Value before the action.
new_value: Value after the action (for applied changes).
timestamp: ISO timestamp of the action.
saved_profile: Whether the change was also saved as a profile.
"""
name: str
action: str
old_value: JSONScalar | list[JSONValue] | dict[str, JSONValue] | None = None
new_value: JSONScalar | list[JSONValue] | dict[str, JSONValue] | None = None
timestamp: str | None = None
saved_profile: bool = False
def __post_init__(self) -> None:
if self.action not in {"applied", "cancelled"}:
raise ValueError(f"invalid change action: {self.action!r}")
def to_json(self) -> dict[str, JSONValue]:
"""Return a JSON-serializable representation."""
return {
"name": self.name,
"action": self.action,
"old_value": self.old_value,
"new_value": self.new_value,
"timestamp": self.timestamp,
"saved_profile": self.saved_profile,
}
# ============================================================================
# Health Snapshot Model (Operator Workbench)
# ============================================================================
@dataclass(frozen=True, slots=True)
class HealthSnapshot:
"""Aggregated health/problems view for the operator workbench.
Attributes:
overall: Overall health status.
problems: List of problems/warnings/errors/unavailable/stale items.
errors: Count of error-level items.
warnings: Count of warning-level items.
stale: Count of stale items.
unavailable: Count of unavailable items.
"""
overall: str = "unknown"
problems: tuple[ComponentStatus, ...] = ()
errors: int = 0
warnings: int = 0
stale: int = 0
unavailable: int = 0
def to_json(self) -> dict[str, JSONValue]:
"""Return a JSON-serializable representation."""
return {
"overall": self.overall,
"problems": [p.to_json() for p in self.problems],
"errors": self.errors,
"warnings": self.warnings,
"stale": self.stale,
"unavailable": self.unavailable,
}
# ============================================================================
# Experiment Mode Model (Operator Workbench)
# ============================================================================
VALID_EXPERIMENT_MODES = {"operator", "experiment", "debug"}
@dataclass(frozen=True, slots=True)
class ExperimentSession:
"""One recorded experiment or debug session.
Attributes:
session_id: Unique session identifier.
mode: One of 'operator', 'experiment', 'debug'.
hypothesis: Optional hypothesis or goal for the session.
notes: Free-text notes recorded during the session.
start_tick: Simulation tick at session start.
end_tick: Simulation tick at session end (None if active).
start_time: ISO timestamp of session start.
end_time: ISO timestamp of session end (None if active).
config_snapshot: Optional copy of relevant parameters at start.
active: Whether the session is currently running.
"""
session_id: str
mode: str = "operator"
hypothesis: str = ""
notes: tuple[str, ...] = ()
start_tick: int = 0
end_tick: int | None = None
start_time: str | None = None
end_time: str | None = None
config_snapshot: dict[str, JSONValue] | None = None
active: bool = True
def __post_init__(self) -> None:
if self.mode not in VALID_EXPERIMENT_MODES:
raise ValueError(f"invalid experiment mode: {self.mode!r}")
def to_json(self) -> dict[str, JSONValue]:
"""Return a JSON-serializable representation."""
return {
"session_id": self.session_id,
"mode": self.mode,
"hypothesis": self.hypothesis,
"notes": list(self.notes),
"start_tick": self.start_tick,
"end_tick": self.end_tick,
"start_time": self.start_time,
"end_time": self.end_time,
"config_snapshot": self.config_snapshot,
"active": self.active,
}
@dataclass(frozen=True, slots=True)
class ExperimentState:
"""Current experiment mode and active session metadata.
Attributes:
current_mode: One of 'operator', 'experiment', 'debug'.
active_session: The currently active session, if any.
sessions: Immutable history of all sessions.
"""
current_mode: str = "operator"
active_session: ExperimentSession | None = None
sessions: tuple[ExperimentSession, ...] = ()
def __post_init__(self) -> None:
if self.current_mode not in VALID_EXPERIMENT_MODES:
raise ValueError(f"invalid experiment mode: {self.current_mode!r}")
def to_json(self) -> dict[str, JSONValue]:
"""Return a JSON-serializable representation."""
return {
"current_mode": self.current_mode,
"active_session": (
self.active_session.to_json() if self.active_session else None
),
"sessions": [s.to_json() for s in self.sessions],
}
# ============================================================================
# Dashboard Snapshot (Enhanced)
# ============================================================================
@dataclass(frozen=True, slots=True)
class DashboardSnapshot:
"""One immutable dashboard state publication."""
system: SystemMetrics = SystemMetrics()
learning: LearningMetrics = LearningMetrics()
storage: StorageMetrics = StorageMetrics()
self_organization: SelfOrganizationMetrics = SelfOrganizationMetrics()
homeostasis: HomeostasisMetrics = HomeostasisMetrics()
structural: StructuralMetrics = StructuralMetrics()
spikes: SpikeMetrics = SpikeMetrics()
network: NetworkMetrics = NetworkMetrics()
language_organ: LanguageOrganMetrics = LanguageOrganMetrics()
knowledge_intake: KnowledgeIntakeMetrics = KnowledgeIntakeMetrics()
signal_metrics: SignalMetrics = SignalMetrics()
experiment: ExperimentMetrics = ExperimentMetrics()
embodiment: EmbodimentMetrics = EmbodimentMetrics()
runtime: dict[str, JSONValue] = field(default_factory=dict[str, JSONValue])
components: dict[str, ComponentStatus] = field(
default_factory=dict[str, ComponentStatus]
)
parameters: dict[str, ParameterSchema] = field(
default_factory=dict[str, ParameterSchema]
)
pending_changes: dict[str, PendingParameterChange] = field(
default_factory=dict[str, PendingParameterChange]
)
change_history: tuple[ParameterChangeRecord, ...] = ()
experiment_state: ExperimentState = ExperimentState()
health: HealthSnapshot = HealthSnapshot()
status: str = "idle"
version: str = BRAIN5D_VERSION_DISPLAY
def to_json(self) -> dict[str, JSONValue]:
"""Return the complete snapshot as a JSON object."""
components = self.components
parameters = self.parameters
return {
"status": self.status,
"version": self.version,
"system": self.system.to_json(),
"learning": self.learning.to_json(),
"storage": self.storage.to_json(),
"self_organization": self.self_organization.to_json(),
"homeostasis": self.homeostasis.to_json(),
"structural": self.structural.to_json(),
"spikes": self.spikes.to_json(),
"network": self.network.to_json(),
"language_organ": self.language_organ.to_json(),
"knowledge_intake": self.knowledge_intake.to_json(),
"signal_metrics": self.signal_metrics.to_json(),
"experiment": self.experiment.to_json(),
"embodiment": self.embodiment.to_json(),
"runtime": dict(self.runtime),
"components": {k: v.to_json() for k, v in components.items()},
"parameters": {k: v.to_json() for k, v in parameters.items()},
"pending_changes": {
k: v.to_json() for k, v in (self.pending_changes or {}).items()
},
"change_history": [r.to_json() for r in self.change_history],
"experiment_state": self.experiment_state.to_json(),
"health": self.health.to_json(),
}
# ============================================================================
# Utility Functions
# ============================================================================
def to_json_serializable(obj: Any) -> JSONValue:
"""Convert any object to a JSON-serializable value.
Recursively handles dataclasses, lists, and dictionaries.
"""
if obj is None or isinstance(obj, (str, int, float, bool)):
return obj
if isinstance(obj, (list, tuple)):
seq = cast(list[Any], obj)
result_list: list[JSONValue] = []
for item in seq:
result_list.append(to_json_serializable(item))
return result_list
if isinstance(obj, dict):
mapping = cast(dict[str, Any], obj)
result_dict: dict[str, JSONValue] = {}
for k, v in mapping.items():
result_dict[str(k)] = to_json_serializable(v)
return result_dict
if hasattr(obj, "to_json"):
# The object has a to_json method; call it
result = obj.to_json()
# Recursively convert the result if needed
return to_json_serializable(result)
if hasattr(obj, "__dataclass_fields__"):
# Fallback for dataclasses without to_json
field_dict = {
field.name: getattr(obj, field.name) for field in dataclass_fields(obj)
}
return to_json_serializable(field_dict)
# For anything else, convert to string
return str(obj)
# ============================================================================
# Metric Aggregator
# ============================================================================
class MetricAggregator:
"""Helper for collecting and aggregating metrics from multiple sources.
This class provides a convenient way to collect metrics from various
subsystems and produce a single DashboardSnapshot.
"""
def __init__(self) -> None:
self._system = SystemMetrics()
self._learning = LearningMetrics()
self._storage = StorageMetrics()
self._self_org = SelfOrganizationMetrics()
self._homeostasis = HomeostasisMetrics()
self._structural = StructuralMetrics()
self._spikes = SpikeMetrics()
self._network = NetworkMetrics()
self._language_organ = LanguageOrganMetrics()
self._knowledge_intake = KnowledgeIntakeMetrics()
self._signal_metrics = SignalMetrics()
self._experiment = ExperimentMetrics()
self._embodiment = EmbodimentMetrics()
self._status: str = "idle"
self._version: str = BRAIN5D_VERSION_DISPLAY
def update_system(self, **kwargs: Any) -> MetricAggregator:
"""Update SystemMetrics fields."""
fields = {k: v for k, v in kwargs.items() if hasattr(self._system, k)}
self._system = SystemMetrics(**{**self._system.__dict__, **fields})
return self
def update_learning(self, **kwargs: Any) -> MetricAggregator:
"""Update LearningMetrics fields."""
fields = {k: v for k, v in kwargs.items() if hasattr(self._learning, k)}
self._learning = LearningMetrics(**{**self._learning.__dict__, **fields})
return self
def update_homeostasis(self, **kwargs: Any) -> MetricAggregator:
"""Update HomeostasisMetrics fields."""
fields = {k: v for k, v in kwargs.items() if hasattr(self._homeostasis, k)}
self._homeostasis = HomeostasisMetrics(
**{**self._homeostasis.__dict__, **fields}
)
return self
def update_structural(self, **kwargs: Any) -> MetricAggregator:
"""Update StructuralMetrics fields."""
fields = {k: v for k, v in kwargs.items() if hasattr(self._structural, k)}
self._structural = StructuralMetrics(**{**self._structural.__dict__, **fields})
return self
def update_spikes(self, **kwargs: Any) -> MetricAggregator:
"""Update SpikeMetrics fields."""
fields = {k: v for k, v in kwargs.items() if hasattr(self._spikes, k)}
self._spikes = SpikeMetrics(**{**self._spikes.__dict__, **fields})
return self
def update_network(self, **kwargs: Any) -> MetricAggregator:
"""Update NetworkMetrics fields."""
fields = {k: v for k, v in kwargs.items() if hasattr(self._network, k)}
self._network = NetworkMetrics(**{**self._network.__dict__, **fields})
return self
def update_embodiment(self, **kwargs: Any) -> MetricAggregator:
"""Update only fields published by the embodiment contract."""
fields = {k: v for k, v in kwargs.items() if hasattr(self._embodiment, k)}
self._embodiment = EmbodimentMetrics(**{**self._embodiment.__dict__, **fields})
return self
def set_status(self, status: str) -> MetricAggregator:
"""Set the dashboard status."""
self._status = status
return self
def set_version(self, version: str) -> MetricAggregator:
"""Set the system version."""
self._version = version
return self
def snapshot(self) -> DashboardSnapshot:
"""Build the complete dashboard snapshot."""
return DashboardSnapshot(
system=self._system,
learning=self._learning,
storage=self._storage,
self_organization=self._self_org,
homeostasis=self._homeostasis,
structural=self._structural,
spikes=self._spikes,
network=self._network,
language_organ=self._language_organ,
knowledge_intake=self._knowledge_intake,
signal_metrics=self._signal_metrics,
experiment=self._experiment,
embodiment=self._embodiment,
status=self._status,
version=self._version,
)
|