1 rri_metrics.logging

rri_metrics.logging

Canonical names and key policy for logged VIN metrics and losses.

This module owns stable Lightning key composition and stage-specific emission policy. Stateful metric implementations live in their aria_nbv.rri_metrics owner modules.

1.1 Classes

Name	Description
LogSpec	Logging policy for a metric/loss.
Loss	Loss suffixes composed with Stage as `{stage}/{loss}`.
Metric	Metric suffixes composed with Stage as `{stage}/{metric}`.

1.1.1 LogSpec

rri_metrics.logging.LogSpec(on_step, on_epoch, prog_bar, enabled=True)

Logging policy for a metric/loss.

1.1.1.1 Attributes

Name	Type	Description
on_step	bool	Log on step-level updates.
on_epoch	bool	Log epoch-level aggregates.
prog_bar	bool	Show in Lightning’s progress bar.
enabled	bool	Whether logging is enabled for the current stage.

1.1.2 Loss

rri_metrics.logging.Loss()

Loss suffixes composed with Stage as {stage}/{loss}.

1.1.2.1 Methods

Name	Description
log_spec	Resolve the stage-specific logging policy for this loss key.

1.1.2.1.1 log_spec

rri_metrics.logging.Loss.log_spec(stage)

Resolve the stage-specific logging policy for this loss key.

1.1.3 Metric

rri_metrics.logging.Metric()

Metric suffixes composed with Stage as {stage}/{metric}.

1.1.3.1 Attributes

Name	Description
LOSS	Legacy loss key (prefer `Loss` for losses).

1.1.3.2 Methods

Name	Description
log_spec	Resolve the stage-specific logging policy for this metric key.

1.1.3.2.1 log_spec

rri_metrics.logging.Metric.log_spec(stage)

Resolve the stage-specific logging policy for this metric key.

1.2 Functions

Name	Description
loss_key	Compose a logging key using the stage prefix.
metric_key	Compose a logging key using the stage prefix.

1.2.1 loss_key

rri_metrics.logging.loss_key(stage, loss, *, namespace='main')

Compose a logging key using the stage prefix.

1.2.2 metric_key

rri_metrics.logging.metric_key(stage, metric, *, namespace='main')

Compose a logging key using the stage prefix.

# rri_metrics.logging { #aria_nbv.rri_metrics.logging } `rri_metrics.logging` Canonical names and key policy for logged VIN metrics and losses. This module owns stable Lightning key composition and stage-specific emission policy. Stateful metric implementations live in their :mod:`aria_nbv.rri_metrics` owner modules. ## Classes | Name | Description | | --- | --- | | [LogSpec](#aria_nbv.rri_metrics.logging.LogSpec) | Logging policy for a metric/loss. | | [Loss](#aria_nbv.rri_metrics.logging.Loss) | Loss suffixes composed with Stage as ``{stage}/{loss}``. | | [Metric](#aria_nbv.rri_metrics.logging.Metric) | Metric suffixes composed with Stage as ``{stage}/{metric}``. | ### LogSpec { #aria_nbv.rri_metrics.logging.LogSpec } ```python rri_metrics.logging.LogSpec(on_step, on_epoch, prog_bar, enabled=True) ``` Logging policy for a metric/loss. #### Attributes {.doc-section .doc-section-attributes} | Name | Type | Description | |----------|----------------|---------------------------------------------------| | on_step | [bool](`bool`) | Log on step-level updates. | | on_epoch | [bool](`bool`) | Log epoch-level aggregates. | | prog_bar | [bool](`bool`) | Show in Lightning's progress bar. | | enabled | [bool](`bool`) | Whether logging is enabled for the current stage. | ### Loss { #aria_nbv.rri_metrics.logging.Loss } ```python rri_metrics.logging.Loss() ``` Loss suffixes composed with Stage as ``{stage}/{loss}``. #### Methods | Name | Description | | --- | --- | | [log_spec](#aria_nbv.rri_metrics.logging.Loss.log_spec) | Resolve the stage-specific logging policy for this loss key. | ##### log_spec { #aria_nbv.rri_metrics.logging.Loss.log_spec } ```python rri_metrics.logging.Loss.log_spec(stage) ``` Resolve the stage-specific logging policy for this loss key. ### Metric { #aria_nbv.rri_metrics.logging.Metric } ```python rri_metrics.logging.Metric() ``` Metric suffixes composed with Stage as ``{stage}/{metric}``. #### Attributes | Name | Description | | --- | --- | | [LOSS](#aria_nbv.rri_metrics.logging.Metric.LOSS) | Legacy loss key (prefer `Loss` for losses). | #### Methods | Name | Description | | --- | --- | | [log_spec](#aria_nbv.rri_metrics.logging.Metric.log_spec) | Resolve the stage-specific logging policy for this metric key. | ##### log_spec { #aria_nbv.rri_metrics.logging.Metric.log_spec } ```python rri_metrics.logging.Metric.log_spec(stage) ``` Resolve the stage-specific logging policy for this metric key. ## Functions | Name | Description | | --- | --- | | [loss_key](#aria_nbv.rri_metrics.logging.loss_key) | Compose a logging key using the stage prefix. | | [metric_key](#aria_nbv.rri_metrics.logging.metric_key) | Compose a logging key using the stage prefix. | ### loss_key { #aria_nbv.rri_metrics.logging.loss_key } ```python rri_metrics.logging.loss_key(stage, loss, *, namespace='main') ``` Compose a logging key using the stage prefix. ### metric_key { #aria_nbv.rri_metrics.logging.metric_key } ```python rri_metrics.logging.metric_key(stage, metric, *, namespace='main') ``` Compose a logging key using the stage prefix.