mlrl.common package

This module provides common functionality for rule learning algorithms.

Subpackages

• mlrl.common.config package
  • Submodules
    • mlrl.common.config.parameters module
      • FeatureBinningParameter
      • FeatureSamplingParameter
      • FloatParameter
      • GlobalPruningParameter
      • InstanceSamplingParameter
      • IntParameter
      • NominalParameter
      • NumericalParameter
      • OutputSamplingParameter
      • ParallelPredictionParameter
      • ParallelRuleRefinementParameter
      • ParallelStatisticUpdateParameter
      • Parameter
      • PartitionSamplingParameter
      • RandomStateParameter
      • RuleInductionParameter
      • RulePruningParameter
      • SequentialPostOptimizationParameter
      • SizeStoppingCriterionParameter
      • TimeStoppingCriterionParameter
• mlrl.common.cython package
  • Submodules
    • mlrl.common.cython.example_weights module
      • EqualExampleWeights
      • ExampleWeights
      • RealValuedExampleWeights
    • 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.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
      • RNGMixin
      • 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.package_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.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.rng module
      • RNGConfig
    • mlrl.common.cython.rule_induction module
      • BeamSearchTopDownRuleInductionConfig
      • GreedyTopDownRuleInductionConfig
    • mlrl.common.cython.rule_model module
      • Body
      • Comparator
      • CompleteHead
      • Condition
      • ConjunctiveBody
      • EmptyBody
      • Head
      • PartialHead
      • Prediction
      • Rule
      • RuleList
      • RuleModel
      • RuleModelVisitor
    • mlrl.common.cython.stopping_criterion module
      • AggregationFunction
      • AggregationFunctionImpl
      • PostPruningConfig
      • PrePruningConfig
      • SizeStoppingCriterionConfig
      • TimeStoppingCriterionConfig
• mlrl.common.testbed package
  • Subpackages
    • mlrl.common.testbed.experiments package
      • Subpackages
      • Submodules
  • Submodules
    • mlrl.common.testbed.program_info module
      • RuleLearnerProgramInfo
    • mlrl.common.testbed.runnables module
      • RuleLearnerRunnable

Submodules

• mlrl.common.learners module
  • ClassificationRuleLearner
    • ClassificationRuleLearner.NativeIncrementalProbabilityPredictor
      • ClassificationRuleLearner.NativeIncrementalProbabilityPredictor.apply_next()
    • ClassificationRuleLearner.NonNativeIncrementalProbabilityPredictor
      • ClassificationRuleLearner.NonNativeIncrementalProbabilityPredictor.apply_next()
  • RegressionRuleLearner
  • RuleLearner
    • RuleLearner.KWARG_EXAMPLE_WEIGHTS
    • RuleLearner.KWARG_MAX_RULES
    • RuleLearner.KWARG_SPARSE_FEATURE_VALUE
    • 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.should_enforce_sparse()
  • configure_rule_learner()
  • convert_into_sklearn_compatible_probabilities()
• mlrl.common.mixins module
  • ClassifierMixin
    • ClassifierMixin.KWARG_PREDICT_SCORES
    • ClassifierMixin.fit()
    • ClassifierMixin.predict()
    • ClassifierMixin.predict_proba()
  • 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.KWARG_NOMINAL_FEATURE_INDICES
  • OrdinalFeatureSupportMixin
    • OrdinalFeatureSupportMixin.KWARG_ORDINAL_FEATURE_INDICES
  • RegressorMixin
    • RegressorMixin.fit()
    • RegressorMixin.predict()
• mlrl.common.package_info module
  • PackageInfo
    • PackageInfo.cpp_libraries
    • PackageInfo.dependencies
    • PackageInfo.package_name
    • PackageInfo.package_version
    • PackageInfo.python_packages
  • get_package_info()