MatCoupLy

Contents:

  • About MatCoupLy
  • Installing MatCoupLy
  • What are coupled matrix factorizations?
  • Fitting coupled matrix factorization models
  • Gallery of examples
  • Example notebooks
  • API Reference
    • Decomposition class
    • Factorizing a dataset
    • Regularization penalties and constraints
    • Generating random coupled matrix factorizations
    • Example datasets
  • Contribution guidelines
  • References
MatCoupLy
  • API Reference
  • View page source

API Reference

Contents:

  • Decomposition class
    • CoupledMatrixFactorization
    • cmf_to_matrices()
    • cmf_to_matrix()
    • cmf_to_slice()
    • cmf_to_slices()
    • cmf_to_tensor()
    • cmf_to_unfolded()
    • cmf_to_vec()
  • Factorizing a dataset
    • ADMMVars
    • DiagnosticMetrics
    • cmf_aoadmm()
    • compute_feasibility_gaps()
    • parafac2_aoadmm()
  • Regularization penalties and constraints
    • ADMMPenalty
    • Box
    • GeneralizedL2Penalty
    • HardConstraintMixin
    • L1Penalty
    • L2Ball
    • LDSPenalty
    • MatricesPenalty
    • MatrixPenalty
    • NonNegativity
    • Parafac2
    • RowVectorPenalty
    • TemporalSmoothnessPenalty
    • TotalVariationPenalty
    • Unimodality
    • UnitSimplex
  • Generating random coupled matrix factorizations
    • random_coupled_matrices()
  • Example datasets
    • get_bike_data()
    • get_semiconductor_etch_machine_data()
    • get_semiconductor_etch_raw_data()
    • get_simple_simulated_data()
Previous Next

© Copyright 2022, Marie Roald.

Built with Sphinx using a theme provided by Read the Docs.