README.md

GGCM Model Performance Scorecard

Travis-CI Build Status codecov

Provides a package of functions to update and produce a monthly model performance scorecard. The package is meant for automated production, however it can be run manually:

  1. Edit a scorecard configuration file to account for activated and candidate models.
  2. Ensure model configuration files for any model mentioned in the scorecard configuration are avavailable and provide current statistics. References to model update functions must be built-into the package.
  3. Export account transactions from Bivio.
  4. Run scorecard-precheck passing the scorecard file. Confirm that a valid response is returned, indicating the structure and expected content of both the scorecard and the model configurations it points to have been found by the check.
  5. Run scorecard-update passing the scorecard file, output directory and exported transactions file. This will create an output workspace archive in the output directory.
  6. Run scorecard-produce passing the output directory, or the particular file name of a workspace archive. This will write output to the output directory.


greatgray/scorecard documentation built on May 17, 2019, 8:34 a.m.