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

Prepare for v0.3.0 release #516

Merged
merged 16 commits into from
Oct 8, 2020
Prev Previous commit
Next Next commit
Fix code formatting/naming in the docstrings
  • Loading branch information
wreise committed Oct 7, 2020
commit 597b38ca36e8b04c026a8c7ad205c533fca1f059
6 changes: 6 additions & 0 deletions doc/modules/homology.rst
Original file line number Diff line number Diff line change
@@ -20,6 +20,12 @@ Undirected simplicial homology

Directed simplicial homology
----------------------------
.. currentmodule:: gtda

.. autosummary::
:toctree: generated/homology/
:template: class.rst

homology.FlagserPersistence

Cubical homology
2 changes: 1 addition & 1 deletion gtda/diagrams/features.py
Original file line number Diff line number Diff line change
@@ -697,7 +697,7 @@ def transform(self, X, y=None):
Returns
-------
Xt : ndarray of shape (n_samples, n_homology_dimensions * 2 \
* n_coefficients_)
* n_coefficients)
Polynomial coefficients: real and imaginary parts of the complex
polynomials obtained in each homology dimension from each diagram
in `X`.
2 changes: 1 addition & 1 deletion gtda/diagrams/preprocessing.py
Original file line number Diff line number Diff line change
@@ -471,7 +471,7 @@ def transform(self, X, y=None):
Xt : ndarray of shape (n_samples, n_features_filtered, 3)
Filtered persistence diagrams. Only the subdiagrams corresponding
to dimensions in :attr:`homology_dimensions_` are filtered.
``n_features_filtered`` is less than or equal to ``n_features`.
``n_features_filtered`` is less than or equal to ``n_features``.

"""
check_is_fitted(self)