This is the pyhf 2019 into 2020 Roadmap (Issue #561).
We will follow loosely Seibert’s Heirarchy of Needs
(Stan Seibert, SciPy 2019)
As a general overview that will include:
- Improvements to docs
- Add lots of examples
- Add at least 5 well documented case studies
- Issue cleanup
- Adding core feature support
- "pyhf evolution": integration with columnar data analysis systems
- GPU support and testing
- Publications
- Submit pyhf to JOSS
- Submit pyhf to pyOpenSci
- Start pyhf paper in 2020
- Align with IRIS-HEP Analysis Systems NSF milestones
The roadmap will be executed over mostly Quarter 3 of 2019 through Quarter 1 of 2020, with some projects continuing into Quarter 2 of 2020
- 2019-Q3
- 2019-Q4
- 2020-Q1
- (2020-Q2)
- Documentation and Deployment
- Add docstrings to all functions and classes (Issues #38, #349) [2019-Q3]
- Greatly revise and expand examples (Issues #168, #202, #212, #325, #342, #349, #367) [2019-Q3 → 2019-Q4]
- Add small case studies with published sbottom likelihood from HEPData
- Move to scikit-hep GitHub organization [2019-Q3]
- Develop a release schedule/criteria [2019-Q4]
- Automate deployment with
Azure pipeline (talk with Henry Schreiner) (Issue #517)GitHub Actions (Issue #508) [2019-Q3] - Finalize logo and add it to website (Issue #453) [2019-Q3 → 2019-Q4]
- Write submission to JOSS (Issue #502) and write submission to pyOpenSci [2019-Q4 → 2020-Q2]
- Contribute to IRIS-HEP Analysis Systems Milestones "Initial roadmap for ecosystem coherency" and "Initial roadmap for high-level cyberinfrastructure components of analysis system" [2019-Q4 → 2020-Q2]
- Revision and Maintenance
- Add tests using HEPData published sbottom likelihoods (Issue #518) [2019-Q3]
- Add CI with GitHub Actions and Azure Pipelines (PR #527, Issue #517) [2019-Q3]
- Investigate rewrite of pytest fixtures to use modern pytest (Issue #370) [2019-Q3 → 2019-Q4]
- Factorize out the statistical fitting portion into
pyhf.infer
(PR #531) [2019-Q3 → 2019-Q4] - Bug squashing at large [2019-Q3 → 2020-Q2]
- Unexpected use cases (Issues #324, #325, #529)
- Computational edge cases (Issues #332, #445)
- Make sure that all backends reproduce sbottom results [2019-Q4 → 2020-Q2]
- Development
- Batch support (PR #503) [2019-Q3]
- Add ParamViewer support (PR #519) [2019-Q3]
- Add setting of NPs constant/fixed (PR #653) [2019-Q3]
- Implement pdf as subclass of distributions (PR #551) [2019-Q3]
- Add sampling with toys (PR #558) [2019-Q3]
- Make general modeling choices (e.g., Issue #293) [2019-Q4 → 2020-Q1]
- Add "discovery" test stats (p0) (PR #520) [2019-Q4 → 2020-Q1]
- Add better Model creation [2019-Q4 → 2020-Q1]
- Add background model support (Issue #514) [2019-Q4 → 2020-Q1]
- Develop interface for the optimizers similar to tensor/backend [2019-Q4 → 2020-Q1]
- Migrate to TensorFlow v2.0 (PR #541) [2019-Q4]
- Drop Python 2.7 support at end of 2019 (Issue #469) [2019-Q4 (last week of December 2019)]
- Finalize public API [2020-Q1]
- Integrate pyfitcore/Statisfactory API [2020-Q1]
- Research
- Add pyfitcore/Statisfactory integrations (Issue #344, zfit Issue 120) [2019-Q4]
- Hardware acceleration scaling studies (Issues #93, #301) [2019-Q4 → 2020-Q1]
- Speedup through Numba (Issue #364) [2019-Q3 → 2019-Q4]
- Dask backend (Issue #259) [2019-Q3 → 2020-Q1]
- Attempt to use pyhf as fitting tool for full Analysis Systems pipeline test in early 2020 [2019-Q4 → 2020-Q1]
- pyhf should satisfy IRIS-HEP Analysis Systems Milestone "GPU/accelerator-based implementation of statistical and other appropriate components" [2020-Q1 → 2020-Q2] and contributes to "Benchmarking and assessment of prototype analysis system components" [2020-Q3 → 2020-Q4]
- Talk at IRIS-HEP Institute Retreat (September 12-13th, 2019)
- Talk at PyHEP 2019 (October 16-18th, 2019)
- Talk at CHEP 2019 (November 4-8th, 2019)
- Poster at CHEP 2019 (November 4-8th, 2019)