PyBMF

A Python library for Boolean Matrix Factorization. Work under Preferred.ai.

PyBMF is under active development. We welcome the authors of BMF papers and those interested in BMF to play around and contribute. Please contact us if you have any questions or suggestions.

Prospectives

Boolean matrix factorization (BMF) is a well-known problem in pattern mining. Throughout the years of prosperous research, it has evolved from greedy heuristics to include a wide range of advanced technologies. We hold the belief that a playground with fairness and adaptiveness is necessary for the development of such algorithms.

PyBMF aims to provide a unified framework with:

1. generators for various types of synthetic data

2. unified ways of importing real-world data

3. data splitting and cross-validation utilities

4. negative sampling utilities for continuous methods

5. the ability to utilize sparse matrices for heuristics

6. evaluation tools for binary and continuous metrics

7. visualization tools for single or multi-matrix data

8. tools for saving and loading models and logs

9. ability to incorporate Boolean matrix simplification and visualization models

Models

Category	Model	Paper	Original Implementation	In PyBMF
Heuristics	Asso	PKDD2006 TKDE2008	C	✅
Heuristics	Hyper/Hyper+	SIGKDD2011		✅
Heuristics	GreConD	JCSS2010	MATLAB	✅
Heuristics	Panda	ICDM2010		✅
Heuristics	Panda+	TKDE2013		✅
Heuristics	NASSAU	SDM2015	link
Heuristics	GreConD+	DAM2018	MATLAB	✅
Heuristics	MEBF	AAAI2020	R	✅
Continuous	NMFSklearn			🛞 Wrapper of sklearn.nmf
Continuous	WNMF			✅ Multiplicative update
Continuous	BinaryMF-Penalty	ICDM2007	MATLAB	✅ Multiplicative update
Continuous	BinaryMF-Thresholding	ICDM2007	MATLAB	✅ Line search
Continuous	FastStep	PAKDD2016	C++	✅ Line search
Continuous	PRIMP	DMKD2017	CUDA C++	✅ PALM
Continuous	PNL-PF	SP2021		✅ Multiplicative update
Continuous	ELBMF	NIPS2022	Julia Python	✅ PALM
Probablistic	MessagePassing	ICML2016	Python	🛞 Wrapper of original implementation
Probablistic	OrMachine	ICLM2017	Cython	🛞 Wrapper of original implementation
Linear Optimization	ColumnGeneration	AAAI2021	Python	🛞 Wrapper of original implementation
Satisfiability	UndercoverBMF	AAAI2021	C++	🛞 Wrapper of original implementation
Simplification	IterEss	IS2019
Simplification	DelegationBMF	AAAI2024	C++
Visualization	OrderedBMF	SIAM2019	C++
Visualization	BiclusterVisualization	PKDD2023	Python

Compatibility

Currently built and tested on Python 3.9.18.

TODO

• [ ] Add mask parameter W to PRIMP and ELBMF

• [ ] Fix DataFrame display utils in dataframe_utils.py

• [ ] Include BMF visualization models

• [ ] Diagnosis of thresholding models

Subpackages

• PyBMF.datasets package
  • Submodules
  • PyBMF.datasets.BaseData module
  • PyBMF.datasets.BaseSplit module
  • PyBMF.datasets.CrossValidation module
  • PyBMF.datasets.MovieLensData module
  • PyBMF.datasets.MovieLensGenreCastData module
  • PyBMF.datasets.MovieLensGenreCastUserData module
  • PyBMF.datasets.MovieLensUserData module
  • PyBMF.datasets.NetflixData module
  • PyBMF.datasets.NetflixGenreCastData module
  • PyBMF.datasets.NoSplit module
  • PyBMF.datasets.RatioSplit module
  • Module contents
• PyBMF.generators package
  • Submodules
  • PyBMF.generators.BaseGenerator module
  • PyBMF.generators.BlockDiagonalMatrixGenerator module
  • PyBMF.generators.BlockMatrixGenerator module
  • PyBMF.generators.SyntheticMatrixGenerator module
  • Module contents
• PyBMF.models package
  • Subpackages
    • PyBMF.models.bmf_mp_ravanba package
      • Submodules
      • PyBMF.models.bmf_mp_ravanba.demo module
      • PyBMF.models.bmf_mp_ravanba.matrix_completion module
      • PyBMF.models.bmf_mp_ravanba.utilities module
      • Module contents
  • Submodules
  • PyBMF.models.Asso module
  • PyBMF.models.AssoExAlternateMultipleWeights module
  • PyBMF.models.AssoIter module
  • PyBMF.models.AssoOpt module
  • PyBMF.models.BMFAlternate module
  • PyBMF.models.BMFCollective module
  • PyBMF.models.BMFInterleave module
  • PyBMF.models.BMFTools module
  • PyBMF.models.BaseCollectiveModel module
  • PyBMF.models.BaseModel module
  • PyBMF.models.BaseModelTools module
  • PyBMF.models.BinaryMFPenalty module
  • PyBMF.models.BinaryMFPenaltyExCollective module
  • PyBMF.models.BinaryMFThreshold module
  • PyBMF.models.BinaryMFThresholdExCollective module
  • PyBMF.models.BinaryMFThresholdExColumnwise module
  • PyBMF.models.BinaryMFThresholdExSigmoid module
  • PyBMF.models.BinaryMFThresholdExSigmoidColumnwise module
  • PyBMF.models.BinaryMFThresholdExSigmoidColumnwiseLamda module
  • PyBMF.models.CMF module
  • PyBMF.models.ContinuousCollectiveModel module
  • PyBMF.models.ContinuousModel module
  • PyBMF.models.ELBMF module
  • PyBMF.models.ELBMFNumPy module
  • PyBMF.models.ELBMFPyTorch module
  • PyBMF.models.FastStep module
  • PyBMF.models.GreConD module
  • PyBMF.models.GreConDPlus module
  • PyBMF.models.Hyper module
  • PyBMF.models.HyperPlus module
  • PyBMF.models.IP module
  • PyBMF.models.MEBF module
  • PyBMF.models.MaxSAT module
  • PyBMF.models.MessagePassing module
  • PyBMF.models.NMFSklearn module
  • PyBMF.models.OrMachine module
  • PyBMF.models.PNLPF module
  • PyBMF.models.PRIMP module
  • PyBMF.models.PRIMPPyTorch module
  • PyBMF.models.Panda module
  • PyBMF.models.RSNMF module
  • PyBMF.models.TransposedModel module
  • PyBMF.models.WNMF module
  • Module contents
• PyBMF.solvers package
  • Submodules
  • PyBMF.solvers.line_search module
  • Module contents
• PyBMF.utils package
  • Submodules
  • PyBMF.utils.boolean_utils module
  • PyBMF.utils.collective_display_utils module
  • PyBMF.utils.collective_evaluate_utils module
  • PyBMF.utils.collective_transform_utils module
  • PyBMF.utils.collective_utils module
  • PyBMF.utils.common module
  • PyBMF.utils.data_utils module
  • PyBMF.utils.dataframe_utils module
  • PyBMF.utils.decorator_utils module
  • PyBMF.utils.display module
  • PyBMF.utils.evaluate_utils module
  • PyBMF.utils.experiment_utils module
  • PyBMF.utils.generator_utils module
  • PyBMF.utils.metrics module
  • PyBMF.utils.sparse_utils module
  • Module contents

Module contents

Indices and tables

• Index

• Module Index

• Search Page