/ src / evidently / presets / __init__.py
__init__.py
 1  """Pre-configured metric collections for common evaluation scenarios.
 2  
 3  Presets combine multiple related `Metric` objects into convenient templates
 4  for specific evaluation tasks. They provide a quick way to run comprehensive
 5  evaluations without manually selecting individual metrics.
 6  
 7  Available presets:
 8  - `DataSummaryPreset`: Overview statistics for all columns
 9  - `DataDriftPreset`: Detect distribution shifts across columns
10  - `ClassificationPreset`: Comprehensive classification quality metrics
11  - `RegressionPreset`: Comprehensive regression quality metrics
12  - `TextEvals`: Summarize text descriptor results
13  - `RecsysPreset`: Ranking and recommendation metrics
14  
15  **Documentation**: See [All Presets](https://docs.evidentlyai.com/metrics/all_presets) for a complete reference.
16  
17  Example:
18  ```python
19  from evidently import Report
20  from evidently.presets import DataSummaryPreset
21  
22  report = Report([DataSummaryPreset()])
23  snapshot = report.run(dataset, None)
24  ```
25  """
26  
27  from .classification import ClassificationDummyQuality
28  from .classification import ClassificationPreset
29  from .classification import ClassificationQuality
30  from .classification import ClassificationQualityByLabel
31  from .dataset_stats import DatasetStats
32  from .dataset_stats import DataSummaryPreset
33  from .dataset_stats import TextEvals
34  from .dataset_stats import ValueStats
35  from .drift import DataDriftPreset
36  from .recsys import RecsysPreset
37  from .regression import RegressionDummyQuality
38  from .regression import RegressionPreset
39  from .regression import RegressionQuality
40  
41  __all__ = [
42      "ClassificationDummyQuality",
43      "ClassificationPreset",
44      "ClassificationQuality",
45      "ClassificationQualityByLabel",
46      "ValueStats",
47      "TextEvals",
48      "DatasetStats",
49      "DataSummaryPreset",
50      "RegressionDummyQuality",
51      "RegressionQuality",
52      "RegressionPreset",
53      "DataDriftPreset",
54      "RecsysPreset",
55  ]