0.0.7

What's changed

Full Changelog: 0.0.6...0.0.7

New features

• Add support for save_tree_error train argument to preserve record_evals by @jeancochrane in #10

  • Summary: train_lightgbm() now supports an optional boolean parameter save_tree_error, which allows the caller to specify that the model should use its training data as a validation set in order to save a record_evals attribute that records the error for each tree in the model. This option supports the experimental comps algorithm described in the vignette Finding comparables with LightGBM.

• Add MSE + covariance penalty term custom objective function by @wagnerlmichael in #21

  • Summary: train_lightgbm() now supports an optional objective = "mse_cov" parameter value and an optional mse_cov_rho parameter to enable a new objective function that takes mean squared error and adds an additional penalty on the squared covariance between prediction residuals and centered sale prices. This method is based on forthcoming research by @nicacevedo and Haihao Lu at MIT that aims to reduce regressivity in mass appraisal. See their code at nicacevedo/soft-vertical-equity-constrained-mass-appraissal for details.
    • New parameter values:
      • objective = "mse_cov": Enables the new objective function
    • New parameters:
      • mse_cov_rho (optional integer): Rho value for the covariance penalty term; controls how much to penalize covariance between prediction residuals and centered sale prices

Bug fixes

• Update lgbm_load() to only load record_evals if they exist by @jeancochrane in #13

Documentation

• Create a vignette outlining how to extract comparables from LightGBM by @dfsnow in #3
• Update comps vignette copy and tables by @dfsnow in #6
• Update comps vignette with latest version of the similarity scoring algorithm by @jeancochrane in #19
• Enable llms.txt for docs by @Damonamajor in #24

Maintenance

• Add CODEOWNERS file by @dfsnow in #2
• Add @ccao-jardine as an author/contributor by @dfsnow in #5
• Add citation file by @Damonamajor in #8
• Refactor pre-commit workflow using composite action by @wagnerlmichael in #12
• Fix file permissions error in style-files pre-commit hook by @jeancochrane in #14
• Fix CI builds by @jeancochrane in #17
• Swap Dan for Billy + Jean in CODEOWNERS by @jeancochrane in #18

Dependencies

• Bump LightGBM version to 4.2.0 by @dfsnow in #9
• Upgrade to testthat 3rd edition by @Damonamajor in #22
• Upgrade all third-party actions and pin them to immutable releases by @jeancochrane in #23
• Upgrade pre-commit hooks by @jeancochrane in #26

New Contributors

• @Damonamajor made his first contribution in #8
• @jeancochrane made her first contribution in #10
• @wagnerlmichael made his first contribution in #12

Special thanks to @nicacevedo and Haihao Lu for developing the covariance penalty objective function added in #21.

0.0.6

• Update supporting files for transition to GitHub