Strong typing by hmgaudecker · Pull Request #83 · OpenSourceEconomics/skillmodels

hmgaudecker · 2026-01-08T18:15:56Z

Refactor model configuration to use frozen dataclasses instead of dicts

Introduce strongly-typed dataclasses for model configuration:

ModelSpec instance replaces the nested dicts as the main entry point (also remove yaml files)
Dimensions, Labels, Anchoring, EstimationOptions, TransitionInfo
FactorEndogenousInfo, EndogenousFactorsInfo

🤖 Generated with Claude Code

Introduce strongly-typed dataclasses for model configuration: - Dimensions, Labels, Anchoring, EstimationOptions, TransitionInfo - FactorEndogenousInfo, EndogenousFactorsInfo This improves type safety and enables IDE autocompletion while keeping user-facing model_dict as a plain dictionary. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

codecov · 2026-01-08T18:18:54Z

Codecov Report

❌ Patch coverage is 91.40000% with 129 lines in your changes missing coverage. Please review.
✅ Project coverage is 90.32%. Comparing base (dc87cf5) to head (7cf471a).

Files with missing lines	Patch %	Lines
src/skillmodels/model_spec.py	59.84%	51 Missing ⚠️
src/skillmodels/correlation_heatmap.py	48.14%	28 Missing ⚠️
src/skillmodels/utilities.py	90.69%	8 Missing ⚠️
src/skillmodels/simulate_data.py	83.33%	7 Missing ⚠️
src/skillmodels/visualize_factor_distributions.py	85.10%	7 Missing ⚠️
src/skillmodels/check_model.py	87.50%	6 Missing ⚠️
src/skillmodels/types.py	94.11%	6 Missing ⚠️
src/skillmodels/visualize_transition_equations.py	90.00%	5 Missing ⚠️
src/skillmodels/process_data.py	92.85%	3 Missing ⚠️
src/skillmodels/process_model.py	96.42%	3 Missing ⚠️
... and 3 more

Additional details and impacted files

@@            Coverage Diff             @@
##             main      #83      +/-   ##
==========================================
- Coverage   91.02%   90.32%   -0.70%     
==========================================
  Files          42       47       +5     
  Lines        3587     3919     +332     
==========================================
+ Hits         3265     3540     +275     
- Misses        322      379      +57

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

Replace dict fields with frozendict in frozen dataclasses to ensure true immutability: - Labels.aug_periods_to_periods - Labels.aug_stages_to_stages - Anchoring.outcomes - TransitionInfo.param_names, individual_functions, function_names - EndogenousFactorsInfo.aug_periods_to_aug_period_meas_types, factor_info 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

Update process_model() to return a ProcessedModel frozen dataclass and update all consumers to use attribute access instead of dict access. This provides: - Better type safety with explicit typed fields - Immutability via frozen dataclass - IDE autocomplete support - Clear documentation of the model structure 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

…c so that config.TEST_DATA_DIR is valid also for skillmodels the package (as opposed to the project).

review-notebook-app · 2026-01-09T13:43:46Z

Check out this pull request on

See visual diffs & provide feedback on Jupyter Notebooks.

Powered by ReviewNB

…f NDArray.

hmgaudecker · 2026-01-28T06:45:02Z

Code review

No issues found. Checked for bugs and CLAUDE.md compliance.

🤖 Generated with Claude Code

_{- If this code review was useful, please react with 👍. Otherwise, react with 👎.}

janosg · 2026-02-15T07:58:21Z

docs/how_to_guides/model_specs.md

+```python
+from skillmodels import (
+    AnchoringSpec,
+    EstimationOptionsSpec,


Better just EstimationSpec

janosg · 2026-02-15T08:00:36Z

docs/reference_guides/endogeneity_corrections.md

+
+## Implementation Status
+
+None of these correction methods are currently implemented in skillmodels. Users


This is probably outdated? You implemented Endogeneity correction

janosg · 2026-02-15T08:03:15Z

src/skillmodels/test_data/model2.py

+    Normalizations,
+)
+
+MODEL2 = ModelSpec(


I'm quite impressed you well Claude decided which things should be dataclasses and where we keep dictionaries.

I think this will be a thing where I'll mostly take credit for the vibes at least. Needed several iterations.

janosg · 2026-02-15T08:07:59Z

docs/explanations/names_and_concepts.md

+
+## Dimensions
+
+The `Dimensions` dataclass contains integer values for model dimensions:


These section can now replaced with autodoc / autoclass; That's one of the benefits of strong typing! Results are best if attribute docstrings come right after the attribute like here

Limitation of jb book for now, we can convert once available.

janosg · 2026-02-15T08:11:30Z

src/skillmodels/types.py

+from jax import Array
+
+
+def _make_immutable(value: object) -> object:


I don't know where this is used but I tend to keep dicts and lists for data that should not be represented as a dataclass. It's more intuitive for most Python users and using tuples for lists of variables does not work well with pandas.

janosg · 2026-02-15T08:14:21Z

src/skillmodels/types.py

+
+
+@dataclass(frozen=True)
+class EstimationOptions:


Defaults should now be set in the dataclasses which gives us a much nicer way to document them. Again, another main benefit of strongly typed code. Setting defaults when everything is a dict is very annoying and it's now probably a bit scattered throughout the processing.

hmgaudecker changed the title ~~Move to strong tzping~~ Strong typing Jan 8, 2026

hmgaudecker and others added 3 commits January 8, 2026 19:29

Ignore ty false positive.

562cfaa

hmgaudecker marked this pull request as draft January 9, 2026 04:52

hmgaudecker and others added 6 commits January 9, 2026 05:59

Rename FactorEndogenousInfo to FactorInfo

264016c

🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

Ensure complete typing in src/skillmodels.

3bb334b

Require Python 3.14 before fixing type annotations.

e2d687a

Move TESTS_DIR -> TEST_DATA_DIR, which points to a subdirectory of sr…

921c612

…c so that config.TEST_DATA_DIR is valid also for skillmodels the package (as opposed to the project).

Fix more linting issues.

dce66ad

Make ruff rules much stricter.

e0f59d0

hmgaudecker added 8 commits January 11, 2026 11:04

Further tighten type annotations. Fix a missing run-time annotation o…

b15372a

…f NDArray.

Move unsafe_fixes = false from .pre-commit config to pyproject.

74b2f18

Fix query in data simulation.

04aaa10

More fixes to imports, add test.

493ead0

Use more tuples in place of lists to prevent errors.

51209ad

Fix typing.

21da176

Dataclasses for user input.

5925303

Simplify.

9590c46

hmgaudecker added 7 commits January 28, 2026 08:32

Use modern rng everywhere.

69f6eab

Update CLAUDE.md

f8dac75

Get rid of if TYPE_CHECKING blocks

846534b

Update hooks and clean up

97d84b8

Call by name throughout.

b8a9fbc

Autogenerated docs, harmonised hooks / project configuration.

5012a8b

Get rid of model_dict.

7e7784e

hmgaudecker force-pushed the strong-typing branch from efd2e9f to 7e7784e Compare January 30, 2026 07:51

Replace yaml model specifications by ModelSpec-s.

6934f79

hmgaudecker marked this pull request as ready for review January 30, 2026 12:50

hmgaudecker requested a review from janosg January 30, 2026 12:51

Next shot at fixing pickling.

7cf471a

janosg approved these changes Feb 15, 2026

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Strong typing#83

Strong typing#83
hmgaudecker wants to merge 27 commits intomainfrom
strong-typing

hmgaudecker commented Jan 8, 2026 •

edited

Loading

Uh oh!

codecov bot commented Jan 8, 2026 •

edited

Loading

Uh oh!

review-notebook-app bot commented Jan 9, 2026

Uh oh!

hmgaudecker commented Jan 28, 2026

Uh oh!

janosg Feb 15, 2026

Uh oh!

janosg Feb 15, 2026

Uh oh!

janosg Feb 15, 2026

Uh oh!

hmgaudecker Feb 15, 2026

Uh oh!

janosg Feb 15, 2026

Uh oh!

hmgaudecker Feb 15, 2026

Uh oh!

janosg Feb 15, 2026

Uh oh!

janosg Feb 15, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants


		## Implementation Status

		None of these correction methods are currently implemented in skillmodels. Users


		## Dimensions

		The `Dimensions` dataclass contains integer values for model dimensions:

		from jax import Array


		def _make_immutable(value: object) -> object:



		@dataclass(frozen=True)
		class EstimationOptions:

Conversation

hmgaudecker commented Jan 8, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

codecov bot commented Jan 8, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

review-notebook-app bot commented Jan 9, 2026

Uh oh!

hmgaudecker commented Jan 28, 2026

Code review

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

hmgaudecker commented Jan 8, 2026 •

edited

Loading

codecov bot commented Jan 8, 2026 •

edited

Loading