Contents Menu Expand Light mode Dark mode Auto light/dark mode Auto light/dark, in light mode Auto light/dark, in dark mode Skip to content
BOOMER 0.10.1
BOOMER 0.10.1

Quickstart

  • Installation
  • Using the Python API
  • Using the Command Line API

User Guide

  • The BOOMER Algorithm
    • Overview of Parameters
  • The SeCo Algorithm
    • Overview of Parameters
  • Command Line API
    • Performance Evaluation
    • Data Pre-Processing
    • Saving and Loading Models
    • Saving and Loading Parameters
    • Output of Experimental Results
    • Overview of Arguments

Developer Guide

  • Project Structure
  • Building from Source
  • Generating the Documentation
  • Coding Standards
  • Python API Reference
    • Package mlrl-seco
      • mlrl.seco.cython package
        • mlrl.seco.cython.heuristic module
        • mlrl.seco.cython.info module
        • mlrl.seco.cython.learner module
        • mlrl.seco.cython.learner_seco module
        • mlrl.seco.cython.lift_function module
        • mlrl.seco.cython.stopping_criterion module
      • mlrl.seco.config module
      • mlrl.seco.info module
      • mlrl.seco.seco_learners module
    • Package mlrl-testbed
      • mlrl.testbed.characteristics module
      • mlrl.testbed.data module
      • mlrl.testbed.data_characteristics module
      • mlrl.testbed.data_splitting module
      • mlrl.testbed.evaluation module
      • mlrl.testbed.experiments module
      • mlrl.testbed.format module
      • mlrl.testbed.info module
      • mlrl.testbed.io module
      • mlrl.testbed.label_vectors module
      • mlrl.testbed.main_boomer module
      • mlrl.testbed.main_seco module
      • mlrl.testbed.model_characteristics module
      • mlrl.testbed.models module
      • mlrl.testbed.output_writer module
      • mlrl.testbed.parameters module
      • mlrl.testbed.persistence module
      • mlrl.testbed.prediction_characteristics module
      • mlrl.testbed.prediction_scope module
      • mlrl.testbed.predictions module
      • mlrl.testbed.probability_calibration module
      • mlrl.testbed.runnables module
    • Package mlrl-boosting
      • mlrl.boosting.cython package
        • mlrl.boosting.cython.head_type module
        • mlrl.boosting.cython.info module
        • mlrl.boosting.cython.label_binning module
        • mlrl.boosting.cython.learner module
        • mlrl.boosting.cython.learner_boomer module
        • mlrl.boosting.cython.post_processor module
        • mlrl.boosting.cython.prediction module
        • mlrl.boosting.cython.probability_calibration module
        • mlrl.boosting.cython.regularization module
      • mlrl.boosting.boosting_learners module
      • mlrl.boosting.config module
      • mlrl.boosting.info module
    • Package mlrl-common
      • mlrl.common.cython package
        • mlrl.common.cython.feature_binning module
        • mlrl.common.cython.feature_info module
        • mlrl.common.cython.feature_matrix module
        • mlrl.common.cython.feature_sampling module
        • mlrl.common.cython.info module
        • mlrl.common.cython.instance_sampling module
        • mlrl.common.cython.label_matrix module
        • mlrl.common.cython.label_sampling module
        • mlrl.common.cython.label_space_info module
        • mlrl.common.cython.learner module
        • mlrl.common.cython.multi_threading module
        • mlrl.common.cython.partition_sampling module
        • mlrl.common.cython.post_optimization module
        • mlrl.common.cython.prediction module
        • mlrl.common.cython.probability_calibration module
        • mlrl.common.cython.rule_induction module
        • mlrl.common.cython.rule_model module
        • mlrl.common.cython.stopping_criterion module
        • mlrl.common.cython.validation module
      • mlrl.common.arrays module
      • mlrl.common.config module
      • mlrl.common.data_types module
      • mlrl.common.format module
      • mlrl.common.info module
      • mlrl.common.learners module
      • mlrl.common.options module
      • mlrl.common.rule_learners module
  • C++ API Reference
    • Library libmlrlseco
      • File confusion_matrix.hpp
      • File decision_list_builder.hpp
      • File dll_exports.hpp
      • File head_type.hpp
      • File head_type_partial.hpp
      • File head_type_single.hpp
      • File heuristic.hpp
      • File heuristic_accuracy.hpp
      • File heuristic_f_measure.hpp
      • File heuristic_laplace.hpp
      • File heuristic_m_estimate.hpp
      • File heuristic_precision.hpp
      • File heuristic_recall.hpp
      • File heuristic_wra.hpp
      • File info.hpp
      • File learner.hpp
      • File learner_seco.hpp
      • File lift_function.hpp
      • File lift_function_kln.hpp
      • File lift_function_no.hpp
      • File lift_function_peak.hpp
      • File matrix_coverage_dense.hpp
      • File predictor_binary_label_wise.hpp
      • File rule_compare_function.hpp
      • File rule_evaluation.hpp
      • File rule_evaluation_label_wise.hpp
      • File rule_evaluation_label_wise_partial.hpp
      • File rule_evaluation_label_wise_single.hpp
      • File statistics.hpp
      • File statistics_label_wise.hpp
      • File statistics_provider_label_wise_dense.hpp
      • File stopping_criterion_coverage.hpp
      • File vector_confusion_matrix_dense.hpp
    • Library libmlrlboosting
      • File blas.hpp
      • File default_rule_auto.hpp
      • File diagonal_iterator.hpp
      • File discretization_function.hpp
      • File discretization_function_probability.hpp
      • File discretization_function_score.hpp
      • File dll_exports.hpp
      • File feature_binning_auto.hpp
      • File head_type.hpp
      • File head_type_auto.hpp
      • File head_type_complete.hpp
      • File head_type_partial_dynamic.hpp
      • File head_type_partial_fixed.hpp
      • File head_type_single.hpp
      • File info.hpp
      • File label_binning.hpp
      • File label_binning_auto.hpp
      • File label_binning_equal_width.hpp
      • File label_binning_no.hpp
      • File lapack.hpp
      • File learner.hpp
      • File learner_boomer.hpp
      • File loss.hpp
      • File loss_example_wise.hpp
      • File loss_example_wise_logistic.hpp
      • File loss_example_wise_squared_error.hpp
      • File loss_example_wise_squared_hinge.hpp
      • File loss_label_wise.hpp
      • File loss_label_wise_logistic.hpp
      • File loss_label_wise_sparse.hpp
      • File loss_label_wise_squared_error.hpp
      • File loss_label_wise_squared_hinge.hpp
      • File math.hpp
      • File matrix_c_contiguous_numeric.hpp
      • File matrix_sparse_set_numeric.hpp
      • File parallel_rule_refinement_auto.hpp
      • File parallel_statistic_update_auto.hpp
      • File partition_sampling_auto.hpp
      • File predictor_binary_auto.hpp
      • File predictor_binary_common.hpp
      • File predictor_binary_example_wise.hpp
      • File predictor_binary_gfm.hpp
      • File predictor_binary_label_wise.hpp
      • File predictor_probability_auto.hpp
      • File predictor_probability_common.hpp
      • File predictor_probability_label_wise.hpp
      • File predictor_probability_marginalized.hpp
      • File predictor_score_common.hpp
      • File predictor_score_label_wise.hpp
      • File probability_calibration_isotonic.hpp
      • File probability_function_chain_rule.hpp
      • File probability_function_joint.hpp
      • File probability_function_logistic.hpp
      • File probability_function_marginal.hpp
      • File regularization.hpp
      • File regularization_manual.hpp
      • File regularization_no.hpp
      • File rule_compare_function.hpp
      • File rule_evaluation.hpp
      • File rule_evaluation_example_wise.hpp
      • File rule_evaluation_example_wise_complete.hpp
      • File rule_evaluation_example_wise_complete_binned.hpp
      • File rule_evaluation_example_wise_partial_dynamic.hpp
      • File rule_evaluation_example_wise_partial_dynamic_binned.hpp
      • File rule_evaluation_example_wise_partial_fixed.hpp
      • File rule_evaluation_example_wise_partial_fixed_binned.hpp
      • File rule_evaluation_label_wise.hpp
      • File rule_evaluation_label_wise_complete.hpp
      • File rule_evaluation_label_wise_complete_binned.hpp
      • File rule_evaluation_label_wise_partial_dynamic.hpp
      • File rule_evaluation_label_wise_partial_dynamic_binned.hpp
      • File rule_evaluation_label_wise_partial_fixed.hpp
      • File rule_evaluation_label_wise_partial_fixed_binned.hpp
      • File rule_evaluation_label_wise_single.hpp
      • File rule_evaluation_label_wise_sparse.hpp
      • File rule_list_builder.hpp
      • File shrinkage_constant.hpp
      • File statistic_format.hpp
      • File statistic_format_auto.hpp
      • File statistic_format_dense.hpp
      • File statistic_format_sparse.hpp
      • File statistics.hpp
      • File statistics_example_wise.hpp
      • File statistics_label_wise.hpp
      • File statistics_provider_example_wise_dense.hpp
      • File statistics_provider_label_wise_dense.hpp
      • File statistics_provider_label_wise_sparse.hpp
      • File transformation_binary.hpp
      • File transformation_binary_example_wise.hpp
      • File transformation_binary_gfm.hpp
      • File transformation_binary_label_wise.hpp
      • File transformation_probability.hpp
      • File transformation_probability_label_wise.hpp
      • File transformation_probability_marginalized.hpp
      • File vector_statistic_example_wise_dense.hpp
      • File vector_statistic_label_wise_dense.hpp
      • File vector_statistic_label_wise_sparse.hpp
      • File view_statistic_example_wise_dense.hpp
    • Library libmlrlcommon
      • File aggregation_function.hpp
      • File array.hpp
      • File binary_forward_iterator.hpp
      • File binned_iterator.hpp
      • File body.hpp
      • File body_conjunctive.hpp
      • File body_empty.hpp
      • File condition.hpp
      • File condition_list.hpp
      • File coverage_mask.hpp
      • File default_rule.hpp
      • File dll_exports.hpp
      • File feature_based_search.hpp
      • File feature_binning.hpp
      • File feature_binning_equal_frequency.hpp
      • File feature_binning_equal_width.hpp
      • File feature_binning_no.hpp
      • File feature_info.hpp
      • File feature_info_equal.hpp
      • File feature_info_mixed.hpp
      • File feature_matrix.hpp
      • File feature_matrix_c_contiguous.hpp
      • File feature_matrix_column_wise.hpp
      • File feature_matrix_csc.hpp
      • File feature_matrix_csr.hpp
      • File feature_matrix_fortran_contiguous.hpp
      • File feature_matrix_row_wise.hpp
      • File feature_sampling.hpp
      • File feature_sampling_no.hpp
      • File feature_sampling_predefined.hpp
      • File feature_sampling_without_replacement.hpp
      • File feature_space.hpp
      • File feature_space_tabular.hpp
      • File feature_subspace.hpp
      • File feature_type.hpp
      • File feature_type_nominal.hpp
      • File feature_type_numerical.hpp
      • File feature_type_ordinal.hpp
      • File feature_vector.hpp
      • File feature_vector_binary.hpp
      • File feature_vector_binned.hpp
      • File feature_vector_equal.hpp
      • File feature_vector_missing.hpp
      • File feature_vector_nominal.hpp
      • File feature_vector_numerical.hpp
      • File feature_vector_ordinal.hpp
      • File global_pruning.hpp
      • File global_pruning_post.hpp
      • File global_pruning_pre.hpp
      • File head.hpp
      • File head_complete.hpp
      • File head_partial.hpp
      • File index_iterator.hpp
      • File index_vector.hpp
      • File index_vector_complete.hpp
      • File index_vector_partial.hpp
      • File indexed_value.hpp
      • File info.hpp
      • File instance_sampling.hpp
      • File instance_sampling_no.hpp
      • File instance_sampling_stratified_example_wise.hpp
      • File instance_sampling_stratified_label_wise.hpp
      • File instance_sampling_with_replacement.hpp
      • File instance_sampling_without_replacement.hpp
      • File interval.hpp
      • File label_matrix.hpp
      • File label_matrix_c_contiguous.hpp
      • File label_matrix_csr.hpp
      • File label_matrix_row_wise.hpp
      • File label_sampling.hpp
      • File label_sampling_no.hpp
      • File label_sampling_round_robin.hpp
      • File label_sampling_without_replacement.hpp
      • File label_space_info.hpp
      • File label_space_info_no.hpp
      • File label_vector.hpp
      • File label_vector_set.hpp
      • File learner.hpp
      • File math.hpp
      • File matrix_c_contiguous.hpp
      • File matrix_dense.hpp
      • File matrix_lil.hpp
      • File matrix_lil_binary.hpp
      • File matrix_sparse_binary.hpp
      • File matrix_sparse_set.hpp
      • File measure_distance.hpp
      • File measure_evaluation.hpp
      • File measure_evaluation_sparse.hpp
      • File memory.hpp
      • File model_builder.hpp
      • File model_builder_intermediate.hpp
      • File multi_threading.hpp
      • File multi_threading_manual.hpp
      • File multi_threading_no.hpp
      • File non_zero_index_forward_iterator.hpp
      • File opencl.hpp
      • File openmp.hpp
      • File partition.hpp
      • File partition_bi.hpp
      • File partition_sampling.hpp
      • File partition_sampling_bi_random.hpp
      • File partition_sampling_bi_stratified_example_wise.hpp
      • File partition_sampling_bi_stratified_label_wise.hpp
      • File partition_sampling_no.hpp
      • File partition_single.hpp
      • File post_optimization.hpp
      • File post_optimization_phase_list.hpp
      • File post_optimization_sequential.hpp
      • File post_optimization_unused_rule_removal.hpp
      • File post_processor.hpp
      • File post_processor_no.hpp
      • File prediction.hpp
      • File prediction_complete.hpp
      • File prediction_evaluated.hpp
      • File prediction_matrix_dense.hpp
      • File prediction_matrix_sparse_binary.hpp
      • File prediction_partial.hpp
      • File predictor.hpp
      • File predictor_binary.hpp
      • File predictor_common.hpp
      • File predictor_probability.hpp
      • File predictor_score.hpp
      • File probability_calibration.hpp
      • File probability_calibration_isotonic.hpp
      • File probability_calibration_joint.hpp
      • File probability_calibration_marginal.hpp
      • File probability_calibration_no.hpp
      • File quality.hpp
      • File random.hpp
      • File refinement.hpp
      • File refinement_comparator_fixed.hpp
      • File refinement_comparator_single.hpp
      • File ring_buffer.hpp
      • File rule_compare_function.hpp
      • File rule_induction.hpp
      • File rule_induction_top_down_beam_search.hpp
      • File rule_induction_top_down_greedy.hpp
      • File rule_list.hpp
      • File rule_model.hpp
      • File rule_model_assemblage.hpp
      • File rule_model_assemblage_sequential.hpp
      • File rule_pruning.hpp
      • File rule_pruning_irep.hpp
      • File rule_pruning_no.hpp
      • File rule_refinement.hpp
      • File rule_refinement_feature_based.hpp
      • File score_processor.hpp
      • File score_vector.hpp
      • File score_vector_binned_dense.hpp
      • File score_vector_dense.hpp
      • File statistics.hpp
      • File statistics_provider.hpp
      • File statistics_subset.hpp
      • File statistics_subset_weighted.hpp
      • File statistics_weighted.hpp
      • File statistics_weighted_immutable.hpp
      • File stopping_criterion.hpp
      • File stopping_criterion_list.hpp
      • File stopping_criterion_size.hpp
      • File stopping_criterion_time.hpp
      • File stratified_sampling_example_wise.hpp
      • File stratified_sampling_label_wise.hpp
      • File strings.hpp
      • File threads.hpp
      • File triple.hpp
      • File tuple.hpp
      • File types.hpp
      • File validation.hpp
      • File vector_bit.hpp
      • File vector_dense.hpp
      • File vector_sparse_array.hpp
      • File vector_sparse_array_binary.hpp
      • File view.hpp
      • File view_composite.hpp
      • File view_functions.hpp
      • File view_matrix.hpp
      • File view_matrix_c_contiguous.hpp
      • File view_matrix_composite.hpp
      • File view_matrix_csc.hpp
      • File view_matrix_csc_binary.hpp
      • File view_matrix_csr.hpp
      • File view_matrix_csr_binary.hpp
      • File view_matrix_dense.hpp
      • File view_matrix_fortran_contiguous.hpp
      • File view_matrix_lil.hpp
      • File view_matrix_sparse.hpp
      • File view_matrix_sparse_binary.hpp
      • File view_matrix_sparse_set.hpp
      • File view_vector.hpp
      • File view_vector_binned.hpp
      • File view_vector_composite.hpp
      • File view_vector_dok_binary.hpp
      • File view_vector_indexed.hpp
      • File weight_sampling.hpp
      • File weight_vector.hpp
      • File weight_vector_bit.hpp
      • File weight_vector_dense.hpp
      • File weight_vector_equal.hpp
      • File weight_vector_out_of_sample.hpp

Further Information

  • References
  • Release Notes
  • Contributors
  • Code of Conduct
  • MIT License
Back to top
View this page

Command Line APIΒΆ

The command line API allows to run experiments using the algorithms provided by this project, without the need to write code. Compared to the section Using the Command Line API, the following sections provide a more detailed description of the functionalities it provides:

  • Performance Evaluation
  • Data Pre-Processing
  • Saving and Loading Models
  • Saving and Loading Parameters
  • Output of Experimental Results
  • Overview of Arguments
Next
Performance Evaluation
Previous
Overview of Parameters
Copyright © 2020-2024, Michael Rapp et al.
Made with Sphinx and @pradyunsg's Furo