Add an option in check_Xs to return the number of views, samples and features

[pierreablin]

What does this implement/fix? Explain your changes.

This adds an optional parameter return_dimensions in mvlearn.utils.check_Xs so that check_Xs(Xs, return_dimensions=True) returns Xs, n_views, n_samples, n_features.

This is useful since many estimators need to store these dimensions, and it makes it easier than writing e.g. n_features = [X.shape[1] for X in Xs] in each file.

[codecov]

Codecov Report

Merging #235 into master will increase coverage by 0.01%.
The diff coverage is 96.42%.

@@            Coverage Diff             @@
##           master     #235      +/-   ##
==========================================
+ Coverage   95.40%   95.41%   +0.01%     
==========================================
  Files          46       46              
  Lines        2982     2990       +8     
  Branches      585      587       +2     
==========================================
+ Hits         2845     2853       +8     
  Misses         75       75              
  Partials       62       62              

Impacted Files	Coverage Δ
mvlearn/utils/utils.py	90.90% <95.45%> (+1.77%)	⬆️
mvlearn/decomposition/grouppca.py	100.00% <100.00%> (ø)
mvlearn/merge/merge_transformers.py	100.00% <100.00%> (ø)

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 95792e3...b45fbb5. Read the comment docs.

[pierreablin]

I included your comments, thanks.

[agramfort]

@rflperry can you give me write access to repo please?

[agramfort]

thx @pierreablin