Skip to content

Fix mutable default error in MetricsConfig dataclasses #3137

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
43 changes: 25 additions & 18 deletions torchrec/metrics/metrics_config.py
Original file line number Diff line number Diff line change
Expand Up @@ -197,25 +197,32 @@ class MetricsConfig:
)


DefaultMetricsConfig = MetricsConfig(
rec_tasks=[DefaultTaskInfo],
rec_metrics={
RecMetricEnum.NE: RecMetricDef(
rec_tasks=[DefaultTaskInfo], window_size=_DEFAULT_WINDOW_SIZE
),
},
throughput_metric=ThroughputDef(),
state_metrics=[],
)
def _create_default_metrics_config() -> MetricsConfig:
return MetricsConfig(
rec_tasks=[DefaultTaskInfo],
rec_metrics={
RecMetricEnum.NE: RecMetricDef(
rec_tasks=[DefaultTaskInfo], window_size=_DEFAULT_WINDOW_SIZE
),
},
throughput_metric=ThroughputDef(),
state_metrics=[],
)

# Explicitly specifying the empty fields to avoid any mistakes cased by simply
# relying on the Python default values, e.g., MetricConfig().
EmptyMetricsConfig = MetricsConfig(
rec_tasks=[],
rec_metrics={},
throughput_metric=None,
state_metrics=[],
)

def _create_empty_metrics_config() -> MetricsConfig:
# Explicitly specifying the empty fields to avoid any mistakes cased by simply
# relying on the Python default values, e.g., MetricConfig().
return MetricsConfig(
rec_tasks=[],
rec_metrics={},
throughput_metric=None,
state_metrics=[],
)


DefaultMetricsConfig: MetricsConfig = _create_default_metrics_config()
EmptyMetricsConfig: MetricsConfig = _create_empty_metrics_config()


@dataclass
Expand Down
Loading