mlrl.common package

This module provides common functionality for rule learning algorithms.

Subpackages

• mlrl.common.cython package
  • Submodules
    • mlrl.common.cython.feature_binning module
      • EqualFrequencyFeatureBinningConfig
      • EqualWidthFeatureBinningConfig
    • mlrl.common.cython.feature_info module
      • EqualFeatureInfo
      • FeatureInfo
      • MixedFeatureInfo
    • mlrl.common.cython.feature_matrix module
      • CContiguousFeatureMatrix
      • ColumnWiseFeatureMatrix
      • CscFeatureMatrix
      • CsrFeatureMatrix
      • FeatureMatrix
      • FortranContiguousFeatureMatrix
      • RowWiseFeatureMatrix
    • mlrl.common.cython.feature_sampling module
      • FeatureSamplingWithoutReplacementConfig
    • mlrl.common.cython.info module
      • CppBuildOption
      • CppHardwareResource
      • CppLibraryInfo
      • get_cpp_library_info()
      • get_gpu_devices()
      • get_num_cpu_cores()
      • is_gpu_available()
      • is_gpu_support_enabled()
      • is_multi_threading_support_enabled()
    • mlrl.common.cython.instance_sampling module
      • ExampleWiseStratifiedInstanceSamplingConfig
      • InstanceSamplingWithReplacementConfig
      • InstanceSamplingWithoutReplacementConfig
      • OutputWiseStratifiedInstanceSamplingConfig
    • mlrl.common.cython.label_matrix module
      • CContiguousLabelMatrix
      • CsrLabelMatrix
      • RowWiseLabelMatrix
    • mlrl.common.cython.learner module
      • BeamSearchTopDownRuleInductionMixin
      • DefaultRuleMixin
      • EqualFrequencyFeatureBinningMixin
      • EqualWidthFeatureBinningMixin
      • ExampleWiseStratifiedBiPartitionSamplingMixin
      • ExampleWiseStratifiedInstanceSamplingMixin
      • FeatureSamplingWithoutReplacementMixin
      • GreedyTopDownRuleInductionMixin
      • InstanceSamplingWithReplacementMixin
      • InstanceSamplingWithoutReplacementMixin
      • IrepRulePruningMixin
      • NoFeatureBinningMixin
      • NoFeatureSamplingMixin
      • NoGlobalPruningMixin
      • NoInstanceSamplingMixin
      • NoJointProbabilityCalibrationMixin
      • NoMarginalProbabilityCalibrationMixin
      • NoOutputSamplingMixin
      • NoParallelPredictionMixin
      • NoParallelRuleRefinementMixin
      • NoParallelStatisticUpdateMixin
      • NoPartitionSamplingMixin
      • NoPostProcessorMixin
      • NoRulePruningMixin
      • NoSequentialPostOptimizationMixin
      • NoSizeStoppingCriterionMixin
      • NoTimeStoppingCriterionMixin
      • OutputSamplingWithoutReplacementMixin
      • OutputWiseStratifiedBiPartitionSamplingMixin
      • OutputWiseStratifiedInstanceSamplingMixin
      • ParallelPredictionMixin
      • ParallelRuleRefinementMixin
      • ParallelStatisticUpdateMixin
      • PostPruningMixin
      • PrePruningMixin
      • RandomBiPartitionSamplingMixin
      • RoundRobinOutputSamplingMixin
      • RuleLearnerConfig
      • SequentialPostOptimizationMixin
      • SequentialRuleModelAssemblageMixin
      • SizeStoppingCriterionMixin
      • TimeStoppingCriterionMixin
      • TrainingResult
    • mlrl.common.cython.learner_classification module
      • ClassificationRuleLearner
      • ExampleWiseStratifiedBiPartitionSamplingMixin
      • ExampleWiseStratifiedInstanceSamplingMixin
      • OutputWiseStratifiedBiPartitionSamplingMixin
      • OutputWiseStratifiedInstanceSamplingMixin
    • mlrl.common.cython.learner_regression module
      • RegressionRuleLearner
    • mlrl.common.cython.multi_threading module
      • ManualMultiThreadingConfig
    • mlrl.common.cython.output_matrix module
      • OutputMatrix
    • mlrl.common.cython.output_sampling module
      • OutputSamplingWithoutReplacementConfig
    • mlrl.common.cython.output_space_info module
      • LabelVectorSet
      • LabelVectorSetVisitor
      • NoOutputSpaceInfo
      • OutputSpaceInfo
    • mlrl.common.cython.partition_sampling module
      • ExampleWiseStratifiedBiPartitionSamplingConfig
      • OutputWiseStratifiedBiPartitionSamplingConfig
      • RandomBiPartitionSamplingConfig
    • mlrl.common.cython.post_optimization module
      • SequentialPostOptimizationConfig
    • mlrl.common.cython.prediction module
      • BinaryPredictor
      • IncrementalBinaryPredictor
      • IncrementalProbabilityPredictor
      • IncrementalScorePredictor
      • IncrementalSparseBinaryPredictor
      • ProbabilityPredictor
      • ScorePredictor
      • SparseBinaryPredictor
    • mlrl.common.cython.probability_calibration module
      • IsotonicJointProbabilityCalibrationModel
      • IsotonicMarginalProbabilityCalibrationModel
      • IsotonicProbabilityCalibrationModel
      • IsotonicProbabilityCalibrationModelVisitor
      • JointProbabilityCalibrationModel
      • MarginalProbabilityCalibrationModel
      • NoJointProbabilityCalibrationModel
      • NoMarginalProbabilityCalibrationModel
      • NoProbabilityCalibrationModel
    • mlrl.common.cython.regression_matrix module
      • CContiguousRegressionMatrix
      • CsrRegressionMatrix
      • RowWiseRegressionMatrix
    • mlrl.common.cython.rule_induction module
      • BeamSearchTopDownRuleInductionConfig
      • GreedyTopDownRuleInductionConfig
    • mlrl.common.cython.rule_model module
      • CompleteHead
      • ConjunctiveBody
      • EmptyBody
      • PartialHead
      • RuleList
      • RuleModel
      • RuleModelVisitor
    • mlrl.common.cython.stopping_criterion module
      • AggregationFunction
      • AggregationFunctionImpl
      • PostPruningConfig
      • PrePruningConfig
      • SizeStoppingCriterionConfig
      • TimeStoppingCriterionConfig
    • mlrl.common.cython.validation module
      • assert_greater()
      • assert_greater_or_equal()
      • assert_less()
      • assert_less_or_equal()
      • assert_multiple()
      • assert_not_none()

Submodules

• mlrl.common.arrays module
  • SparseFormat
    • SparseFormat.COO
    • SparseFormat.CSC
    • SparseFormat.CSR
    • SparseFormat.DOK
    • SparseFormat.LIL
  • enforce_2d()
  • enforce_dense()
  • is_coo()
  • is_csc()
  • is_csr()
  • is_dok()
  • is_lil()
  • is_sparse()
  • is_sparse_and_memory_efficient()
• mlrl.common.config module
  • FeatureBinningParameter
  • FeatureSamplingParameter
    • FeatureSamplingParameter.OPTION_NUM_RETAINED
  • FloatParameter
  • GlobalPruningParameter
    • GlobalPruningParameter.AGGREGATION_FUNCTION_ARITHMETIC_MEAN
    • GlobalPruningParameter.AGGREGATION_FUNCTION_MAX
    • GlobalPruningParameter.AGGREGATION_FUNCTION_MIN
    • GlobalPruningParameter.GLOBAL_PRUNING_POST
    • GlobalPruningParameter.GLOBAL_PRUNING_PRE
    • GlobalPruningParameter.OPTION_AGGREGATION_FUNCTION
    • GlobalPruningParameter.OPTION_INTERVAL
    • GlobalPruningParameter.OPTION_MIN_IMPROVEMENT
    • GlobalPruningParameter.OPTION_MIN_RULES
    • GlobalPruningParameter.OPTION_NUM_PAST
    • GlobalPruningParameter.OPTION_NUM_RECENT
    • GlobalPruningParameter.OPTION_REMOVE_UNUSED_RULES
    • GlobalPruningParameter.OPTION_STOP_INTERVAL
    • GlobalPruningParameter.OPTION_UPDATE_INTERVAL
  • InstanceSamplingParameter
  • IntParameter
  • NominalParameter
    • NominalParameter.Value
    • NominalParameter.add_to_argument_parser()
    • NominalParameter.add_value()
    • NominalParameter.configure()
  • NumericalParameter
    • NumericalParameter.add_to_argument_parser()
    • NumericalParameter.configure()
  • OutputSamplingParameter
    • OutputSamplingParameter.OUTPUT_SAMPLING_ROUND_ROBIN
  • ParallelPredictionParameter
  • ParallelRuleRefinementParameter
  • ParallelStatisticUpdateParameter
  • Parameter
    • Parameter.add_to_argument_parser()
    • Parameter.argument_name
    • Parameter.configure()
  • PartitionSamplingParameter
    • PartitionSamplingParameter.OPTION_HOLDOUT_SET_SIZE
    • PartitionSamplingParameter.PARTITION_SAMPLING_RANDOM
  • RuleInductionParameter
    • RuleInductionParameter.OPTION_BEAM_WIDTH
    • RuleInductionParameter.OPTION_MAX_CONDITIONS
    • RuleInductionParameter.OPTION_MAX_HEAD_REFINEMENTS
    • RuleInductionParameter.OPTION_MIN_COVERAGE
    • RuleInductionParameter.OPTION_MIN_SUPPORT
    • RuleInductionParameter.OPTION_RECALCULATE_PREDICTIONS
    • RuleInductionParameter.RULE_INDUCTION_TOP_DOWN_BEAM_SEARCH
    • RuleInductionParameter.RULE_INDUCTION_TOP_DOWN_GREEDY
  • RulePruningParameter
    • RulePruningParameter.RULE_PRUNING_IREP
  • SequentialPostOptimizationParameter
    • SequentialPostOptimizationParameter.OPTION_NUM_ITERATIONS
    • SequentialPostOptimizationParameter.OPTION_REFINE_HEADS
  • SizeStoppingCriterionParameter
  • TimeStoppingCriterionParameter
  • configure_argument_parser()
  • configure_rule_learner()
  • create_kwargs_from_parameters()
• mlrl.common.data_types module
• mlrl.common.format module
  • format_dict_keys()
  • format_enum_values()
  • format_iterable()
  • format_set()
• mlrl.common.info module
  • PythonPackageInfo
    • PythonPackageInfo.cpp_libraries
    • PythonPackageInfo.dependencies
    • PythonPackageInfo.package_name
    • PythonPackageInfo.package_version
    • PythonPackageInfo.python_packages
  • get_package_info()
• mlrl.common.mixins module
  • ClassifierMixin
    • ClassifierMixin.fit()
    • ClassifierMixin.predict()
    • ClassifierMixin.predict_proba()
    • ClassifierMixin.set_fit_request()
    • ClassifierMixin.set_predict_proba_request()
    • ClassifierMixin.set_predict_request()
    • ClassifierMixin.set_score_request()
  • IncrementalClassifierMixin
    • IncrementalClassifierMixin.predict_incrementally()
    • IncrementalClassifierMixin.predict_proba_incrementally()
  • IncrementalPredictor
    • IncrementalPredictor.apply_next()
    • IncrementalPredictor.get_num_next()
    • IncrementalPredictor.has_next()
  • IncrementalRegressorMixin
    • IncrementalRegressorMixin.predict_incrementally()
  • NominalFeatureSupportMixin
    • NominalFeatureSupportMixin.nominal_feature_indices
    • NominalFeatureSupportMixin.set_nominal_feature_indices()
  • OrdinalFeatureSupportMixin
    • OrdinalFeatureSupportMixin.ordinal_feature_indices
    • OrdinalFeatureSupportMixin.set_ordinal_feature_indices()
  • RegressorMixin
    • RegressorMixin.fit()
    • RegressorMixin.predict()
    • RegressorMixin.set_fit_request()
    • RegressorMixin.set_predict_request()
    • RegressorMixin.set_score_request()
• mlrl.common.options module
  • BooleanOption
    • BooleanOption.FALSE
    • BooleanOption.TRUE
    • BooleanOption.parse()
  • Options
    • Options.ERROR_MESSAGE_INVALID_OPTION
    • Options.ERROR_MESSAGE_INVALID_SYNTAX
    • Options.create()
    • Options.get_bool()
    • Options.get_float()
    • Options.get_int()
    • Options.get_string()
  • parse_param()
  • parse_param_and_options()
• mlrl.common.rule_learners module
  • ClassificationRuleLearner
    • ClassificationRuleLearner.NativeIncrementalProbabilityPredictor
      • ClassificationRuleLearner.NativeIncrementalProbabilityPredictor.apply_next()
    • ClassificationRuleLearner.NonNativeIncrementalProbabilityPredictor
      • ClassificationRuleLearner.NonNativeIncrementalProbabilityPredictor.apply_next()
    • ClassificationRuleLearner.set_fit_request()
    • ClassificationRuleLearner.set_predict_proba_request()
    • ClassificationRuleLearner.set_predict_request()
    • ClassificationRuleLearner.set_score_request()
  • RegressionRuleLearner
    • RegressionRuleLearner.set_fit_request()
    • RegressionRuleLearner.set_predict_request()
    • RegressionRuleLearner.set_score_request()
  • RuleLearner
    • RuleLearner.NativeIncrementalPredictor
      • RuleLearner.NativeIncrementalPredictor.apply_next()
      • RuleLearner.NativeIncrementalPredictor.get_num_next()
      • RuleLearner.NativeIncrementalPredictor.has_next()
    • RuleLearner.NonNativeIncrementalPredictor
      • RuleLearner.NonNativeIncrementalPredictor.apply_next()
      • RuleLearner.NonNativeIncrementalPredictor.get_num_next()
  • SparsePolicy
    • SparsePolicy.AUTO
    • SparsePolicy.FORCE_DENSE
    • SparsePolicy.FORCE_SPARSE
    • SparsePolicy.parse()
    • SparsePolicy.should_enforce_sparse()
  • convert_into_sklearn_compatible_probabilities()