popsim-consortium / popsim-consortium/stdpopsim

helpful error messages for Model QC

Open
#552 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement Model QC
Dominant language
Python
Stars
144
Forks
100
Avg merge
2h 44m
Merged PRs (30d)
2

Description

Short description of what you'd like added:
As discussed in https://github.com/popsim-consortium/stdpopsim/issues/550, let's change so that if models are not equal it also returns the more specific errors from the verify_equal call.
@ndukler might need to give more detail here.

Rationale and considerations:
Make it easier for model QC'ers to spot and fix differences in model implementation.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reading the discussion in issue #550 and locating the model QC path that makes the verify_equal call. Determine how unequal models currently report errors and what additional details the QC workflow needs; done means specific differences are returned when model equality fails.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
testing-qa
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.