summaryrefslogtreecommitdiff
path: root/src/python/doc/cubical_complex_sklearn_itf_ref.rst
diff options
context:
space:
mode:
authorROUVREAU Vincent <vincent.rouvreau@inria.fr>2021-06-07 22:27:38 +0200
committerROUVREAU Vincent <vincent.rouvreau@inria.fr>2021-06-07 22:27:38 +0200
commitf2b8bbccd5cbfa2a0fbb23bdb72e965196a2c05c (patch)
tree8f30bdbca24f76baed391a9090da3cd8dab431ef /src/python/doc/cubical_complex_sklearn_itf_ref.rst
parent0e4040bf4d957630f5b494ac8b4ab573514c3e1c (diff)
Add sklearn like reference documentation
Diffstat (limited to 'src/python/doc/cubical_complex_sklearn_itf_ref.rst')
-rw-r--r--src/python/doc/cubical_complex_sklearn_itf_ref.rst20
1 files changed, 20 insertions, 0 deletions
diff --git a/src/python/doc/cubical_complex_sklearn_itf_ref.rst b/src/python/doc/cubical_complex_sklearn_itf_ref.rst
new file mode 100644
index 00000000..b5c7a2e5
--- /dev/null
+++ b/src/python/doc/cubical_complex_sklearn_itf_ref.rst
@@ -0,0 +1,20 @@
+:orphan:
+
+.. To get rid of WARNING: document isn't included in any toctree
+
+Cubical complex persistence scikit-learn like interfaces reference manual
+#########################################################################
+
+.. list-table::
+ :widths: 40 30 30
+ :header-rows: 0
+
+ * - :Since: GUDHI 3.5.0
+ - :License: MIT
+ - :Requires: `Scikit-learn <installation.html#scikit-learn>`_
+
+
+.. autoclass:: gudhi.sklearn.cubical_persistence.CubicalPersistence
+ :members:
+ :special-members: __init__
+ :show-inheritance: