relaxed

Provides differentiable versions of common HEP operations and objectives.

Science Score: 72.0%

This score indicates how likely this project is to be science-related based on various indicators:

✓
CITATION.cff file
Found CITATION.cff file
✓
codemeta.json file
Found codemeta.json file
✓
.zenodo.json file
Found .zenodo.json file
○
DOI references
✓
Academic publication links
Links to: zenodo.org
✓
Committers with academic emails
3 of 11 committers (27.3%) from academic institutions
✓
Institutional organization owner
Organization gradhep has institutional domain (mattermost.web.cern.ch)
○
JOSS paper metadata
○
Scientific vocabulary similarity
Low similarity (13.9%) to scientific vocabulary

Keywords

jax python

Keywords from Contributors

scikit-hep asymptotic-formulas closember cls frequentist-statistics hep hep-ex high-energy-physics histfactory statistical-inference

Last synced: 6 months ago · JSON representation ·

Repository

Provides differentiable versions of common HEP operations and objectives.

Basic Info

Host: GitHub
Owner: gradhep
License: bsd-3-clause
Language: Python
Default Branch: main
Homepage:
Size: 5.19 MB

Statistics

Stars: 25
Watchers: 4
Forks: 7
Open Issues: 7
Releases: 11

Topics

jax python

Created almost 6 years ago · Last pushed over 2 years ago

Metadata Files

Readme Contributing License Citation

README.md

Provides differentiable ("relaxed") versions of common operations in high-energy physics.

Based on jax. Where possible, function APIs try to mimic their commonly used counterparts, e.g. fitting and hypothesis testing in pyhf.

Currently implemented:

basic operations:
- relaxed.hist: histograms via kernel density estimation (tunable bandwidth).
- relaxed.cut: approximates a hard cut with a sigmoid function (tunable slope).
fitting routines:
- relaxed.mle.fit: global MLE fit.
- relaxed.mle.fixed_poi_fit: constrained fit given a value of a parameter of interest.
inference:
- relaxed.infer.hypotest: hypothesis test based on the profile likelihood. Supports test statistics for both limit setting (q) and discovery (q_0).
- relaxed.fisher_info: the fisher information matrix (of a pyhf-type model).
- relaxed.cramer_rao_uncert: inverts the fisher information matrix to provide uncertainties valid through the Cramér-Rao bound.
metrics:
- relaxed.metrics.gaussianity: an experimental metric that quantifies the mean-squared difference of a likelihood function with respect to its gaussian approximation (covariance calculated using the Cramér-Rao bound above).
- relaxed.metrics.asimov_sig: easy access to the (single- and multi-bin) stat-only expected significance.

We're maintaining a list of desired differentiable operations in list_of_operations.md (thanks to @cranmer) -- feel free to take inspiration or contribute with a PR if there's one you can handle :)

Install

In your virtual environment:

python3 -m pip install relaxed

Examples

<- Click here to start playing with our examples straight away (thanks to Binder)!

If you'd rather run the example notebooks locally from examples/, you can clone the repository, then:

python3 -m venv venv # or virtualenv source venv/bin/activate pip install --upgrade pip setuptools wheel pip install relaxed cd examples pip install -r requirements.txt

Then launch jupyter through your preferred medium (vscode, jupyterlab, etc.), making sure to use this virtual env as your kernel (e.g. you can pip install and run jupyter lab in this env).

Sharp bits

For serious use with pyhf, e.g. in a neos-type workflow, it is temporarily recommended to install pyhf using a specific branch that is designed to be differentiable with respect to model construction:

python3 -m pip install git+http://github.com/scikit-hep/pyhf.git@make_difffable_model_ctor

We plan to merge this into pyhf when it's stable, and will then drop this instruction :)

Cite

If you use relaxed, please cite us! You should be able to do that from the github UI (top-right, under 'cite this repository'), but if not, see our Zenodo DOI or our CITATION.cff.

Acknowledgments

Big thanks to all the developers of the main packages we use (jax, pyhf, jaxopt). Thanks also to @dfm for the README header inspiration ;)

Owner

Name: gradHEP
Login: gradhep
Kind: organization

Website: https://mattermost.web.cern.ch/signup_user_complete/?id=zf7w5rb1miy85xsfjqm68q9hwr
Repositories: 5
Profile: https://github.com/gradhep

Applying differentiable programming to high-energy physics. Join our mattermost chat with the link below, where we discuss + have irregular meetings!

Citation (CITATION.cff)

cff-version: 1.2.0
message: "Thanks for being interested in relaxed! If you use this software in a project, please cite it as below."
authors:
  - family-names: Simpson
    given-names: Nathan
    orcid: https://orcid.org/0000-0003-4188-8299
title: "relaxed: version 0.3.0"
version: v0.3.0
date-released: 2023-07-05
url: "https://github.com/gradhep/relaxed"
doi: 10.5281/zenodo.6330891

GitHub Events

Total

Issues event: 1
Watch event: 1
Fork event: 2

Last Year

Issues event: 1
Watch event: 1
Fork event: 2

Committers

Last synced: almost 3 years ago

All Time

Total Commits: 256
Total Committers: 11
Avg Commits per committer: 23.273
Development Distribution Score (DDS): 0.641

Top Committers

Name	Email	Commits
Nathan Simpson	e**n@g**m	92
Nathan Simpson	n**n@h**e	58
Nathan Simpson	p**e@p**m	50
pre-commit-ci[bot]	6**]@u**m	19
Nathan Simpson	p**e@N**l	13
Matthew Feickert	m**t@c**h	7
Kyle Cranmer	k**r@n**u	7
dependabot[bot]	4**]@u**m	6
Lukas Heinrich	l**h@L**e	2
Angus Hollands	g**5@g**m	1
Ruggero Turra	g**o@g**m	1

Committer Domains (Top 20 + Academic)

lukass-mbp.ipp.mpg.de: 1 nyu.edu: 1 cern.ch: 1 hep.lu.se: 1

Issues and Pull Requests

Last synced: 6 months ago

All Time

Total issues: 8
Total pull requests: 55
Average time to close issues: 6 months
Average time to close pull requests: 16 days
Total issue authors: 5
Total pull request authors: 7
Average comments per issue: 1.0
Average comments per pull request: 0.76
Merged pull requests: 43
Bot issues: 0
Bot pull requests: 31

Past Year

Issues: 1
Pull requests: 0
Average time to close issues: N/A
Average time to close pull requests: N/A
Issue authors: 1
Pull request authors: 0
Average comments per issue: 0.0
Average comments per pull request: 0
Merged pull requests: 0
Bot issues: 0
Bot pull requests: 0

View more stats

Top Authors

Issue Authors

cranmer (2)
matthewfeickert (2)
phinate (2)
joschkabirk (1)
ligerlac (1)

Pull Request Authors

phinate (17)
pre-commit-ci[bot] (16)
dependabot[bot] (15)
cranmer (2)
agoose77 (2)
matthewfeickert (2)
wiso (1)

Top Labels

Issue Labels

bug (1)

Pull Request Labels

dependencies (15) enhancement (1)

Packages

Total packages: 1
Total downloads:
- pypi 43 last-month

Total dependent packages: 0
Total dependent repositories: 5
Total versions: 15
Total maintainers: 1

pypi.org: relaxed

Differentiable versions of common HEP operations.

Homepage: https://github.com/gradhep/relaxed
Documentation: https://relaxed.readthedocs.io/
License: BSD License
Latest release: 0.4.0
published over 2 years ago

Versions: 15
Dependent Packages: 0
Dependent Repositories: 5
Downloads: 43 Last month

Rankings

Dependent repos count: 6.7%

Dependent packages count: 10.0%

Average: 13.3%

Stargazers count: 13.3%

Forks count: 15.3%

Downloads: 21.3%

Maintainers (1)

phinate

Last synced: 6 months ago

Dependencies

examples/requirements.txt pypi

celluloid *
plothelp *

.github/workflows/ci.yml actions

actions/checkout v3 composite
actions/setup-python v3 composite
actions/upload-artifact v3 composite
codecov/codecov-action v3.1.1 composite
pre-commit/action v3.0.0 composite
pypa/gh-action-pypi-publish v1.5.1 composite

pyproject.toml pypi

equinox >=0.10.6
jaxopt >=0.7
typing_extensions >=4.6; python_version<'3.11'