LogoLogo
HomeBlogGitHub
latest
latest
  • New DOCS
  • What is Evidently?
  • Get Started
    • Evidently Cloud
      • Quickstart - LLM tracing
      • Quickstart - LLM evaluations
      • Quickstart - Data and ML checks
      • Quickstart - No-code evaluations
    • Evidently OSS
      • OSS Quickstart - LLM evals
      • OSS Quickstart - Data and ML monitoring
  • Presets
    • All Presets
    • Data Drift
    • Data Quality
    • Target Drift
    • Regression Performance
    • Classification Performance
    • NoTargetPerformance
    • Text Evals
    • Recommender System
  • Tutorials and Examples
    • All Tutorials
    • Tutorial - Tracing
    • Tutorial - Reports and Tests
    • Tutorial - Data & ML Monitoring
    • Tutorial - LLM Evaluation
    • Self-host ML Monitoring
    • LLM as a judge
    • LLM Regression Testing
  • Setup
    • Installation
    • Evidently Cloud
    • Self-hosting
  • User Guide
    • 📂Projects
      • Projects overview
      • Manage Projects
    • 📶Tracing
      • Tracing overview
      • Set up tracing
    • 🔢Input data
      • Input data overview
      • Column mapping
      • Data for Classification
      • Data for Recommendations
      • Load data to pandas
    • 🚦Tests and Reports
      • Reports and Tests Overview
      • Get a Report
      • Run a Test Suite
      • Evaluate Text Data
      • Output formats
      • Generate multiple Tests or Metrics
      • Run Evidently on Spark
    • 📊Evaluations
      • Evaluations overview
      • Generate snapshots
      • Run no code evals
    • 🔎Monitoring
      • Monitoring overview
      • Batch monitoring
      • Collector service
      • Scheduled evaluations
      • Send alerts
    • 📈Dashboard
      • Dashboard overview
      • Pre-built Tabs
      • Panel types
      • Adding Panels
    • 📚Datasets
      • Datasets overview
      • Work with Datasets
    • 🛠️Customization
      • Data drift parameters
      • Embeddings drift parameters
      • Feature importance in data drift
      • Text evals with LLM-as-judge
      • Text evals with HuggingFace
      • Add a custom text descriptor
      • Add a custom drift method
      • Add a custom Metric or Test
      • Customize JSON output
      • Show raw data in Reports
      • Add text comments to Reports
      • Change color schema
    • How-to guides
  • Reference
    • All tests
    • All metrics
      • Ranking metrics
    • Data drift algorithm
    • API Reference
      • evidently.calculations
        • evidently.calculations.stattests
      • evidently.metrics
        • evidently.metrics.classification_performance
        • evidently.metrics.data_drift
        • evidently.metrics.data_integrity
        • evidently.metrics.data_quality
        • evidently.metrics.regression_performance
      • evidently.metric_preset
      • evidently.options
      • evidently.pipeline
      • evidently.renderers
      • evidently.report
      • evidently.suite
      • evidently.test_preset
      • evidently.test_suite
      • evidently.tests
      • evidently.utils
  • Integrations
    • Integrations
      • Evidently integrations
      • Notebook environments
      • Evidently and Airflow
      • Evidently and MLflow
      • Evidently and DVCLive
      • Evidently and Metaflow
  • SUPPORT
    • Migration
    • Contact
    • F.A.Q.
    • Telemetry
    • Changelog
  • GitHub Page
  • Website
Powered by GitBook
On this page
  • Subpackages
  • Submodules
  • base_metric module
  • class ErrorResult(exception: BaseException)
  • class InputData(reference_data: Optional[pandas.core.frame.DataFrame], current_data: pandas.core.frame.DataFrame, column_mapping: ColumnMapping, data_definition: DataDefinition)
  • class Metric()
  • generate_column_metrics(metric_class: Type[Metric], columns: Optional[Union[str, list]] = None, parameters: Optional[Dict] = None, skip_id_column: bool = False)
  • utils module
  • apply_func_to_binned_data(df_for_bins, func, target_column, preds_column, is_ref_data=False)
  • make_target_bins_for_reg_plots(curr: DataFrame, target_column, preds_column, ref: Optional[DataFrame] = None)
  1. Reference
  2. API Reference

evidently.metrics

Previousevidently.calculations.stattestsNextevidently.metrics.classification_performance

Last updated 2 months ago

Available metrics for Reports and Tests. All metrics is grouped into modules. For specific group see module documentation.

Subpackages

Submodules

base_metric module

class ErrorResult(exception: BaseException)

Bases: object

Attributes:

exception : BaseException

Bases: object

Attributes:

current_data : DataFrame

reference_data : Optional[DataFrame]

class Metric()

Bases: Generic[TResult]

Attributes:

context = None

Methods:

abstract calculate(data: InputData)

get_id()

get_parameters()

get_result()

set_context(context)

generate_column_metrics(metric_class: Type[Metric], columns: Optional[Union[str, list]] = None, parameters: Optional[Dict] = None, skip_id_column: bool = False)

Function for generating metrics for columns

utils module

apply_func_to_binned_data(df_for_bins, func, target_column, preds_column, is_ref_data=False)

make_target_bins_for_reg_plots(curr: DataFrame, target_column, preds_column, ref: Optional[DataFrame] = None)

class InputData(reference_data: Optional[pandas.core.frame.DataFrame], current_data: pandas.core.frame.DataFrame, column_mapping: , data_definition: )

column_mapping :

data_definition :

evidently.metrics.classification_performance package
evidently.metrics.data_drift package
evidently.metrics.data_integrity package
evidently.metrics.data_quality package
evidently.metrics.regression_performance package
ColumnMapping
ColumnMapping
Submodules
column_drift_metric module
ColumnDriftMetric
ColumnDriftMetric.calculate()
ColumnDriftMetric.column_name
ColumnDriftMetric.get_parameters()
ColumnDriftMetric.stattest
ColumnDriftMetric.stattest_threshold
ColumnDriftMetricRenderer
ColumnDriftMetricRenderer.color_options
ColumnDriftMetricRenderer.render_html()
ColumnDriftMetricRenderer.render_json()
ColumnDriftMetricResults
ColumnDriftMetricResults.column_name
ColumnDriftMetricResults.column_type
ColumnDriftMetricResults.current_distribution
ColumnDriftMetricResults.current_scatter
ColumnDriftMetricResults.drift_detected
ColumnDriftMetricResults.drift_score
ColumnDriftMetricResults.plot_shape
ColumnDriftMetricResults.reference_distribution
ColumnDriftMetricResults.stattest_name
ColumnDriftMetricResults.stattest_threshold
ColumnDriftMetricResults.x_name
column_value_plot module
ColumnValuePlot
ColumnValuePlot.calculate()
ColumnValuePlot.column_name
ColumnValuePlotRenderer
ColumnValuePlotRenderer.color_options
ColumnValuePlotRenderer.render_html()
ColumnValuePlotRenderer.render_json()
ColumnValuePlotResults
ColumnValuePlotResults.column_name
ColumnValuePlotResults.current_scatter
ColumnValuePlotResults.datetime_column_name
ColumnValuePlotResults.reference_scatter
data_drift_table module
DataDriftTable
DataDriftTable.calculate()
DataDriftTable.columns
DataDriftTable.get_parameters()
DataDriftTable.options
DataDriftTableRenderer
DataDriftTableRenderer.color_options
DataDriftTableRenderer.render_html()
DataDriftTableRenderer.render_json()
DataDriftTableResults
DataDriftTableResults.dataset_columns
DataDriftTableResults.dataset_drift
DataDriftTableResults.drift_by_columns
DataDriftTableResults.number_of_columns
DataDriftTableResults.number_of_drifted_columns
DataDriftTableResults.share_of_drifted_columns
dataset_drift_metric module
DataDriftMetricsRenderer
DataDriftMetricsRenderer.color_options
DataDriftMetricsRenderer.render_html()
DataDriftMetricsRenderer.render_json()
DatasetDriftMetric
DatasetDriftMetric.calculate()
DatasetDriftMetric.columns
DatasetDriftMetric.drift_share
DatasetDriftMetric.get_parameters()
DatasetDriftMetric.options
DatasetDriftMetricResults
DatasetDriftMetricResults.dataset_drift
DatasetDriftMetricResults.drift_share
DatasetDriftMetricResults.number_of_columns
DatasetDriftMetricResults.number_of_drifted_columns
DatasetDriftMetricResults.share_of_drifted_columns
target_by_features_table module
TargetByFeaturesTable
TargetByFeaturesTable.calculate()
TargetByFeaturesTable.columns
TargetByFeaturesTableRenderer
TargetByFeaturesTableRenderer.color_options
TargetByFeaturesTableRenderer.render_html()
TargetByFeaturesTableRenderer.render_json()
TargetByFeaturesTableResults
TargetByFeaturesTableResults.columns
TargetByFeaturesTableResults.curr_predictions
TargetByFeaturesTableResults.current_plot_data
TargetByFeaturesTableResults.ref_predictions
TargetByFeaturesTableResults.reference_plot_data
TargetByFeaturesTableResults.target_name
TargetByFeaturesTableResults.task
Submodules
abs_perc_error_in_time module
RegressionAbsPercentageErrorPlot
RegressionAbsPercentageErrorPlot.calculate()
RegressionAbsPercentageErrorPlotRenderer
RegressionAbsPercentageErrorPlotRenderer.color_options
RegressionAbsPercentageErrorPlotRenderer.render_html()
RegressionAbsPercentageErrorPlotRenderer.render_json()
RegressionAbsPercentageErrorPlotResults
RegressionAbsPercentageErrorPlotResults.current_scatter
RegressionAbsPercentageErrorPlotResults.reference_scatter
RegressionAbsPercentageErrorPlotResults.x_name
error_bias_table module
RegressionErrorBiasTable
RegressionErrorBiasTable.TOP_ERROR_DEFAULT
RegressionErrorBiasTable.TOP_ERROR_MAX
RegressionErrorBiasTable.TOP_ERROR_MIN
RegressionErrorBiasTable.calculate()
RegressionErrorBiasTable.columns
RegressionErrorBiasTable.top_error
RegressionErrorBiasTableRenderer
RegressionErrorBiasTableRenderer.color_options
RegressionErrorBiasTableRenderer.render_html()
RegressionErrorBiasTableRenderer.render_json()
RegressionErrorBiasTableResults
RegressionErrorBiasTableResults.cat_feature_names
RegressionErrorBiasTableResults.columns
RegressionErrorBiasTableResults.current_plot_data
RegressionErrorBiasTableResults.error_bias
RegressionErrorBiasTableResults.num_feature_names
RegressionErrorBiasTableResults.prediction_name
RegressionErrorBiasTableResults.reference_plot_data
RegressionErrorBiasTableResults.target_name
RegressionErrorBiasTableResults.top_error
error_distribution module
RegressionErrorDistribution
RegressionErrorDistribution.calculate()
RegressionErrorDistributionRenderer
RegressionErrorDistributionRenderer.color_options
RegressionErrorDistributionRenderer.render_html()
RegressionErrorDistributionRenderer.render_json()
RegressionErrorDistributionResults
RegressionErrorDistributionResults.current_bins
RegressionErrorDistributionResults.reference_bins
error_in_time module
RegressionErrorPlot
RegressionErrorPlot.calculate()
RegressionErrorPlotRenderer
RegressionErrorPlotRenderer.color_options
RegressionErrorPlotRenderer.render_html()
RegressionErrorPlotRenderer.render_json()
RegressionErrorPlotResults
RegressionErrorPlotResults.current_scatter
RegressionErrorPlotResults.reference_scatter
RegressionErrorPlotResults.x_name
error_normality module
RegressionErrorNormality
RegressionErrorNormality.calculate()
RegressionErrorNormalityRenderer
RegressionErrorNormalityRenderer.color_options
RegressionErrorNormalityRenderer.render_html()
RegressionErrorNormalityRenderer.render_json()
RegressionErrorNormalityResults
RegressionErrorNormalityResults.current_error
RegressionErrorNormalityResults.reference_error
predicted_and_actual_in_time module
RegressionPredictedVsActualPlot
RegressionPredictedVsActualPlot.calculate()
RegressionPredictedVsActualPlotRenderer
RegressionPredictedVsActualPlotRenderer.color_options
RegressionPredictedVsActualPlotRenderer.render_html()
RegressionPredictedVsActualPlotRenderer.render_json()
RegressionPredictedVsActualPlotResults
RegressionPredictedVsActualPlotResults.current_scatter
RegressionPredictedVsActualPlotResults.reference_scatter
RegressionPredictedVsActualPlotResults.x_name
predicted_vs_actual module
RegressionPredictedVsActualScatter
RegressionPredictedVsActualScatter.calculate()
RegressionPredictedVsActualScatterRenderer
RegressionPredictedVsActualScatterRenderer.color_options
RegressionPredictedVsActualScatterRenderer.render_html()
RegressionPredictedVsActualScatterRenderer.render_json()
RegressionPredictedVsActualScatterResults
RegressionPredictedVsActualScatterResults.current_scatter
RegressionPredictedVsActualScatterResults.reference_scatter
regression_dummy_metric module
RegressionDummyMetric
RegressionDummyMetric.calculate()
RegressionDummyMetric.quality_metric
RegressionDummyMetricRenderer
RegressionDummyMetricRenderer.color_options
RegressionDummyMetricRenderer.render_html()
RegressionDummyMetricRenderer.render_json()
RegressionDummyMetricResults
RegressionDummyMetricResults.abs_error_max
RegressionDummyMetricResults.abs_error_max_by_ref
RegressionDummyMetricResults.abs_error_max_default
RegressionDummyMetricResults.mean_abs_error
RegressionDummyMetricResults.mean_abs_error_by_ref
RegressionDummyMetricResults.mean_abs_error_default
RegressionDummyMetricResults.mean_abs_perc_error
RegressionDummyMetricResults.mean_abs_perc_error_by_ref
RegressionDummyMetricResults.mean_abs_perc_error_default
RegressionDummyMetricResults.rmse
RegressionDummyMetricResults.rmse_by_ref
RegressionDummyMetricResults.rmse_default
regression_performance_metrics module
RegressionPerformanceMetrics
RegressionPerformanceMetrics.calculate()
RegressionPerformanceMetrics.get_parameters()
RegressionPerformanceMetricsRenderer
RegressionPerformanceMetricsRenderer.color_options
RegressionPerformanceMetricsRenderer.render_html()
RegressionPerformanceMetricsRenderer.render_json()
RegressionPerformanceMetricsResults
RegressionPerformanceMetricsResults.abs_error_max
RegressionPerformanceMetricsResults.abs_error_max_default
RegressionPerformanceMetricsResults.abs_error_max_ref
RegressionPerformanceMetricsResults.abs_error_std
RegressionPerformanceMetricsResults.abs_perc_error_std
RegressionPerformanceMetricsResults.columns
RegressionPerformanceMetricsResults.error_bias
RegressionPerformanceMetricsResults.error_normality
RegressionPerformanceMetricsResults.error_std
RegressionPerformanceMetricsResults.hist_for_plot
RegressionPerformanceMetricsResults.me_default_sigma
RegressionPerformanceMetricsResults.me_hist_for_plot
RegressionPerformanceMetricsResults.mean_abs_error
RegressionPerformanceMetricsResults.mean_abs_error_default
RegressionPerformanceMetricsResults.mean_abs_error_ref
RegressionPerformanceMetricsResults.mean_abs_perc_error
RegressionPerformanceMetricsResults.mean_abs_perc_error_default
RegressionPerformanceMetricsResults.mean_abs_perc_error_ref
RegressionPerformanceMetricsResults.mean_error
RegressionPerformanceMetricsResults.mean_error_ref
RegressionPerformanceMetricsResults.r2_score
RegressionPerformanceMetricsResults.r2_score_ref
RegressionPerformanceMetricsResults.rmse
RegressionPerformanceMetricsResults.rmse_default
RegressionPerformanceMetricsResults.rmse_ref
RegressionPerformanceMetricsResults.underperformance
RegressionPerformanceMetricsResults.underperformance_ref
RegressionPerformanceMetricsResults.vals_for_plots
regression_quality module
RegressionQualityMetric
RegressionQualityMetric.calculate()
RegressionQualityMetricRenderer
RegressionQualityMetricRenderer.color_options
RegressionQualityMetricRenderer.render_html()
RegressionQualityMetricRenderer.render_json()
RegressionQualityMetricResults
RegressionQualityMetricResults.abs_error_max
RegressionQualityMetricResults.abs_error_max_default
RegressionQualityMetricResults.abs_error_max_ref
RegressionQualityMetricResults.abs_error_std
RegressionQualityMetricResults.abs_error_std_ref
RegressionQualityMetricResults.abs_perc_error_std
RegressionQualityMetricResults.abs_perc_error_std_ref
RegressionQualityMetricResults.columns
RegressionQualityMetricResults.error_bias
RegressionQualityMetricResults.error_normality
RegressionQualityMetricResults.error_std
RegressionQualityMetricResults.error_std_ref
RegressionQualityMetricResults.hist_for_plot
RegressionQualityMetricResults.me_default_sigma
RegressionQualityMetricResults.me_hist_for_plot
RegressionQualityMetricResults.mean_abs_error
RegressionQualityMetricResults.mean_abs_error_default
RegressionQualityMetricResults.mean_abs_error_ref
RegressionQualityMetricResults.mean_abs_perc_error
RegressionQualityMetricResults.mean_abs_perc_error_default
RegressionQualityMetricResults.mean_abs_perc_error_ref
RegressionQualityMetricResults.mean_error
RegressionQualityMetricResults.mean_error_ref
RegressionQualityMetricResults.r2_score
RegressionQualityMetricResults.r2_score_ref
RegressionQualityMetricResults.rmse
RegressionQualityMetricResults.rmse_default
RegressionQualityMetricResults.rmse_ref
RegressionQualityMetricResults.underperformance
RegressionQualityMetricResults.underperformance_ref
RegressionQualityMetricResults.vals_for_plots
top_error module
RegressionTopErrorMetric
RegressionTopErrorMetric.calculate()
RegressionTopErrorMetricRenderer
RegressionTopErrorMetricRenderer.color_options
RegressionTopErrorMetricRenderer.render_html()
RegressionTopErrorMetricRenderer.render_json()
RegressionTopErrorMetricResults
RegressionTopErrorMetricResults.curr_mean_err_per_group
RegressionTopErrorMetricResults.curr_scatter
RegressionTopErrorMetricResults.ref_mean_err_per_group
RegressionTopErrorMetricResults.ref_scatter
Submodules
column_correlations_metric module
ColumnCorrelationsMetric
ColumnCorrelationsMetric.calculate()
ColumnCorrelationsMetric.column_name
ColumnCorrelationsMetricRenderer
ColumnCorrelationsMetricRenderer.color_options
ColumnCorrelationsMetricRenderer.render_html()
ColumnCorrelationsMetricRenderer.render_json()
ColumnCorrelationsMetricResult
ColumnCorrelationsMetricResult.column_name
ColumnCorrelationsMetricResult.current
ColumnCorrelationsMetricResult.reference
column_distribution_metric module
ColumnDistributionMetric
ColumnDistributionMetric.calculate()
ColumnDistributionMetric.column_name
ColumnDistributionMetricRenderer
ColumnDistributionMetricRenderer.color_options
ColumnDistributionMetricRenderer.render_html()
ColumnDistributionMetricRenderer.render_json()
ColumnDistributionMetricResult
ColumnDistributionMetricResult.column_name
ColumnDistributionMetricResult.current
ColumnDistributionMetricResult.reference
column_quantile_metric module
ColumnQuantileMetric
ColumnQuantileMetric.calculate()
ColumnQuantileMetric.column_name
ColumnQuantileMetric.quantile
ColumnQuantileMetricRenderer
ColumnQuantileMetricRenderer.color_options
ColumnQuantileMetricRenderer.render_html()
ColumnQuantileMetricRenderer.render_json()
ColumnQuantileMetricResult
ColumnQuantileMetricResult.column_name
ColumnQuantileMetricResult.current
ColumnQuantileMetricResult.current_distribution
ColumnQuantileMetricResult.quantile
ColumnQuantileMetricResult.reference
ColumnQuantileMetricResult.reference_distribution
column_value_list_metric module
ColumnValueListMetric
ColumnValueListMetric.calculate()
ColumnValueListMetric.column_name
ColumnValueListMetric.values
ColumnValueListMetricRenderer
ColumnValueListMetricRenderer.color_options
ColumnValueListMetricRenderer.render_html()
ColumnValueListMetricRenderer.render_json()
ColumnValueListMetricResult
ColumnValueListMetricResult.column_name
ColumnValueListMetricResult.current
ColumnValueListMetricResult.reference
ColumnValueListMetricResult.values
ValueListStat
ValueListStat.number_in_list
ValueListStat.number_not_in_list
ValueListStat.rows_count
ValueListStat.share_in_list
ValueListStat.share_not_in_list
ValueListStat.values_in_list
ValueListStat.values_not_in_list
column_value_range_metric module
ColumnValueRangeMetric
ColumnValueRangeMetric.calculate()
ColumnValueRangeMetric.column_name
ColumnValueRangeMetric.left
ColumnValueRangeMetric.right
ColumnValueRangeMetricRenderer
ColumnValueRangeMetricRenderer.color_options
ColumnValueRangeMetricRenderer.render_html()
ColumnValueRangeMetricRenderer.render_json()
ColumnValueRangeMetricResult
ColumnValueRangeMetricResult.column_name
ColumnValueRangeMetricResult.current
ColumnValueRangeMetricResult.current_distribution
ColumnValueRangeMetricResult.left
ColumnValueRangeMetricResult.reference
ColumnValueRangeMetricResult.reference_distribution
ColumnValueRangeMetricResult.right
ValuesInRangeStat
ValuesInRangeStat.number_in_range
ValuesInRangeStat.number_not_in_range
ValuesInRangeStat.number_of_values
ValuesInRangeStat.share_in_range
ValuesInRangeStat.share_not_in_range
dataset_correlations_metric module
CorrelationStats
CorrelationStats.abs_max_correlation
CorrelationStats.abs_max_features_correlation
CorrelationStats.abs_max_prediction_features_correlation
CorrelationStats.abs_max_target_features_correlation
CorrelationStats.target_prediction_correlation
DataQualityCorrelationMetricsRenderer
DataQualityCorrelationMetricsRenderer.color_options
DataQualityCorrelationMetricsRenderer.render_html()
DataQualityCorrelationMetricsRenderer.render_json()
DatasetCorrelation
DatasetCorrelation.correlation
DatasetCorrelation.stats
DatasetCorrelationsMetric
DatasetCorrelationsMetric.calculate()
DatasetCorrelationsMetricResult
DatasetCorrelationsMetricResult.current
DatasetCorrelationsMetricResult.reference
stability_metric module
DataQualityStabilityMetric
DataQualityStabilityMetric.calculate()
DataQualityStabilityMetricRenderer
DataQualityStabilityMetricRenderer.color_options
DataQualityStabilityMetricRenderer.render_html()
DataQualityStabilityMetricRenderer.render_json()
DataQualityStabilityMetricResult
DataQualityStabilityMetricResult.number_not_stable_prediction
DataQualityStabilityMetricResult.number_not_stable_target
Submodules
base_classification_metric module
ThresholdClassificationMetric
ThresholdClassificationMetric.get_target_prediction_data()
ThresholdClassificationMetric.k
ThresholdClassificationMetric.probas_threshold
class_balance_metric module
ClassificationClassBalance
ClassificationClassBalance.calculate()
ClassificationClassBalanceRenderer
ClassificationClassBalanceRenderer.color_options
ClassificationClassBalanceRenderer.render_html()
ClassificationClassBalanceRenderer.render_json()
ClassificationClassBalanceResult
ClassificationClassBalanceResult.plot_data
class_separation_metric module
ClassificationClassSeparationPlot
ClassificationClassSeparationPlot.calculate()
ClassificationClassSeparationPlotRenderer
ClassificationClassSeparationPlotRenderer.color_options
ClassificationClassSeparationPlotRenderer.render_html()
ClassificationClassSeparationPlotRenderer.render_json()
ClassificationClassSeparationPlotResults
ClassificationClassSeparationPlotResults.current_plot
ClassificationClassSeparationPlotResults.reference_plot
ClassificationClassSeparationPlotResults.target_name
classification_dummy_metric module
ClassificationDummyMetric
ClassificationDummyMetric.calculate()
ClassificationDummyMetric.correction_for_threshold()
ClassificationDummyMetric.quality_metric
ClassificationDummyMetricRenderer
ClassificationDummyMetricRenderer.color_options
ClassificationDummyMetricRenderer.render_html()
ClassificationDummyMetricRenderer.render_json()
ClassificationDummyMetricResults
ClassificationDummyMetricResults.by_reference_dummy
ClassificationDummyMetricResults.dummy
ClassificationDummyMetricResults.metrics_matrix
ClassificationDummyMetricResults.model_quality
classification_quality_metric module
ClassificationQualityMetric
ClassificationQualityMetric.calculate()
ClassificationQualityMetric.confusion_matrix_metric
ClassificationQualityMetricRenderer
ClassificationQualityMetricRenderer.color_options
ClassificationQualityMetricRenderer.render_html()
ClassificationQualityMetricRenderer.render_json()
ClassificationQualityMetricResult
ClassificationQualityMetricResult.current
ClassificationQualityMetricResult.reference
ClassificationQualityMetricResult.target_name
confusion_matrix_metric module
ClassificationConfusionMatrix
ClassificationConfusionMatrix.calculate()
ClassificationConfusionMatrix.k
ClassificationConfusionMatrix.probas_threshold
ClassificationConfusionMatrixRenderer
ClassificationConfusionMatrixRenderer.color_options
ClassificationConfusionMatrixRenderer.render_html()
ClassificationConfusionMatrixRenderer.render_json()
ClassificationConfusionMatrixResult
ClassificationConfusionMatrixResult.current_matrix
ClassificationConfusionMatrixResult.reference_matrix
pr_curve_metric module
ClassificationPRCurve
ClassificationPRCurve.calculate()
ClassificationPRCurve.calculate_metrics()
ClassificationPRCurveRenderer
ClassificationPRCurveRenderer.color_options
ClassificationPRCurveRenderer.render_html()
ClassificationPRCurveRenderer.render_json()
ClassificationPRCurveResults
ClassificationPRCurveResults.current_pr_curve
ClassificationPRCurveResults.reference_pr_curve
pr_table_metric module
ClassificationPRTable
ClassificationPRTable.calculate()
ClassificationPRTable.calculate_metrics()
ClassificationPRTableRenderer
ClassificationPRTableRenderer.color_options
ClassificationPRTableRenderer.render_html()
ClassificationPRTableRenderer.render_json()
ClassificationPRTableResults
ClassificationPRTableResults.current_pr_table
ClassificationPRTableResults.reference_pr_table
probability_distribution_metric module
ClassificationProbDistribution
ClassificationProbDistribution.calculate()
ClassificationProbDistribution.get_distribution()
ClassificationProbDistributionRenderer
ClassificationProbDistributionRenderer.color_options
ClassificationProbDistributionRenderer.render_html()
ClassificationProbDistributionRenderer.render_json()
ClassificationProbDistributionResults
ClassificationProbDistributionResults.current_distribution
ClassificationProbDistributionResults.reference_distribution
quality_by_class_metric module
ClassificationQualityByClass
ClassificationQualityByClass.calculate()
ClassificationQualityByClass.k
ClassificationQualityByClass.probas_threshold
ClassificationQualityByClassRenderer
ClassificationQualityByClassRenderer.color_options
ClassificationQualityByClassRenderer.render_html()
ClassificationQualityByClassRenderer.render_json()
ClassificationQualityByClassResult
ClassificationQualityByClassResult.columns
ClassificationQualityByClassResult.current_metrics
ClassificationQualityByClassResult.current_roc_aucs
ClassificationQualityByClassResult.reference_metrics
ClassificationQualityByClassResult.reference_roc_aucs
quality_by_feature_table module
ClassificationQualityByFeatureTable
ClassificationQualityByFeatureTable.calculate()
ClassificationQualityByFeatureTable.columns
ClassificationQualityByFeatureTableRenderer
ClassificationQualityByFeatureTableRenderer.color_options
ClassificationQualityByFeatureTableRenderer.render_html()
ClassificationQualityByFeatureTableRenderer.render_json()
ClassificationQualityByFeatureTableResults
ClassificationQualityByFeatureTableResults.columns
ClassificationQualityByFeatureTableResults.curr_predictions
ClassificationQualityByFeatureTableResults.current_plot_data
ClassificationQualityByFeatureTableResults.ref_predictions
ClassificationQualityByFeatureTableResults.reference_plot_data
ClassificationQualityByFeatureTableResults.target_name
roc_curve_metric module
ClassificationRocCurve
ClassificationRocCurve.calculate()
ClassificationRocCurve.calculate_metrics()
ClassificationRocCurveRenderer
ClassificationRocCurveRenderer.color_options
ClassificationRocCurveRenderer.render_html()
ClassificationRocCurveRenderer.render_json()
ClassificationRocCurveResults
ClassificationRocCurveResults.current_roc_curve
ClassificationRocCurveResults.reference_roc_curve
Submodules
column_missing_values_metric module
ColumnMissingValues
ColumnMissingValues.different_missing_values
ColumnMissingValues.number_of_different_missing_values
ColumnMissingValues.number_of_missing_values
ColumnMissingValues.number_of_rows
ColumnMissingValues.share_of_missing_values
ColumnMissingValuesMetric
ColumnMissingValuesMetric.DEFAULT_MISSING_VALUES
ColumnMissingValuesMetric.calculate()
ColumnMissingValuesMetric.column_name
ColumnMissingValuesMetric.missing_values
ColumnMissingValuesMetricRenderer
ColumnMissingValuesMetricRenderer.color_options
ColumnMissingValuesMetricRenderer.render_html()
ColumnMissingValuesMetricRenderer.render_json()
ColumnMissingValuesMetricResult
ColumnMissingValuesMetricResult.column_name
ColumnMissingValuesMetricResult.current
ColumnMissingValuesMetricResult.reference
column_regexp_metric module
ColumnRegExpMetric
ColumnRegExpMetric.calculate()
ColumnRegExpMetric.column_name
ColumnRegExpMetric.reg_exp
ColumnRegExpMetric.top
ColumnRegExpMetricRenderer
ColumnRegExpMetricRenderer.color_options
ColumnRegExpMetricRenderer.render_html()
ColumnRegExpMetricRenderer.render_json()
DataIntegrityValueByRegexpMetricResult
DataIntegrityValueByRegexpMetricResult.column_name
DataIntegrityValueByRegexpMetricResult.current
DataIntegrityValueByRegexpMetricResult.reference
DataIntegrityValueByRegexpMetricResult.reg_exp
DataIntegrityValueByRegexpMetricResult.top
DataIntegrityValueByRegexpStat
DataIntegrityValueByRegexpStat.number_of_matched
DataIntegrityValueByRegexpStat.number_of_not_matched
DataIntegrityValueByRegexpStat.number_of_rows
DataIntegrityValueByRegexpStat.table_of_matched
DataIntegrityValueByRegexpStat.table_of_not_matched
column_summary_metric module
CategoricalCharacteristics
CategoricalCharacteristics.count
CategoricalCharacteristics.missing
CategoricalCharacteristics.missing_percentage
CategoricalCharacteristics.most_common
CategoricalCharacteristics.most_common_percentage
CategoricalCharacteristics.new_in_current_values_count
CategoricalCharacteristics.number_of_rows
CategoricalCharacteristics.unique
CategoricalCharacteristics.unique_percentage
CategoricalCharacteristics.unused_in_current_values_count
ColumnSummary
ColumnSummary.column_name
ColumnSummary.column_type
ColumnSummary.current_characteristics
ColumnSummary.plot_data
ColumnSummary.reference_characteristics
ColumnSummaryMetric
ColumnSummaryMetric.calculate()
ColumnSummaryMetric.map_data()
ColumnSummaryMetricRenderer
ColumnSummaryMetricRenderer.color_options
ColumnSummaryMetricRenderer.render_html()
ColumnSummaryMetricRenderer.render_json()
DataByTarget
DataByTarget.data_for_plots
DataByTarget.target_name
DataByTarget.target_type
DataInTime
DataInTime.data_for_plots
DataInTime.datetime_name
DataInTime.freq
DataQualityPlot
DataQualityPlot.bins_for_hist
DataQualityPlot.counts_of_values
DataQualityPlot.data_by_target
DataQualityPlot.data_in_time
DatetimeCharacteristics
DatetimeCharacteristics.count
DatetimeCharacteristics.first
DatetimeCharacteristics.last
DatetimeCharacteristics.missing
DatetimeCharacteristics.missing_percentage
DatetimeCharacteristics.most_common
DatetimeCharacteristics.most_common_percentage
DatetimeCharacteristics.number_of_rows
DatetimeCharacteristics.unique
DatetimeCharacteristics.unique_percentage
NumericCharacteristics
NumericCharacteristics.count
NumericCharacteristics.infinite_count
NumericCharacteristics.infinite_percentage
NumericCharacteristics.max
NumericCharacteristics.mean
NumericCharacteristics.min
NumericCharacteristics.missing
NumericCharacteristics.missing_percentage
NumericCharacteristics.most_common
NumericCharacteristics.most_common_percentage
NumericCharacteristics.number_of_rows
NumericCharacteristics.p25
NumericCharacteristics.p50
NumericCharacteristics.p75
NumericCharacteristics.std
NumericCharacteristics.unique
NumericCharacteristics.unique_percentage
dataset_missing_values_metric module
DatasetMissingValues
DatasetMissingValues.columns_with_missing_values
DatasetMissingValues.different_missing_values
DatasetMissingValues.different_missing_values_by_column
DatasetMissingValues.number_of_columns
DatasetMissingValues.number_of_columns_with_missing_values
DatasetMissingValues.number_of_different_missing_values
DatasetMissingValues.number_of_different_missing_values_by_column
DatasetMissingValues.number_of_missing_values
DatasetMissingValues.number_of_missing_values_by_column
DatasetMissingValues.number_of_rows
DatasetMissingValues.number_of_rows_with_missing_values
DatasetMissingValues.share_of_columns_with_missing_values
DatasetMissingValues.share_of_missing_values
DatasetMissingValues.share_of_missing_values_by_column
DatasetMissingValues.share_of_rows_with_missing_values
DatasetMissingValuesMetric
DatasetMissingValuesMetric.DEFAULT_MISSING_VALUES
DatasetMissingValuesMetric.calculate()
DatasetMissingValuesMetric.missing_values
DatasetMissingValuesMetricRenderer
DatasetMissingValuesMetricRenderer.color_options
DatasetMissingValuesMetricRenderer.render_html()
DatasetMissingValuesMetricRenderer.render_json()
DatasetMissingValuesMetricResult
DatasetMissingValuesMetricResult.current
DatasetMissingValuesMetricResult.reference
dataset_summary_metric module
DatasetSummary
DatasetSummary.columns_type
DatasetSummary.date_column
DatasetSummary.id_column
DatasetSummary.nans_by_columns
DatasetSummary.number_of_almost_constant_columns
DatasetSummary.number_of_almost_duplicated_columns
DatasetSummary.number_of_categorical_columns
DatasetSummary.number_of_columns
DatasetSummary.number_of_constant_columns
DatasetSummary.number_of_datetime_columns
DatasetSummary.number_of_duplicated_columns
DatasetSummary.number_of_duplicated_rows
DatasetSummary.number_of_empty_columns
DatasetSummary.number_of_empty_rows
DatasetSummary.number_of_missing_values
DatasetSummary.number_of_numeric_columns
DatasetSummary.number_of_rows
DatasetSummary.number_uniques_by_columns
DatasetSummary.prediction
DatasetSummary.target
DatasetSummaryMetric
DatasetSummaryMetric.almost_constant_threshold
DatasetSummaryMetric.almost_duplicated_threshold
DatasetSummaryMetric.calculate()
DatasetSummaryMetricRenderer
DatasetSummaryMetricRenderer.color_options
DatasetSummaryMetricRenderer.render_html()
DatasetSummaryMetricRenderer.render_json()
DatasetSummaryMetricResult
DatasetSummaryMetricResult.almost_duplicated_threshold
DatasetSummaryMetricResult.current
DatasetSummaryMetricResult.reference
DataDefinition
DataDefinition