mlm_insights.tests package
Subpackages
- mlm_insights.tests.exceptions package
- mlm_insights.tests.selectors package
- mlm_insights.tests.test_builder package
- mlm_insights.tests.test_context package
- mlm_insights.tests.test_runner package
- mlm_insights.tests.test_suites package
- mlm_insights.tests.test_types package
- Subpackages
- mlm_insights.tests.test_types.interfaces package
- mlm_insights.tests.test_types.metric_based_tests package
- Subpackages
- Submodules
- mlm_insights.tests.test_types.metric_based_tests.common module
- mlm_insights.tests.test_types.metric_based_tests.test_is_complete module
- mlm_insights.tests.test_types.metric_based_tests.test_is_matching_inference_type module
- mlm_insights.tests.test_types.metric_based_tests.test_is_negative module
- mlm_insights.tests.test_types.metric_based_tests.test_is_non_zero module
- mlm_insights.tests.test_types.metric_based_tests.test_is_positive module
- mlm_insights.tests.test_types.metric_based_tests.test_no_new_category module
- Module contents
- mlm_insights.tests.test_types.predicate_based_tests package
- Subpackages
- Submodules
- mlm_insights.tests.test_types.predicate_based_tests.test_deviation module
- mlm_insights.tests.test_types.predicate_based_tests.test_equal module
- mlm_insights.tests.test_types.predicate_based_tests.test_greater_than module
- mlm_insights.tests.test_types.predicate_based_tests.test_is_between module
- mlm_insights.tests.test_types.predicate_based_tests.test_less_than module
- mlm_insights.tests.test_types.predicate_based_tests.test_string_equals module
- Module contents
- Module contents
- Subpackages
Submodules
mlm_insights.tests.constants module
mlm_insights.tests.framework_tests_enum module
- class mlm_insights.tests.framework_tests_enum.FrameworkTestsEnum(value)
Bases:
Enum
Insights-provided Tests and Test Suites.
- TestDeviation = <class 'mlm_insights.tests.test_types.predicate_based_tests.test_deviation.TestDeviation'>
- TestEqual = <class 'mlm_insights.tests.test_types.predicate_based_tests.test_equal.TestEqual'>
- TestGreaterThan = <class 'mlm_insights.tests.test_types.predicate_based_tests.test_greater_than.TestGreaterThan'>
- TestIsBetween = <class 'mlm_insights.tests.test_types.predicate_based_tests.test_is_between.TestIsBetween'>
- TestIsComplete = <class 'mlm_insights.tests.test_types.metric_based_tests.test_is_complete.TestIsComplete'>
- TestIsMatchingInferenceType = <class 'mlm_insights.tests.test_types.metric_based_tests.test_is_matching_inference_type.TestIsMatchingInferenceType'>
- TestIsNegative = <class 'mlm_insights.tests.test_types.metric_based_tests.test_is_negative.TestIsNegative'>
- TestIsNonZero = <class 'mlm_insights.tests.test_types.metric_based_tests.test_is_non_zero.TestIsNonZero'>
- TestIsPositive = <class 'mlm_insights.tests.test_types.metric_based_tests.test_is_positive.TestIsPositive'>
- TestLessThan = <class 'mlm_insights.tests.test_types.predicate_based_tests.test_less_than.TestLessThan'>
- TestStringEquals = <class 'mlm_insights.tests.test_types.predicate_based_tests.test_string_equals.TestStringEquals'>
mlm_insights.tests.profile_source module
mlm_insights.tests.test_result module
- class mlm_insights.tests.test_result.TestAssertionInfo(expected: Any | None = None, actual: Any | None = None)
Bases:
object
Describes the expected and actual values for a test. For eg: when running a TestGreaterThan for a Mean metric with a threshold value of 200, expected contains the threshold value (200) and actual contains the value of Mean metric.
- actual: Any = None
- expected: Any = None
- class mlm_insights.tests.test_result.TestError(description: str = '', has_error: bool = False)
Bases:
object
Describes test error encountered during test execution.
- description: str = ''
- has_error: bool = False
- class mlm_insights.tests.test_result.TestResult(name: str, description: str, status: ~mlm_insights.tests.test_result.TestStatus, test_config: ~typing.Dict[str, ~typing.Any] = <factory>, test_assertion_info: ~mlm_insights.tests.test_result.TestAssertionInfo = <factory>, error: ~mlm_insights.tests.test_result.TestError = <factory>, user_defined_tags: ~typing.Dict[str, str] = <factory>, system_tags: ~typing.Dict[str, str] = <factory>)
Bases:
object
Class describing result in standard format returned by each test
- description: str
- name: str
- status: TestStatus
- system_tags: Dict[str, str]
- test_assertion_info: TestAssertionInfo
- test_config: Dict[str, Any]
- user_defined_tags: Dict[str, str]
mlm_insights.tests.test_results module
- class mlm_insights.tests.test_results.TestResults(test_summary: ~mlm_insights.tests.test_summary.TestSummary, test_results: ~typing.List[~mlm_insights.tests.test_result.TestResult], user_defined_tags: ~typing.Dict[str, str] = <factory>)
Bases:
object
- Class describing the results of test evaluation. Consists of 2 high-level properties:
Test Summary
List of test result for each configured test
Provides methods to group tests by following grouping keys: feature, test type, test status and tags
- group_tests_by(group_by: GroupByKey) Dict[str, List[TestResult]]
Group the test results by a key. Supported groupby keys are: feature_name, test_type, test_status
- test_results: List[TestResult]
- test_summary: TestSummary
- user_defined_tags: Dict[str, str]
mlm_insights.tests.test_summary module
- class mlm_insights.tests.test_summary.TestSummary(total_tests: int = 0, passed_tests: int = 0, failed_tests: int = 0, error_test: int = 0)
Bases:
object
- Test Summary returns the following information about the executed tests.
Count of tests executed
Count of passed tests
Count of failed tests
- Count of error tests
Tests error out when the test validation fails or error is encountered during test execution
- error_test: int = 0
- failed_tests: int = 0
- passed_tests: int = 0
- total_tests: int = 0
mlm_insights.tests.test_validation_result module
- class mlm_insights.tests.test_validation_result.TestValidationResult(valid: bool, errors: ~typing.List[str] = <factory>)
Bases:
object
TestValidationResult tells if a Validation done by a Insight Test is valid or not. Insight Test must set valid = True, if validation succeeded. If validation fails, it should set valid = False and additionally it also set the list of errors
- errors: List[str]
- valid: bool