Skip to content

Improve documentation #131

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.

Sign up for GitHub

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

Merged
nikhilwoodruff merged 2 commits into from
Jun 16, 2025
Merged

Improve documentation #131

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
50b073a
Fix documentation
nikhilwoodruff Jun 16, 2025
76c001f
Versioning
nikhilwoodruff Jun 16, 2025
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
4 changes: 4 additions & 0 deletions changelog_entry.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
- bump: patch
changes:
fixed:
- Documentation used 2022 datasets rather than 2025.
7,288 changes: 7,078 additions & 210 deletions docs/methodology.ipynb
View file
Open in desktop

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions docs/validation/national.ipynb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
},
{
"cell_type": "code",
"execution_count": 1,
"execution_count": null,
"metadata": {},
"outputs": [
{
Expand Down Expand Up @@ -177,7 +177,7 @@
"def get_validation():\n",
" df = pd.DataFrame()\n",
" for dataset in [FRS_2022_23, EnhancedFRS_2022_23]:\n",
" for year in range(2022, 2029):\n",
" for year in range(2025, 2029):\n",
" loss_results = get_loss_results(dataset, year)\n",
" loss_results[\"time_period\"] = year\n",
" loss_results[\"dataset\"] = dataset.label\n",
Expand Down
21 changes: 21 additions & 0 deletions policyengine_uk_data/storage/download_completed_datasets.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
from policyengine_uk_data.utils.huggingface import download, upload
from pathlib import Path


FOLDER = Path(__file__).parent

FILES = [
"enhanced_frs_2022_23.h5",
"frs_2022_23.h5",
"parliamentary_constituency_weights.h5",
"local_authority_weights.h5",
]

FILES = [FOLDER / file for file in FILES]

for file in FILES:
download(
repo="policyengine/policyengine-uk-data",
repo_filename=file.name,
local_folder=file.parent,
)
Loading