... {
... "feature_1": {"value": "value_1"},
... "feature_2": {
- ... "min_value": "2020-01-01", keep_nulls: False,
+ ... "min_value": "2020-01-01", "keep_nulls": False,
... },
... "feature_3": {"year": ["2000", "2010", "2020"]},
... },
@@ -288,8 +288,22 @@ Source code for cyclops.data.slicer
>>> for slice_name, slice_func in slice_spec.slices():
... print(slice_name)
... # do something with slice_func here (e.g. dataset.filter(slice_func))
-
- """
+ feature_1:non_null
+ feature_2:non_null&feature_3:non_null
+ feature_1:value_1
+ feature_1:value_1, value_2
+ !(feature_1:value_1)
+ feature_1:[2020-01-01 - 2020-12-31]
+ feature_1:(5 - 60)
+ feature_1:year=[2020, 2021, 2022]
+ feature_1:month=[6, 7, 8]
+ feature_1:month=6, day=1
+ feature_1:contains value_1
+ feature_1:contains ['value_1', 'value_2']
+ feature_1:value_1&feature_2:[2020-01-01 - inf]&feature_3:year=['2000', '2010', '2020']
+ overall
+
+ """ # noqa: W505
spec_list: List[Dict[str, Dict[str, Any]]] = field(
default_factory=lambda: [{}],
diff --git a/api/_modules/cyclops/monitor/clinical_applicator.html b/api/_modules/cyclops/monitor/clinical_applicator.html
index ad7626d38..639a04385 100644
--- a/api/_modules/cyclops/monitor/clinical_applicator.html
+++ b/api/_modules/cyclops/monitor/clinical_applicator.html
@@ -186,16 +186,16 @@ Source code for cyclops.monitor.clinical_applicator
The source and target datasets are then generated by splitting
the original dataset along the categorical feature.
-
Examples
-
--------
-
>>> from cyclops.monitor.clinical_applicator import ClinicalShiftApplicator
-
>>> from cyclops.data.utils import load_nih
-
>>> ds = load_nih(path="/mnt/data/nihcxr")
-
>>> applicator = ClinicalShiftApplicator("hospital_type",
-
source = ["hospital_type_1", "hospital_type_2"]
-
target = ["hospital_type_3", "hospital_type_4", "hospital_type_5"]
-
)
-
>>> ds_source, ds_target = applicator.apply_shift(ds)
+
# Examples
+
# --------
+
# >>> from cyclops.monitor.clinical_applicator import ClinicalShiftApplicator
+
# >>> from cyclops.data.loader import load_nihcxr
+
# >>> ds = load_nihcxr(path="/mnt/data/nihcxr")
+
# >>> applicator = ClinicalShiftApplicator("hospital_type",
+
# source = ["hospital_type_1", "hospital_type_2"]
+
# target = ["hospital_type_3", "hospital_type_4", "hospital_type_5"]
+
# )
+
# >>> ds_source, ds_target = applicator.apply_shift(ds)
Parameters
diff --git a/api/_modules/cyclops/monitor/synthetic_applicator.html b/api/_modules/cyclops/monitor/synthetic_applicator.html
index 8d3423294..da6e0859e 100644
--- a/api/_modules/cyclops/monitor/synthetic_applicator.html
+++ b/api/_modules/cyclops/monitor/synthetic_applicator.html
@@ -183,14 +183,14 @@
Source code for cyclops.monitor.synthetic_applicator
class
SyntheticShiftApplicator:
"""The SyntheticShiftApplicator class is used induce synthetic dataset shift.
-
Examples
-
--------
-
>>> from drift_detection.experimenter import Experimenter
-
>>> from sklearn.datasets import load_diabetes
-
>>> X, y = load_diabetes(return_X_y=True)
-
>>> X_tr, X_te, y_tr, y_te = train_test_split(X, y, test_size=0.5, random_state=42)
-
>>> applicator = SyntheticShiftApplicator(shift_type="gn_shift")
-
>>> X_shift = applicator.apply_shift(X_train, noise_amt=0.1, delta=0.1)
+
# Examples
+
# --------
+
# >>> from sklearn.datasets import load_diabetes
+
# >>> X, y = load_diabetes(return_X_y=True)
+
# >>> dataset = Dataset.from_dict({"X": X, "y": y})
+
# >>> dataset = dataset.train_test_split(test_size=0.5, seed=42)
+
# >>> applicator = SyntheticShiftApplicator(shift_type="gn_shift")
+
# >>> X_shift = applicator.apply_shift(dataset["test"])
Parameters
----------
diff --git a/api/_modules/cyclops/report/report.html b/api/_modules/cyclops/report/report.html
index 47801cf5b..37eca4301 100644
--- a/api/_modules/cyclops/report/report.html
+++ b/api/_modules/cyclops/report/report.html
@@ -379,7 +379,7 @@
Source code for cyclops.report.report
Examples
--------
- >>> from cylops.report import ModelCardReport
+ >>> from cyclops.report import ModelCardReport
>>> report = ModelCardReport()
>>> report.log_descriptor(
... name="tradeoff",
diff --git a/api/reference/api/_autosummary/cyclops.data.slicer.SliceSpec.html b/api/reference/api/_autosummary/cyclops.data.slicer.SliceSpec.html
index 591e911a0..2a84495b9 100644
--- a/api/reference/api/_autosummary/cyclops.data.slicer.SliceSpec.html
+++ b/api/reference/api/_autosummary/cyclops.data.slicer.SliceSpec.html
@@ -337,7 +337,7 @@ cyclops.data.slicer.SliceSpec
Methods
diff --git a/api/reference/api/_autosummary/cyclops.monitor.clinical_applicator.ClinicalShiftApplicator.html b/api/reference/api/_autosummary/cyclops.monitor.clinical_applicator.ClinicalShiftApplicator.html
index 60f44a714..569686048 100644
--- a/api/reference/api/_autosummary/cyclops.monitor.clinical_applicator.ClinicalShiftApplicator.html
+++ b/api/reference/api/_autosummary/cyclops.monitor.clinical_applicator.ClinicalShiftApplicator.html
@@ -198,17 +198,16 @@
@@ -1197,7 +1197,7 @@
Prediction
-
+
