foldaudit 0.2.5__py3-none-any.whl
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- foldaudit/__init__.py +23 -0
- foldaudit/core.py +1036 -0
- foldaudit/py.typed +0 -0
- foldaudit/report.py +249 -0
- foldaudit-0.2.5.dist-info/METADATA +437 -0
- foldaudit-0.2.5.dist-info/RECORD +9 -0
- foldaudit-0.2.5.dist-info/WHEEL +5 -0
- foldaudit-0.2.5.dist-info/licenses/LICENSE +21 -0
- foldaudit-0.2.5.dist-info/top_level.txt +1 -0
foldaudit/__init__.py
ADDED
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
"""foldaudit: check that cross-validation folds are fair and usable
|
|
2
|
+
before you trust the score.
|
|
3
|
+
|
|
4
|
+
The public API is intentionally small:
|
|
5
|
+
|
|
6
|
+
from foldaudit import audit
|
|
7
|
+
|
|
8
|
+
report = audit(cv, X, y, groups=groups, time=dates)
|
|
9
|
+
print(report.text)
|
|
10
|
+
print(report.to_json())
|
|
11
|
+
|
|
12
|
+
``audit`` accepts either a splitter object with a ``.split()`` method
|
|
13
|
+
(like scikit-learn's KFold, StratifiedKFold, GroupKFold or
|
|
14
|
+
TimeSeriesSplit) or a plain list of ``(train_idx, test_idx)`` pairs,
|
|
15
|
+
so it does not depend on scikit-learn at all. It trains no model,
|
|
16
|
+
makes no plots, and needs no GPU or paid API.
|
|
17
|
+
"""
|
|
18
|
+
|
|
19
|
+
from .core import Thresholds, audit
|
|
20
|
+
from .report import Flag, FoldResult, Report
|
|
21
|
+
|
|
22
|
+
__all__ = ["Flag", "FoldResult", "Report", "Thresholds", "audit"]
|
|
23
|
+
__version__ = "0.2.5"
|