Skip to content

memory and runtime benchmark/testing infrastructure #8858

@stscijgbot-jp

Description

@stscijgbot-jp

Issue JP-3775 was created on JIRA by Ned Molter:

Add and implement tools to ensure that pull requests do not inadvertently cause significant regressions in memory usage or runtime.

At a hack day discussion, we targeted initial implementation and testing in stcal, since it's a smaller repository but still has non-trivial memory- and runtime-hungry functions (e.g., outlier detection median calculation).  Goal is very quick adoption by JWST, and adoption by Roman once other outstanding regression test issues have been resolved.

The preferred workflow would be to have decorators that could be added to tests to flag them as memory- and/or runtime-checked.  At time of writing, codspeed is being considered for runtime, and pytest-memray is being considered for memory.  

Task list for now:

  • Add memory usage unit tests for methods where memory optimization has been attempted, e.g. the median calculator in outlier detection.
  • Test out codspeed by starting to use it in stcal
  • Figure out a good general way to report memory usage on PR branches
  • Decide whether memory usage regression tests are needed, or if benchmarking and showing the results to PR developers is good enough

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions