Skip to content

Expose public configs through dynestyx.config - #443

Open
mattlevine22 wants to merge 1 commit into
mainfrom
codex/issue-438-configs
Open

mattlevine22 wants to merge 1 commit into
mainfrom
codex/issue-438-configs

Conversation

@mattlevine22

Copy link
Copy Markdown
Collaborator

Closes #438.

Changes

  • Add dsx.config as a single entry point for filter, smoother, MCMC, discretizer, simulator, and observation-scoring configs. Existing imports continue to resolve to the same objects.
  • Add a Configurations page under Public API, with filter options grouped by time domain, finite-state models, and localization and resampling.
  • Update the filter and smoother examples and correct the continuous-time filter reference list.
import dynestyx as dsx

filter_handler = dsx.Filter(filter_config=dsx.config.EnKFConfig(n_particles=64))

Verification

Ruff lint and formatting checks passed. MkDocs built successfully with documentation warnings.

@DanWaxman DanWaxman left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks fine, strictly speaking. Though, I wonder if it makes sense to just include the config files in dynestyx/configs directly? I think there's a valid argument they don't actually belong in dynestyx/inference...

In this case, would make sense to have a shim with a DeprecationWarning for a bit.

@mattlevine22

Copy link
Copy Markdown
Collaborator Author

This looks fine, strictly speaking. Though, I wonder if it makes sense to just include the config files in dynestyx/configs directly? I think there's a valid argument they don't actually belong in dynestyx/inference...

In this case, would make sense to have a shim with a DeprecationWarning for a bit.

I prefer this too, modulo the beefy PR it creates...I had codex go for it in #444, but I'll admit I'm not excited to read it. It looks pretty right though.

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Make Configs easier to get to from dsx.

2 participants