Write docstring in each function in TimeSeriesRecall.
Format:
"""Description
Args:
args1: type
Description
args2: type
Description
Returns:
type: Description
"""
Goal
Write docstrings of TimeSeriesRecall
Todo
Write docstring of
[ ] TimeSeriesPrecision class
[ ] init
[ ] score
[ ] _update_recall
Deadline
2020 / 12 / 30
Parent issue
If the parent issue exists, post a link here.
References
If there are any reference links, they are described here.
Notes
Example:
"""The function of selecting the gamma value according to the parameters.
Args:
gamma: str
- 'one': the value 1
- 'reciprocal';: a reciprocal of the overlap
- 'udf_gamma': user defined gamma
overlap: int
overlap between real and pred
Returns:
float: the selected gamma
"""
Summary
Write docstring in each function in TimeSeriesRecall.
Format:
Goal
Write docstrings of TimeSeriesRecall
Todo
Write docstring of
Deadline
2020 / 12 / 30
Parent issue
If the parent issue exists, post a link here.
References
If there are any reference links, they are described here.
Notes
Example: