Create Catalog of PGM Level Models

[Polichinel]

Objective

Create a comprehensive catalog of all PRIO Grid Month (PGM) models that need to be implemented for the minimally viable product (MVP).

This should be analog the the Country Month (CM) Models catalog already in Documantion.

Requirements:

• Catalog Content: The catalog must include the following details for each PGM-level model:

  • Algorithm: Specify the algorithm used by each model.
  • Input Features: List the feature sets required for each model.
  • Model Definition: Ensure that the model definition aligns with the specifications in ADR 005_model_definition_and_structure.md.
  • Implementation Status: Indicate whether each model has been implemented or is currently missing.
    (For more, see the CM model implementation)

• File Format:

  • Create the catalog in a markdown file named pgm_model_catalog.md.
  • Structure the catalog as a table for clarity, following the format laid out in the country month (CM) catalog.
  • Store the file in the following directory:

    views_pipeline/documentation/catalogs/pgm_model_catalog.md
    

• Branch:

  • Create a new branch named create_pgm_catalog_01 to work on this task.

• Information Sources:

  • Use the relevant ADRs, particularly ADR 005_model_definition_and_structure.md, as a reference.
  • Use the CM model catalog implementation (documentation/catalogs/cm_model_catalog.md) as reference
  • Review the old "pipeline" notebook to compile the list of PGM-level models.

• Review Process:

  • Upon completion, submit the catalog for review and feedback. A human-in-the-loop check will suffice to ensure alignment with the ADR.

Additional Actions:

• Glossary & ADRs:

  • Follow the existing templates for ADRs and glossary entries.
  • Document and create any necessary ADRs or glossary entries that emerge during the process.

• Issues:

  • If any issues arise or further definitions are needed, document them as new GitHub issues.

Example of Table (Draft - see cm implementation for the example to follow)

Model Name	Algorithm	Input Features	Implementation Status	Notes
NA	Random Forest	...	Not Implemented
mystery_model	XGBoost	...	Implemented

---

Summary of Actionable Steps:

• Create a new branch named create_pgm_catalog_01.
• Compile the model catalog with all required details: algorithm, input features, and implementation status.
• Format the catalog as a markdown table in pgm_model_catalog.md, and store it in views_pipeline/documentation/catalogs/.
• Review relevant ADRs and current documentation to ensure all models are accounted for.
• Submit the catalog for review.
• Note and create ADRs or glossary entries following existing templates.
• Log any issues encountered as GitHub issues.