Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: release v3.0.0 #216

Merged
merged 12 commits into from
Sep 4, 2024
Prev Previous commit
Next Next commit
feat: add Redundancy Analysis (#212)
  • Loading branch information
nicrie authored Sep 2, 2024
commit 76c4605917213af33cd030b730589f5c1b4daa95
50 changes: 50 additions & 0 deletions docs/api_reference/_autosummary/xeofs.cross.ComplexRDA.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
ComplexRDA
==========

.. currentmodule:: xeofs.cross

.. autoclass:: ComplexRDA
:members:
:inherited-members:


.. automethod:: __init__


.. rubric:: Methods

.. autosummary::

~ComplexRDA.__init__
~ComplexRDA.components
~ComplexRDA.components_amplitude
~ComplexRDA.components_phase
~ComplexRDA.compute
~ComplexRDA.correlation_coefficients_X
~ComplexRDA.correlation_coefficients_Y
~ComplexRDA.cross_correlation_coefficients
~ComplexRDA.deserialize
~ComplexRDA.fit
~ComplexRDA.fraction_variance_X_explained_by_X
~ComplexRDA.fraction_variance_Y_explained_by_X
~ComplexRDA.fraction_variance_Y_explained_by_Y
~ComplexRDA.get_params
~ComplexRDA.get_serialization_attrs
~ComplexRDA.heterogeneous_patterns
~ComplexRDA.homogeneous_patterns
~ComplexRDA.inverse_transform
~ComplexRDA.load
~ComplexRDA.predict
~ComplexRDA.save
~ComplexRDA.scores
~ComplexRDA.scores_amplitude
~ComplexRDA.scores_phase
~ComplexRDA.serialize
~ComplexRDA.squared_covariance_fraction
~ComplexRDA.transform






50 changes: 50 additions & 0 deletions docs/api_reference/_autosummary/xeofs.cross.HilbertRDA.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
HilbertRDA
==========

.. currentmodule:: xeofs.cross

.. autoclass:: HilbertRDA
:members:
:inherited-members:


.. automethod:: __init__


.. rubric:: Methods

.. autosummary::

~HilbertRDA.__init__
~HilbertRDA.components
~HilbertRDA.components_amplitude
~HilbertRDA.components_phase
~HilbertRDA.compute
~HilbertRDA.correlation_coefficients_X
~HilbertRDA.correlation_coefficients_Y
~HilbertRDA.cross_correlation_coefficients
~HilbertRDA.deserialize
~HilbertRDA.fit
~HilbertRDA.fraction_variance_X_explained_by_X
~HilbertRDA.fraction_variance_Y_explained_by_X
~HilbertRDA.fraction_variance_Y_explained_by_Y
~HilbertRDA.get_params
~HilbertRDA.get_serialization_attrs
~HilbertRDA.heterogeneous_patterns
~HilbertRDA.homogeneous_patterns
~HilbertRDA.inverse_transform
~HilbertRDA.load
~HilbertRDA.predict
~HilbertRDA.save
~HilbertRDA.scores
~HilbertRDA.scores_amplitude
~HilbertRDA.scores_phase
~HilbertRDA.serialize
~HilbertRDA.squared_covariance_fraction
~HilbertRDA.transform






46 changes: 46 additions & 0 deletions docs/api_reference/_autosummary/xeofs.cross.RDA.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
RDA
===

.. currentmodule:: xeofs.cross

.. autoclass:: RDA
:members:
:inherited-members:


.. automethod:: __init__


.. rubric:: Methods

.. autosummary::

~RDA.__init__
~RDA.components
~RDA.compute
~RDA.correlation_coefficients_X
~RDA.correlation_coefficients_Y
~RDA.cross_correlation_coefficients
~RDA.deserialize
~RDA.fit
~RDA.fraction_variance_X_explained_by_X
~RDA.fraction_variance_Y_explained_by_X
~RDA.fraction_variance_Y_explained_by_Y
~RDA.get_params
~RDA.get_serialization_attrs
~RDA.heterogeneous_patterns
~RDA.homogeneous_patterns
~RDA.inverse_transform
~RDA.load
~RDA.predict
~RDA.save
~RDA.scores
~RDA.serialize
~RDA.squared_covariance_fraction
~RDA.transform






3 changes: 3 additions & 0 deletions docs/api_reference/cross_set_analysis.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,12 +10,15 @@ Methods that investigate relationships or patterns between variables **across tw

~xeofs.cross.CCA
~xeofs.cross.MCA
~xeofs.cross.RDA
~xeofs.cross.CPCCA
~xeofs.cross.ComplexCCA
~xeofs.cross.ComplexMCA
~xeofs.cross.ComplexRDA
~xeofs.cross.ComplexCPCCA
~xeofs.cross.HilbertCCA
~xeofs.cross.HilbertMCA
~xeofs.cross.HilbertRDA
~xeofs.cross.HilbertCPCCA

------------------------------
Expand Down
Loading