The debug_tools.md Module Overview table lists 8 modules, but the vajax.debug package exports two additional public modules that are not documented:
simulation_tracer (exports: SimulationTracer, NodeAllocation, VoltageMapping, DeviceParamsTrace, trace_simulation)trace_monitor (exports: TraceScope, get_trace_counts, monitor_dict, print_traces, report_traces, reset_traces, trace_monitor)
Both are in the __all__ list in vajax/debug/__init__.py and provide useful debugging utilities.
File: docs/debug_tools.md, Module Overview table.
Fix: Add both modules to the module overview table with descriptions, and add documentation sections for SimulationTracer and TraceScope.
The
debug_tools.mdModule Overview table lists 8 modules, but thevajax.debugpackage exports two additional public modules that are not documented:simulation_tracer(exports:SimulationTracer,NodeAllocation,VoltageMapping,DeviceParamsTrace,trace_simulation)trace_monitor(exports:TraceScope,get_trace_counts,monitor_dict,print_traces,report_traces,reset_traces,trace_monitor)Both are in the
__all__list invajax/debug/__init__.pyand provide useful debugging utilities.File:
docs/debug_tools.md, Module Overview table.Fix: Add both modules to the module overview table with descriptions, and add documentation sections for
SimulationTracerandTraceScope.