Merge remote-tracking branch 'upstream/master' into tpi_out

Author: jdebacker

.github/workflows/build_and_test.yml

@@ -50,7 +50,7 @@ jobs:
         shell: bash -l {0}
         working-directory: ./
         run: |
-          python -m pytest -m "not local" --cov=./ --cov-report=xml
+          python -m pytest -m "not local and not benchmark" --cov=./ --cov-report=xml
       - name: Upload coverage to Codecov
         if: matrix.os == 'ubuntu-latest' && contains(github.repository, 'PSLmodels/OG-Core')
         uses: codecov/codecov-action@v4

CHANGELOG.md

@@ -6,6 +6,37 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
 
+## [0.14.8] - 2025-08-26 12:00:00
+
+### Added
+
+- Adds a complete benchmark suite for measuring and optimizing Dask performance in OG-Core, with particular focus on Windows performance issues.
+- New and updated files:
+    - tests/test_dask_benchmarks.py: Mock benchmark tests with synthetic workloads
+    - tests/test_real_txfunc_benchmarks.py: Real-world tax function benchmarks
+    - tests/run_benchmarks.py: Automated benchmark runner with reporting
+    - tests/BENCHMARK_README.md: Comprehensive documentation and usage guide
+    - pytest.ini: Updated with benchmark test markers
+- Key features:
+    - Platform-specific optimization tests (Windows, macOS, Linux)
+    - Memory usage and compute time benchmarking
+    - Baseline establishment and performance regression detection
+    - Comparison of different Dask schedulers and client configurations
+    - Real tax function estimation performance measurement
+    - Automated identification of optimal Dask settings per platform
+- Benefits:
+    - Establishes performance baselines before optimization work
+    - Identifies Windows-specific Dask performance bottlenecks
+    - Provides automated regression detection for future changes
+    - Enables data-driven optimization decisions
+    - Supports continuous performance monitoring
+- Usage:
+    - `python tests/run_benchmarks.py  # Run all benchmarks`
+    - `python tests/run_benchmarks.py --quick  # Quick benchmarks only`
+    - `python tests/run_benchmarks.py --save-baseline  # Save performance baseline`
+    - `python tests/run_benchmarks.py --compare-baseline # Compare against baseline`
+- 🤖 Generated with help from Claude Code
+
 ## [0.14.7] - 2025-08-21 17:00:00
 
 ### Added
@@ -409,6 +440,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Any earlier versions of OG-USA can be found in the [`OG-Core`](https://github.com/PSLmodels/OG-Core) repository [release history](https://github.com/PSLmodels/OG-Core/releases) from [v.0.6.4](https://github.com/PSLmodels/OG-Core/releases/tag/v0.6.4) (Jul. 20, 2021) or earlier.
 
 
+[0.14.8]: https://github.com/PSLmodels/OG-Core/compare/v0.14.7...v0.14.8
 [0.14.7]: https://github.com/PSLmodels/OG-Core/compare/v0.14.6...v0.14.7
 [0.14.6]: https://github.com/PSLmodels/OG-Core/compare/v0.14.5...v0.14.6
 [0.14.5]: https://github.com/PSLmodels/OG-Core/compare/v0.14.4...v0.14.5

run_examples/example-diffs examples/example-diffsrun_examples/example-diffs renamed to examples/example-diffs

@@ -21,10 +21,6 @@
 # Use a custom matplotlib style file for plots
 plt.style.use("ogcore.OGcorePlots")
 
-# Set verbosity
-ogcore.SS.VERBOSE = False
-ogcore.TPI.VERBOSE = False
-
 
 def main():
     # Define parameters to use for multiprocessing

run_examples/example-diffs.bat examples/example-diffs.batrun_examples/example-diffs.bat renamed to examples/example-diffs.bat

@@ -11,7 +11,6 @@
 import warnings
 import logging
 
-
 if not SHOW_RUNTIME:
     warnings.simplefilter("ignore", RuntimeWarning)
 
@@ -1273,27 +1272,25 @@ def SS_fsolve(guesses, *args):
             + list(error_BQ)
             + [error_TR]
         )
-    logging.info(f"GE loop errors = ", [f"{error:.3e}" for error in errors])
+    error_string = [f"{error:.3e}" for error in errors]
+    logging.info(f"GE loop errors = {error_string}")
 
     return errors
 
 
-def run_SS(p, client=None, verbose=False):
+def run_SS(p, client=None):
     """
     Solve for steady-state equilibrium of OG-Core.
 
     Args:
         p (OG-Core Specifications object): model parameters
         client (Dask client object): client
-        verbose (bool): if True, set logging to INFO level
 
     Returns:
         output (dictionary): dictionary with steady-state solution
             results
 
     """
-    # Configure logging level based on verbose parameter
-    config.set_logging_level(verbose)
     # Create list of deviation factors for initial guesses of r and TR
     dev_factor_list = [
         [1.00, 1.0],

…mples/expected_ogcore_example_output.csv …mples/expected_ogcore_example_output.csvrun_examples/expected_ogcore_example_output.csv renamed to examples/expected_ogcore_example_output.csv run_examples/expected_ogcore_example_output.csv renamed to examples/expected_ogcore_example_output.csv

@@ -543,28 +543,22 @@ def inner_loop(guesses, outer_loop_vars, initial_values, ubi, j, ind, p):
         n_vec = solutions.x[p.S :]
         n_mat[t + ind, ind] = n_vec
 
-    # print('Type ', j, ' max euler error = ',
-    #       np.absolute(euler_errors).max())
-
     return euler_errors, b_mat, n_mat
 
 
-def run_TPI(p, client=None, verbose=False):
+def run_TPI(p, client=None):
     """
     Solve for transition path equilibrium of OG-Core.
 
     Args:
         p (OG-Core Specifications object): model parameters
         client (Dask client object): client
-        verbose (bool): if True, set logging to INFO level
 
     Returns:
         output (dictionary): dictionary with transition path solution
             results
 
     """
-    # Configure logging level based on verbose parameter
-    config.set_logging_level(verbose)
     # unpack tuples of parameters
     initial_values, ss_vars, theta, baseline_values = get_initial_SS_values(p)
     (B0, b_sinit, b_splus1init, factor, initial_b, initial_n) = initial_values
@@ -1187,7 +1181,7 @@ def run_TPI(p, client=None, verbose=False):
         #         print 'New Value of nu:', nu
         TPIiter += 1
         logging.info(f"Iteration: {TPIiter}")
-        logging.info(f"\tDistance: {TPIdist}")
+        logging.info(f"Distance: {TPIdist}")
 
     # Compute effective and marginal tax rates for all agents
     num_params = len(p.mtrx_params[0][0])

run_examples/multi_industry_example.py examples/multi_industry_example.pyrun_examples/multi_industry_example.py renamed to examples/multi_industry_example.py

@@ -20,4 +20,4 @@
 from ogcore.txfunc import *
 from ogcore.utils import *
 
-__version__ = "0.14.7"
+__version__ = "0.14.8"