Mvlearn

-------------

- |Fix| ``CCA`` now only accepts integer arguments for ``n_components``, upper bounded by the minimum number of view features. Previously it accepted options that ``MCCA`` accepted which are only valid for greater than two views. This also had the effect of errors with ``cca.get_stats``. `279 <https://github.com/mvlearn/mvlearn/pull/279>`_ by `Ronan Perry`_.

- |Efficiency| Removed the package dependency on graspy, now called `graspologic <https://microsoft.github.io/graspologic/latest/#>`_, since graspy is no longer being maintained. `306 <https://github.com/mvlearn/mvlearn/pull/306>`_ by `Gavin Mischler`_.

- |API| Due to the removal of the graspy dependency, the ``mvlearn.embed.Omnibus`` class has been removed. The same functionality with a similar API can be found in `graspologic.embed.OmnibusEmbed <https://microsoft.github.io/graspologic/latest/reference/reference/embed.html#multiple-graph-embedding>`_.

- |Fix| An issue in ``CTClassifier`` where the incorrect samples were being removed from the unlabeled_pool has been fixed. `304 <https://github.com/mvlearn/mvlearn/pull/304>`_ by `Gavin Mischler`_.

-------------

- |Efficiency| The 'graspy' package was made an optional dependency in order to reduce the base installation overhead. To use the `Omnibus()` object from `mvlearn.embed`, see the installation guide. `271 <https://github.com/mvlearn/mvlearn/pull/271>`_ by `Ronan Perry`_.

-------------

Updates in this release:

`mvlearn.compose <https://github.com/mvlearn/mvlearn/tree/main/mvlearn/compose>`_
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

- |MajorFeature| Adds an ``mvlearn.compose`` module with Merger and Splitter objects to create single views from multiviews and vice versa: ``ConcatMerger``, ``AverageMerger``, and ``SimpleSplitter``. `228 <https://github.com/mvlearn/mvlearn/pull/228>`_, `#234 <https://github.com/mvlearn/mvlearn/pull/234>`_ by `Pierre Ablin`_.
- |MajorFeature| Adds ``ViewTransformer`` to apply a single view transformer to each view separately. `229 <https://github.com/mvlearn/mvlearn/pull/229>`_ by `Pierre Ablin`_, `#263 <https://github.com/mvlearn/mvlearn/pull/263>`_ by `Ronan Perry`_.
- |MajorFeature| Adds ``ViewClassifier`` to apply a single view classifier to each view separately. `263 <https://github.com/mvlearn/mvlearn/pull/263>`_ by `Ronan Perry`_.
- |Feature| Switches ``random_subspace_method`` and ``random_gaussian_projection`` functions to sklearn-compliant estimators ``RandomSubspaceMethod`` and ``RandomGaussianProjection``. `263 <https://github.com/mvlearn/mvlearn/pull/263>`_ by `Ronan Perry`_.
- |API| The ``mvlearn.construct`` module was merged into ``mvlearn.compose`` due to overlapping functionality. Any imports statements change accordingly. `258 <https://github.com/mvlearn/mvlearn/pull/258>`_ by `Ronan Perry`_.

`mvlearn.construct <https://github.com/mvlearn/mvlearn/tree/main/mvlearn/construct>`_
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

- |API| The ``mvlearn.construct`` module was merged into ``mvlearn.compose`` due to overlapping functionality and no longer exists. Any imports statements change accordingly. `258 <https://github.com/mvlearn/mvlearn/pull/258>`_ by `Ronan Perry`_.

`mvlearn.decomposition <https://github.com/mvlearn/mvlearn/tree/main/mvlearn/decomposition>`_
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

- |Feature| Adds ``GroupICA`` and ``GroupPCA``. `225 <https://github.com/mvlearn/mvlearn/pull/225>`_ by `Pierre Ablin`_ and `Hugo Richard <https://github.com/hugorichard>`_.

`mvlearn.embed <https://github.com/mvlearn/mvlearn/tree/main/mvlearn/embed>`_
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

- |Feature| Adds Multi CCA (``MCCA``) and Kernel MCCA (``KMCCA``) for two or more views. `249 <https://github.com/mvlearn/mvlearn/pull/249>`_ by `Ronan Perry`_ and `Iain Carmichael`_.
- |Feature| Adds CCA, MCCA which requires 2 views but has a variety of interpretable statistics. `261 <https://github.com/mvlearn/mvlearn/pull/251>`_ by `Ronan Perry`_.
- |API| Removes KCCA and moves its functionallity into KMCCA. `261 <https://github.com/mvlearn/mvlearn/pull/251>`_ by `Ronan Perry`_.

`mvlearn.model_selection <https://github.com/mvlearn/mvlearn/tree/main/mvlearn/model_selection>`_
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

- |MajorFeature| Adds an ``model_selection`` module with multiview cross validation. `234 <https://github.com/mvlearn/mvlearn/pull/234>`_ by `Pierre Ablin`_.

- |Feature| Adds the function ``model_selection.train_test_split`` to wrap that of `sklearn <scikit-learn <https://scikit-learn.org/>`_ for multiview data or items. `#174 <https://github.com/mvlearn/mvlearn/pull/174>`_ by `Alexander Chang <https://github.com/achang63>`_ and `Gavin Mischler <https://gavinmischler.github.io/>`_.

`mvlearn.utils <https://github.com/mvlearn/mvlearn/tree/main/mvlearn/utils>`_
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

- |Enhancement| Adds a parameter to utils.check_Xs so that the function also returns the dimensions (n_views, n_samples, n_features) of the input dataset. `235 <https://github.com/mvlearn/mvlearn/pull/235>`_ by `Pierre Ablin`_.

-------------
Updates in this release:

- ``cotraining`` module changed to ``semi_supervised``.
- ``factorization`` module changed to ``decomposition``.
- A new class within the ``semi_supervised`` module, ``CTRegressor``, and regression tool for 2-view semi-supervised learning, following the cotraining framework.
- Three multiview ICA methods added: MultiviewICA, GroupICA, PermICA with ``python-picard`` dependency.
- Added parallelizability to GCCA using joblib and added ``partial_fit`` function to handle streaming or large data.
- Adds a function (get_stats()) to perform statistical tests within the ``embed.KCCA`` class so that canonical correlations and canonical variates can be robustly. assessed for significance. See the documentation in Reference for more details.
- Adds ability to select which views to return from the UCI multiple features dataset loader, ``datasets.UCI_multifeature``.
- API enhancements including base classes for each module and algorithm type, allowing for greater flexibility to extend ``mvlearn``.
- Internals of ``SplitAE`` changed to snake case to fit with the rest of the package.
- Fixes a bug which prevented the ``visualize.crossviews_plot`` from plotting when each view only has a single feature.
- Changes to the ``mvlearn.datasets.gaussian_mixture.GaussianMixture`` parameters to better mimic sklearn's datasets.
- Fixes a bug with printing error messages in a few classes.

-----------
Fixed missing ``__init__.py`` file in the ``ajive_utils`` submodule.

-------------
Updates in this release:

- ``MVMDS`` can now also accept distance matrices as input, rather than only views of data with samples and features
- A new clustering algorithm, ``CoRegMultiviewSpectralClustering`` - co-regularized multi-view spectral clustering functionality
- Some attribute names slightly changed for more intuitive use in ``DCCA``, ``KCCA``, ``MVMDS``, ``CTClassifier``
- Option to use an Incomplete Cholesky Decomposition method for ``KCCA`` to reduce up computation times
- A new module, ``factorization``, containing the ``AJIVE`` algorithm - angle-based joint and individual variance explained
- Fixed issue where signal dimensions of noise were dependent in the GaussianMixtures class
- Added a dependecy to ``joblib`` to enable parallel clustering implementation
- Removed the requirements for ``torchvision`` and ``pillow``, since they are only used in tutorials