Skip to content

redesign tutorial notebooks - #15

Merged
thomaspinder merged 8 commits into
mainfrom
redesign-tutorial-notebooks
Feb 27, 2026
Merged

redesign tutorial notebooks#15
thomaspinder merged 8 commits into
mainfrom
redesign-tutorial-notebooks

Conversation

@thomaspinder

@thomaspinder thomaspinder commented Feb 22, 2026

Copy link
Copy Markdown
Collaborator
  • docs: redesign tutorial notebooks with narrative and plots
  • Add deployment preview

thomaspinder and others added 2 commits February 22, 2026 21:21
@thomaspinder @claude
docs: redesign tutorial notebooks with narrative and plots
2f4b000 
Rewrite quickstart, forecasting, and structural-analysis notebooks
from API indexes into narrative tutorials with motivated synthetic
data (3-variable macro economy), interpretive markdown between every
code cell, and .plot() calls on all result types. Update tutorials
index page with overview table. Enrich CLAUDE.md with architecture
docs and additional commands.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
@thomaspinder
Add deployment preview
7e32a63
@thomaspinder
thomaspinder merged commit f6ce47f into main Feb 27, 2026
9 checks passed
@thomaspinder
thomaspinder deleted the redesign-tutorial-notebooks branch February 27, 2026 07:34
This was referenced May 18, 2026
Closed
Merged
thomaspinder added a commit that referenced this pull request May 18, 2026
@thomaspinder @claude
chore: docstring + naming + repr cleanup, bump 0.0.6 (closes #78)
6ed2c7e 
Wraps up the spring-cleaning stack. Individually small fixes that
cluster naturally into one style PR.

- src/impulso/volatility.py: `Constant.cholesky_path` /
  `forecast_cholesky_path` docstrings reference `L` (the actual
  posterior key after #69) instead of `Sigma`; cross-ref
  `Constant.cholesky_at` as the canonical accessor.
- src/impulso/sv/data.py: `_MIN_OBS` is now `ClassVar[int] = 24` —
  makes the class-attribute intent explicit instead of relying on
  Pydantic's implicit underscore handling.
- src/impulso/fitted.py: `FittedVAR.has_exog` drops `@computed_field`
  (now a plain `@property`) so it stops appearing in `model_dump()`.
- src/impulso/sv/dynamics.py: `RandomWalk.build_latent_path` /
  `AR1.build_latent_path` swap `Any` for `"pt.TensorVariable"` forward
  refs that match the SVDynamics Protocol declaration; drop the
  now-unused `Any` import.
- src/impulso/results.py: delete `VARResultBase.__repr__` override —
  Pydantic's default produces a useful compact repr because every
  `idata` field has `Field(repr=False)`.
- src/impulso/**/*.py: docstring sweep — double backticks (RST) → single
  backticks (Markdown / mkdocstrings); no more `:meth:` / `:class:`
  cross-refs (replaced with plain backticked names in earlier passes).
- CLAUDE.md: codify the docstring convention under "Code Conventions".
- src/impulso/identified.py: delete
  `forecast_error_variance_decomposition`; `fevd` is the canonical
  name. Docstring + .qmd / .md cross-references updated.
- pyproject.toml + uv.lock: bump `0.0.5 → 0.0.6` to ship the cumulative
  audit cleanup (#73 + #75 + #77 + this PR).

Closes audit findings #5, #8, #12, #13, #14, #15, #16
(reports/audit-2026-05-18.md).

Breaking (pre-v0.1): callers of
`IdentifiedVAR.forecast_error_variance_decomposition` must use
`IdentifiedVAR.fevd` (no signature change). The long name was always
an alias; per repo policy pre-v0.1 API breaks are in scope.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
thomaspinder added a commit that referenced this pull request May 18, 2026
@thomaspinder @claude
chore: docstring + naming + repr cleanup, bump 0.0.6 (closes #78) (#79)
0b341ae 
Wraps up the spring-cleaning stack. Individually small fixes that
cluster naturally into one style PR.

- src/impulso/volatility.py: `Constant.cholesky_path` /
  `forecast_cholesky_path` docstrings reference `L` (the actual
  posterior key after #69) instead of `Sigma`; cross-ref
  `Constant.cholesky_at` as the canonical accessor.
- src/impulso/sv/data.py: `_MIN_OBS` is now `ClassVar[int] = 24` —
  makes the class-attribute intent explicit instead of relying on
  Pydantic's implicit underscore handling.
- src/impulso/fitted.py: `FittedVAR.has_exog` drops `@computed_field`
  (now a plain `@property`) so it stops appearing in `model_dump()`.
- src/impulso/sv/dynamics.py: `RandomWalk.build_latent_path` /
  `AR1.build_latent_path` swap `Any` for `"pt.TensorVariable"` forward
  refs that match the SVDynamics Protocol declaration; drop the
  now-unused `Any` import.
- src/impulso/results.py: delete `VARResultBase.__repr__` override —
  Pydantic's default produces a useful compact repr because every
  `idata` field has `Field(repr=False)`.
- src/impulso/**/*.py: docstring sweep — double backticks (RST) → single
  backticks (Markdown / mkdocstrings); no more `:meth:` / `:class:`
  cross-refs (replaced with plain backticked names in earlier passes).
- CLAUDE.md: codify the docstring convention under "Code Conventions".
- src/impulso/identified.py: delete
  `forecast_error_variance_decomposition`; `fevd` is the canonical
  name. Docstring + .qmd / .md cross-references updated.
- pyproject.toml + uv.lock: bump `0.0.5 → 0.0.6` to ship the cumulative
  audit cleanup (#73 + #75 + #77 + this PR).

Closes audit findings #5, #8, #12, #13, #14, #15, #16
(reports/audit-2026-05-18.md).

Breaking (pre-v0.1): callers of
`IdentifiedVAR.forecast_error_variance_decomposition` must use
`IdentifiedVAR.fevd` (no signature change). The long name was always
an alias; per repo policy pre-v0.1 API breaks are in scope.

Co-authored-by: Claude Opus 4.7 (1M context) <noreply@anthropic.com>

This branch was previously deployed

1 inactive deployment
docs-preview — 54aea5a5 Deployed Feb 27, 2026 by thomaspinder via deploy-docs-preview #32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

1 participant

@thomaspinder