Skip to content

Commit

Permalink
correct doc for fro_mean_convex (#192)
Browse files Browse the repository at this point in the history
* correct doc for fro_mean_convex

* [pre-commit.ci] auto fixes from pre-commit.com hooks

---------

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
  • Loading branch information
qbarthelemy and pre-commit-ci[bot] authored Oct 5, 2023
1 parent dd41355 commit ee72be2
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 8 deletions.
7 changes: 3 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -65,17 +65,16 @@ variational quantum classifier’, J. High Energ. Phys., vol. 2021, no. 2, p. 21
Classification’, Phys. Rev. Lett., vol. 113, no. 13, p. 130503, Sep. 2014,
https://doi.org/10.1103/PhysRevLett.113.130503

[3] H. Abraham et al., Qiskit: An Open-source Framework for Quantum Computing.
Zenodo, 2019, https://doi.org/10.5281/zenodo.2562110.
[3] H. Abraham et al., Qiskit: An Open-source Framework for Quantum Computing. Zenodo,
2019, https://doi.org/10.5281/zenodo.2562110.

[4] V. Havlíček et al., ‘Supervised learning with quantum-enhanced feature spaces’,
Nature, vol. 567, no. 7747, pp. 209–212, Mar. 2019,
https://doi.org/10.1038/s41586-019-0980-2

[5] G. Cattan, A. Andreev, First steps to the classification of ERPs using quantum
computation, NTB Berlin 2022 - International Forum on Neural Engineering & Brain
Technologies, May 2022, Berlin, Germany,
https://hal.archives-ouvertes.fr/hal-03672246/
Technologies, May 2022, Berlin, Germany, https://hal.archives-ouvertes.fr/hal-03672246/

### How to cite?

Expand Down
8 changes: 4 additions & 4 deletions pyriemann_qiskit/utils/mean.py
Original file line number Diff line number Diff line change
Expand Up @@ -7,11 +7,11 @@
def fro_mean_convex(
covmats, sample_weight=None, optimizer=ClassicalOptimizer(), shrink=True
):
"""Convex formulation of the mean
with frobenius distance.
"""Convex formulation of the mean with Frobenius distance.
Parameters
----------
covmats: ndarray, shape (n_classes, n_channels, n_channels)
covmats: ndarray, shape (n_matrices, n_channels, n_channels)
Set of SPD matrices.
sample_weights: None | ndarray, shape (n_matrices,), default=None
Weights for each matrix. Never used in practice.
Expand All @@ -25,7 +25,7 @@ def fro_mean_convex(
Returns
-------
mean : ndarray, shape (n_channels, n_channels)
Convex-optimized forbenius mean.
Convex-optimized Frobenius mean.
Notes
-----
Expand Down

0 comments on commit ee72be2

Please sign in to comment.