mlm_insights package

Subpackages

• mlm_insights.builder package
  • Subpackages
    • mlm_insights.builder.constants package
      • Submodules
      • mlm_insights.builder.constants.constants module
      • Module contents
    • mlm_insights.builder.exceptions package
      • Submodules
      • mlm_insights.builder.exceptions.builder_exception module
      • mlm_insights.builder.exceptions.post_processor_run_exception module
      • Module contents
    • mlm_insights.builder.runner package
      • Submodules
      • mlm_insights.builder.runner.post_processor_runner module
      • mlm_insights.builder.runner.runner module
      • Module contents
    • mlm_insights.builder.usage package
      • Submodules
      • mlm_insights.builder.usage.insights_usage_manager module
      • mlm_insights.builder.usage.minimal_insights_usage_manager module
      • Module contents
    • mlm_insights.builder.utils package
      • Submodules
      • mlm_insights.builder.utils.builder_utils module
      • mlm_insights.builder.utils.generate_input_schema_utils module
      • Module contents
  • Submodules
  • mlm_insights.builder.builder_component module
    • EngineDetail
      • EngineDetail.engine_client
      • EngineDetail.engine_name
    • MetricDetail
      • MetricDetail.dataset_metrics
      • MetricDetail.univariate_metric
    • RunResult
      • RunResult.post_processor_run_result
      • RunResult.profile
      • RunResult.test_results
    • TestConfig
      • TestConfig.tests
      • TestConfig.user_defined_tags
  • mlm_insights.builder.insights_builder module
    • InsightsBuilder
      • InsightsBuilder.build()
      • InsightsBuilder.with_data_frame()
      • InsightsBuilder.with_engine()
      • InsightsBuilder.with_input_schema()
      • InsightsBuilder.with_input_schema_using_dataset()
      • InsightsBuilder.with_metrics()
      • InsightsBuilder.with_post_processors()
      • InsightsBuilder.with_reader()
      • InsightsBuilder.with_reference_profile()
      • InsightsBuilder.with_tags()
      • InsightsBuilder.with_test_config()
      • InsightsBuilder.with_transformers()
  • mlm_insights.builder.schema_helper module
    • SchemaHelper
      • SchemaHelper.are_prediction_target_types_same()
      • SchemaHelper.get_categorical_features()
      • SchemaHelper.get_prediction_features()
      • SchemaHelper.get_prediction_score_feature()
      • SchemaHelper.get_prediction_types()
      • SchemaHelper.get_quantitative_features()
      • SchemaHelper.get_target_features()
      • SchemaHelper.get_target_types()
      • SchemaHelper.has_prediction_score_column()
      • SchemaHelper.is_not_binary_or_multiclass()
      • SchemaHelper.is_valid_classification_types()
      • SchemaHelper.is_valid_regression_types()
      • SchemaHelper.to_insights_schema()
    • map_to_name()
  • Module contents
• mlm_insights.config_reader package
  • Subpackages
    • mlm_insights.config_reader.constants package
      • Module contents
    • mlm_insights.config_reader.exceptions package
      • Submodules
      • mlm_insights.config_reader.exceptions.config_reader_exception module
      • Module contents
    • mlm_insights.config_reader.utils package
      • Submodules
      • mlm_insights.config_reader.utils.config_parser module
      • mlm_insights.config_reader.utils.config_reader_tests_utils module
      • mlm_insights.config_reader.utils.config_reader_utils module
      • mlm_insights.config_reader.utils.config_registry module
      • Module contents
  • Submodules
  • mlm_insights.config_reader.custom_component module
    • CustomComponent
  • mlm_insights.config_reader.insights_config_reader module
    • InsightsConfigReader
      • InsightsConfigReader.get_builder()
      • InsightsConfigReader.get_test_builder()
      • InsightsConfigReader.with_custom_component()
  • Module contents
• mlm_insights.config_writer package
  • Submodules
  • mlm_insights.config_writer.insights_config_writer module
    • InsightsConfigWriter
      • InsightsConfigWriter.add_test_to_config()
      • InsightsConfigWriter.config_json
      • InsightsConfigWriter.get_config()
      • InsightsConfigWriter.insights_builder
      • InsightsConfigWriter.save_config_to_object_storage()
      • InsightsConfigWriter.to_json()
  • Module contents
• mlm_insights.constants package
  • Submodules
  • mlm_insights.constants.constants module
  • mlm_insights.constants.definitions module
  • mlm_insights.constants.types module
    • ColumnType
      • ColumnType.ID
      • ColumnType.INPUT
      • ColumnType.PREDICTION
      • ColumnType.PREDICTION_SCORE
      • ColumnType.TARGET
    • DataType
      • DataType.BOOLEAN
      • DataType.DATETIME
      • DataType.FLOAT
      • DataType.INTEGER
      • DataType.OBJECT
      • DataType.STRING
      • DataType.TEXT
      • DataType.TIMESTAMP
    • ExecutionEngineType
      • ExecutionEngineType.DASK
      • ExecutionEngineType.NATIVE
      • ExecutionEngineType.SPARK
      • ExecutionEngineType.has_value()
    • ExtendedEnum
      • ExtendedEnum.list()
    • FeatureType
      • FeatureType.column_type
      • FeatureType.config
      • FeatureType.data_type
      • FeatureType.variable_type
    • PandasDataType
      • PandasDataType.BOOLEAN
      • PandasDataType.DATETIME
      • PandasDataType.FLOAT
      • PandasDataType.INTEGER
      • PandasDataType.OBJECT
      • PandasDataType.STRING
      • PandasDataType.TEXT
      • PandasDataType.TIMESTAMP
    • ThresholdValueSource
      • ThresholdValueSource.REFERENCE_PROFILE
      • ThresholdValueSource.USER_PROVIDED
    • VariableType
      • VariableType.BINARY
      • VariableType.CONTINUOUS
      • VariableType.DATETIME
      • VariableType.DISCRETE
      • VariableType.NOMINAL
      • VariableType.OBJECT
      • VariableType.ORDINAL
      • VariableType.TEXT
    • to_native_type()
  • Module contents
• mlm_insights.core package
  • Subpackages
    • mlm_insights.core.binning package
      • Submodules
      • mlm_insights.core.binning.binning_calculator module
      • Module contents
    • mlm_insights.core.common package
      • Submodules
      • mlm_insights.core.common.component_validation module
      • mlm_insights.core.common.serializer_helper module
      • Module contents
    • mlm_insights.core.constants package
      • Submodules
      • mlm_insights.core.constants.constants module
      • Module contents
    • mlm_insights.core.data_sources package
      • Subpackages
      • Submodules
      • mlm_insights.core.data_sources.data_source module
      • mlm_insights.core.data_sources.file_url_data_source module
      • mlm_insights.core.data_sources.local_date_prefix_data_source module
      • mlm_insights.core.data_sources.local_file_data_source module
      • mlm_insights.core.data_sources.oci_date_prefix_data_source module
      • mlm_insights.core.data_sources.oci_object_storage_data_source module
      • mlm_insights.core.data_sources.oci_object_storage_file_search_data_source module
      • Module contents
    • mlm_insights.core.drift_algorithms package
      • Submodules
      • mlm_insights.core.drift_algorithms.chi_square module
      • mlm_insights.core.drift_algorithms.drift_algorithm_result module
      • mlm_insights.core.drift_algorithms.jensen_shannon module
      • mlm_insights.core.drift_algorithms.kolmogorov_smirnov_test module
      • mlm_insights.core.drift_algorithms.kullback_leibler_divergence module
      • mlm_insights.core.drift_algorithms.population_stability_index module
      • mlm_insights.core.drift_algorithms.utils module
      • Module contents
    • mlm_insights.core.exceptions package
      • Submodules
      • mlm_insights.core.exceptions.component_deserialize_exception module
      • mlm_insights.core.exceptions.feature_mismatch_exception module
      • mlm_insights.core.exceptions.invalid_input_query_error module
      • mlm_insights.core.exceptions.invalid_parameter_exception module
      • mlm_insights.core.exceptions.invalid_target_prediction_exception module
      • mlm_insights.core.exceptions.metric_merge_exception module
      • mlm_insights.core.exceptions.missing_required_parameter_exception module
      • mlm_insights.core.exceptions.nested_json_reader_exception module
      • mlm_insights.core.exceptions.post_processor_exception module
      • mlm_insights.core.exceptions.profile_read_exception module
      • Module contents
    • mlm_insights.core.execution_engine package
      • Subpackages
      • Module contents
    • mlm_insights.core.factory package
      • Module contents
    • mlm_insights.core.features package
      • Submodules
      • mlm_insights.core.features.feature module
      • Module contents
    • mlm_insights.core.interfaces package
      • Submodules
      • mlm_insights.core.interfaces.serializable module
      • Module contents
    • mlm_insights.core.metrics package
      • Subpackages
      • Submodules
      • mlm_insights.core.metrics.count module
      • mlm_insights.core.metrics.dataset_metric_registry module
      • mlm_insights.core.metrics.dataset_summary module
      • mlm_insights.core.metrics.distinct_count module
      • mlm_insights.core.metrics.duplicate_count module
      • mlm_insights.core.metrics.framework_metrics_enum module
      • mlm_insights.core.metrics.frequency_distribution module
      • mlm_insights.core.metrics.iqr module
      • mlm_insights.core.metrics.is_constant_feature module
      • mlm_insights.core.metrics.is_negative module
      • mlm_insights.core.metrics.is_non_zero module
      • mlm_insights.core.metrics.is_positive module
      • mlm_insights.core.metrics.is_quasi_constant_feature module
      • mlm_insights.core.metrics.kurtosis module
      • mlm_insights.core.metrics.max module
      • mlm_insights.core.metrics.mean module
      • mlm_insights.core.metrics.metric_metadata module
      • mlm_insights.core.metrics.metric_registry module
      • mlm_insights.core.metrics.metric_result module
      • mlm_insights.core.metrics.min module
      • mlm_insights.core.metrics.mode module
      • mlm_insights.core.metrics.percentiles module
      • mlm_insights.core.metrics.performance_metrics_utils module
      • mlm_insights.core.metrics.probablity_distribution module
      • mlm_insights.core.metrics.quartiles module
      • mlm_insights.core.metrics.range module
      • mlm_insights.core.metrics.rows_count module
      • mlm_insights.core.metrics.serializer module
      • mlm_insights.core.metrics.skewness module
      • mlm_insights.core.metrics.standard_deviation module
      • mlm_insights.core.metrics.sum module
      • mlm_insights.core.metrics.top_k_frequent_elements module
      • mlm_insights.core.metrics.type_metric module
      • mlm_insights.core.metrics.variance module
      • Module contents
    • mlm_insights.core.post_processors package
      • Subpackages
      • Submodules
      • mlm_insights.core.post_processors.local_writer_post_processor module
      • mlm_insights.core.post_processors.object_storage_writer_post_processor module
      • mlm_insights.core.post_processors.oci_monitoring_post_processor module
      • mlm_insights.core.post_processors.post_processor_request module
      • mlm_insights.core.post_processors.post_processor_result module
      • Module contents
    • mlm_insights.core.profile_readers package
      • Subpackages
      • Submodules
      • mlm_insights.core.profile_readers.local_profile_reader module
      • mlm_insights.core.profile_readers.oci_object_storage_profile_reader module
      • mlm_insights.core.profile_readers.profile_reader_result module
      • Module contents
    • mlm_insights.core.profiles package
      • Submodules
      • mlm_insights.core.profiles.profile module
      • mlm_insights.core.profiles.profile_data_message module
      • mlm_insights.core.profiles.profile_header module
      • mlm_insights.core.profiles.tags module
      • Module contents
    • mlm_insights.core.proto_py package
      • Subpackages
      • Module contents
    • mlm_insights.core.queries package
      • Subpackages
      • Module contents
    • mlm_insights.core.readers package
      • Subpackages
      • Module contents
    • mlm_insights.core.schema package
      • Subpackages
      • Module contents
    • mlm_insights.core.sdcs package
      • Subpackages
      • Submodules
      • mlm_insights.core.sdcs.confusion_matrix_component module
      • mlm_insights.core.sdcs.cpc_sdc module
      • mlm_insights.core.sdcs.framework_sdc module
      • mlm_insights.core.sdcs.multi_threshold_confusion_matrix module
      • mlm_insights.core.sdcs.sdc_registry module
      • Module contents
    • mlm_insights.core.sfcs package
      • Subpackages
      • Submodules
      • mlm_insights.core.sfcs.cpc_sfc module
      • mlm_insights.core.sfcs.descriptive_statistics_sfc module
      • mlm_insights.core.sfcs.distinct_count_sfc module
      • mlm_insights.core.sfcs.framework_sfc module
      • mlm_insights.core.sfcs.frequent_items_sfc module
      • mlm_insights.core.sfcs.quantiles_sfc module
      • mlm_insights.core.sfcs.sfc_merge_exception module
      • mlm_insights.core.sfcs.sfc_registry module
      • Module contents
    • mlm_insights.core.transformers package
      • Subpackages
      • Submodules
      • mlm_insights.core.transformers.ast_based_expression_evaluator module
      • mlm_insights.core.transformers.conditional_feature_transformer module
      • mlm_insights.core.transformers.expression_evaluator module
      • Module contents
    • mlm_insights.core.utils package
      • Subpackages
      • Submodules
      • mlm_insights.core.utils.common_utils module
      • mlm_insights.core.utils.feature_component module
      • mlm_insights.core.utils.hash module
      • mlm_insights.core.utils.klasses module
      • Module contents
  • Module contents
• mlm_insights.mlm_dask package
  • Subpackages
    • mlm_insights.mlm_dask.execution_engine package
      • Submodules
      • mlm_insights.mlm_dask.execution_engine.dask_engine module
      • Module contents
    • mlm_insights.mlm_dask.interfaces package
      • Submodules
      • mlm_insights.mlm_dask.interfaces.dask_data_reader module
      • Module contents
    • mlm_insights.mlm_dask.readers package
      • Submodules
      • mlm_insights.mlm_dask.readers.csv_dask_data_readers module
      • mlm_insights.mlm_dask.readers.jsonl_dask_data_readers module
      • mlm_insights.mlm_dask.readers.nested_json_dask_data_reader module
      • Module contents
    • mlm_insights.mlm_dask.schema package
      • Submodules
      • mlm_insights.mlm_dask.schema.dask_schema_provider module
      • Module contents
  • Module contents
• mlm_insights.mlm_native package
  • Subpackages
    • mlm_insights.mlm_native.exceptions package
      • Module contents
    • mlm_insights.mlm_native.execution_engine package
      • Submodules
      • mlm_insights.mlm_native.execution_engine.native_engine module
      • Module contents
    • mlm_insights.mlm_native.interfaces package
      • Submodules
      • mlm_insights.mlm_native.interfaces.native_data_reader module
      • Module contents
    • mlm_insights.mlm_native.readers package
      • Submodules
      • mlm_insights.mlm_native.readers.csv_native_data_reader module
      • mlm_insights.mlm_native.readers.jsonl_native_data_reader module
      • mlm_insights.mlm_native.readers.nested_json_native_data_reader module
      • Module contents
    • mlm_insights.mlm_native.schema package
      • Submodules
      • mlm_insights.mlm_native.schema.native_schema_provider module
      • Module contents
  • Module contents
• mlm_insights.mlm_spark package
  • Subpackages
    • mlm_insights.mlm_spark.execution_engine package
      • Submodules
      • mlm_insights.mlm_spark.execution_engine.spark_engine module
      • Module contents
  • Module contents
• mlm_insights.tests package
  • Subpackages
    • mlm_insights.tests.exceptions package
      • Submodules
      • mlm_insights.tests.exceptions.errors module
      • mlm_insights.tests.exceptions.test_builder_exception module
      • Module contents
    • mlm_insights.tests.selectors package
      • Subpackages
      • Submodules
      • mlm_insights.tests.selectors.dataset_metric_selector module
      • mlm_insights.tests.selectors.feature_metric_selector module
      • mlm_insights.tests.selectors.selector_result module
      • mlm_insights.tests.selectors.selector_validation_result module
      • Module contents
    • mlm_insights.tests.test_builder package
      • Submodules
      • mlm_insights.tests.test_builder.test_builder module
      • Module contents
    • mlm_insights.tests.test_context package
      • Subpackages
      • Submodules
      • mlm_insights.tests.test_context.profile_test_context module
      • Module contents
    • mlm_insights.tests.test_runner package
      • Submodules
      • mlm_insights.tests.test_runner.test_runner module
      • Module contents
    • mlm_insights.tests.test_suites package
      • Module contents
    • mlm_insights.tests.test_types package
      • Subpackages
      • Module contents
  • Submodules
  • mlm_insights.tests.constants module
    • GroupByKey
      • GroupByKey.FEATURE_TAG_KEY
      • GroupByKey.TEST_STATUS_KEY
      • GroupByKey.TEST_TYPE_TAG_KEY
  • mlm_insights.tests.framework_tests_enum module
    • FrameworkTestsEnum
      • FrameworkTestsEnum.TestDeviation
      • FrameworkTestsEnum.TestEqual
      • FrameworkTestsEnum.TestGreaterThan
      • FrameworkTestsEnum.TestIsBetween
      • FrameworkTestsEnum.TestIsComplete
      • FrameworkTestsEnum.TestIsMatchingInferenceType
      • FrameworkTestsEnum.TestIsNegative
      • FrameworkTestsEnum.TestIsNonZero
      • FrameworkTestsEnum.TestIsPositive
      • FrameworkTestsEnum.TestLessThan
      • FrameworkTestsEnum.TestStringEquals
  • mlm_insights.tests.profile_source module
    • ProfileSource
      • ProfileSource.CURRENT
      • ProfileSource.REFERENCE
  • mlm_insights.tests.test_result module
    • TestAssertionInfo
      • TestAssertionInfo.actual
      • TestAssertionInfo.expected
    • TestError
      • TestError.description
      • TestError.has_error
    • TestResult
      • TestResult.description
      • TestResult.error
      • TestResult.name
      • TestResult.status
      • TestResult.system_tags
      • TestResult.test_assertion_info
      • TestResult.test_config
      • TestResult.to_dict()
      • TestResult.user_defined_tags
    • TestStatus
      • TestStatus.ERROR
      • TestStatus.FAILED
      • TestStatus.PASSED
      • TestStatus.get_status()
  • mlm_insights.tests.test_results module
    • TestResults
      • TestResults.group_tests_by()
      • TestResults.test_results
      • TestResults.test_summary
      • TestResults.to_json()
      • TestResults.user_defined_tags
  • mlm_insights.tests.test_summary module
    • TestSummary
      • TestSummary.error_test
      • TestSummary.failed_tests
      • TestSummary.passed_tests
      • TestSummary.total_tests
  • mlm_insights.tests.test_validation_result module
    • TestValidationResult
      • TestValidationResult.errors
      • TestValidationResult.is_valid()
      • TestValidationResult.valid
    • TestValidationResults
      • TestValidationResults.add_validation_result()
      • TestValidationResults.get_results()
      • TestValidationResults.has_errors()
      • TestValidationResults.validation_results
  • Module contents
• mlm_insights.utils package
  • Subpackages
    • mlm_insights.utils.config_validator_util package
      • Submodules
      • mlm_insights.utils.config_validator_util.component_exception module
      • mlm_insights.utils.config_validator_util.config_validator module
      • mlm_insights.utils.config_validator_util.config_validator_utils module
      • Module contents
    • mlm_insights.utils.nested_json_reader_query_validator package
      • Submodules
      • mlm_insights.utils.nested_json_reader_query_validator.nested_json_reader_query_validator module
      • Module contents
  • Module contents
• mlm_insights.workflow package
  • Subpackages
    • mlm_insights.workflow.exceptions package
      • Submodules
      • mlm_insights.workflow.exceptions.workflow_runtime_exception module
      • Module contents
    • mlm_insights.workflow.factory package
      • Submodules
      • mlm_insights.workflow.factory.execution_engine_factory module
      • Module contents
    • mlm_insights.workflow.interface package
      • Submodules
      • mlm_insights.workflow.interface.workflow_base module
      • Module contents
  • Submodules
  • mlm_insights.workflow.component_config module
    • FeatureConfig
      • FeatureConfig.feature_meta
      • FeatureConfig.metrics
    • ReaderConfig
      • ReaderConfig.config
      • ReaderConfig.klass
    • TransformerConfig
      • TransformerConfig.config
      • TransformerConfig.klass
  • mlm_insights.workflow.insights_fugue_workflow module
    • InsightFugueWorkflow
      • InsightFugueWorkflow.execute_workflow()
  • mlm_insights.workflow.workflow_request module
    • WorkflowRequest
  • Module contents

Module contents

mlm_insights.enable_default_logging(formatter: str = '%(asctime)s - %(levelname)s - %(filename)s - %(funcName)s() - %(lineno)s - %(message)s', log_level: int = 20) → None