-
Notifications
You must be signed in to change notification settings - Fork 2
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add document #61
Add document #61
Conversation
appletree/likelihood.py
Outdated
- bins_type: either meshgrid or equiprob | ||
- bins_on: observables where we will perform inference on, usually [cs1, cs2] | ||
- x_clip, y_clip: ROI of the fitting, should be list of upper and lower boundary | ||
- data_file_name: the data used in fitting, usually calibration data |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
[pep8] reported by reviewdog 🐶
RST301 Unexpected indentation.
raise NotImplementedError | ||
|
||
def implement_binning(self, mc, eff): | ||
"""Apply binning to MC data.""" | ||
"""Apply binning to MC data. | ||
:param mc: data from simulation. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
[pep8] reported by reviewdog 🐶
WPS221 Found line with high Jones Complexity: 15 > 14
"""Apply binning to MC data.""" | ||
"""Apply binning to MC data. | ||
:param mc: data from simulation. | ||
:param eff: efficiency of each event, as the weight when making a histogram. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
[pep8] reported by reviewdog 🐶
WPS221 Found line with high Jones Complexity: 15 > 14
"""Apply binning to MC data. | ||
:param mc: data from simulation. | ||
:param eff: efficiency of each event, as the weight when making a histogram. | ||
""" |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
[pep8] reported by reviewdog 🐶
WPS518 Found implicit enumerate()
call
appletree/plugin.py
Outdated
"""Simulate.""" | ||
"""The main simulation function. | ||
|
||
:param key: a jnp.array with length 2, used to generate random variables. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
[pep8] reported by reviewdog 🐶
W291 trailing whitespace
Pull Request Test Coverage Report for Build 3362305951
💛 - Coveralls |
.readthedocs.yml
Outdated
|
||
formats: | ||
- htmlzip | ||
- epub |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@xzh19980906 It seems that some files lost their last line. : )
In this PR, some docstrings are modified, and a folder containing scripts to generate documents is added.
Try to solve: #42