[v4] Refresh docs + example for agent-first surface#295
Open
MaxGhenis wants to merge 1 commit intov4-base-extractionfrom
Open
[v4] Refresh docs + example for agent-first surface#295MaxGhenis wants to merge 1 commit intov4-base-extractionfrom
MaxGhenis wants to merge 1 commit intov4-base-extractionfrom
Conversation
MaxGhenis
force-pushed
the
v4-docs-refresh
branch
from
9a16963 to
124fc7a
Compare
MaxGhenis
force-pushed
the
v4-base-extraction
branch
from
7996660 to
b1fce7e
Compare
- README and core-concepts now lead with pe.uk/pe.us entry points and
pe.uk.calculate_household / pe.us.calculate_household (flat kwargs,
dot-access result, dict reforms).
- economic-impact-analysis, country-models-{uk,us}, and
regions-and-scoping switched from `from policyengine.tax_benefit_models...`
to the top-level facade.
- Removed the "Legacy filter fields" section from regions-and-scoping
now that filter_field/filter_value have been dropped (v4 breaking).
- dev.md package-layout diagram updated to mention common/ base,
provenance/ subpackage, and the MicrosimulationModelVersion extraction.
- examples/household_impact_example.py rewritten against the v4 API and
verified end-to-end against both UK and US models.
MaxGhenis
force-pushed
the
v4-docs-refresh
branch
from
124fc7a to
104579b
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Refreshes documentation and the
household_impact_examplescript for the v4 agent-first surface. All user-facing docs now teach thepe.uk.*/pe.us.*entry points first.Changed:
README.md: Quick start leads withpe.{uk,us}.calculate_household(flat kwargs, dot-access, dict reforms), then shows population-analysis path.docs/core-concepts.md: New "Quick start" section above the architecture overview. Lower-level import paths retained as a shortcut comment next to the mainpe.uk/pe.usidiom.docs/economic-impact-analysis.md: Both UK and US examples now importpolicyengine as peand callpe.{uk,us}.economic_impact_analysis.docs/country-models-{uk,us}.md: Each gets a Quick start at the top demonstratingpe.{uk,us}.calculate_householdwith a simple case, a compound household, and a reform.docs/regions-and-scoping.md: Switched tope.{us,uk}.model.region_registry. Removed the "Legacy filter fields" section documentingfilter_field/filter_value(dropped in [v4] Drop legacy filter_field/filter_value scoping fields #290).docs/dev.md: Package-layout diagram now includestax_benefit_models/common/,provenance/, and mentions the base-class extraction. "Country-specific model classes" description updated for the new inheritance model.docs/examples.md: "Household impact calculation" section retitled to "Household calculation" and reworded for the new API.examples/household_impact_example.py: Rewritten end-to-end; verified by running both UK and US cases against installed country models.Safety
examples/household_impact_example.pyruns end-to-end (both UK and US cases produce non-zero tax/benefit values).Stack
Stacked on #294 (MicrosimulationModelVersion base). Will retarget to
mainonce the preceding stack merges.Test plan
python examples/household_impact_example.pyproduces expected numeric output for both countriescalculate_household_impact,UKHouseholdInput,USHouseholdInput, orfilter_field/filter_valueindocs/orREADME.md🤖 Generated with Claude Code