You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+45-10Lines changed: 45 additions & 10 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -10,7 +10,13 @@
10
10
11
11
# tda-mapper
12
12
13
-
**tda-mapper** is a Python library built around the Mapper algorithm, a core technique in Topological Data Analysis (TDA) for extracting topological structure from complex data. Designed for computational efficiency and scalability, it leverages optimized spatial search methods to support high-dimensional datasets. The library is well-suited for integration into machine learning pipelines, unsupervised learning tasks, and exploratory data analysis.
13
+
**tda-mapper** is a Python library built around the Mapper algorithm, a core
14
+
technique in Topological Data Analysis (TDA) for extracting topological
15
+
structure from complex data. Designed for computational efficiency and
16
+
scalability, it leverages optimized spatial search methods to support
17
+
high-dimensional datasets. The library is well-suited for integration into
18
+
machine learning pipelines, unsupervised learning tasks, and exploratory data
Leverages optimized spatial search techniques and parallelization to accelerate the construction of Mapper graphs, supporting the analysis of high-dimensional datasets.
30
+
Leverages optimized spatial search techniques and parallelization to
31
+
accelerate the construction of Mapper graphs, supporting the analysis of
32
+
high-dimensional datasets.
25
33
26
34
-**Scikit-learn integration**
27
35
28
-
Provides custom estimators that are fully compatible with scikit-learn's API, enabling seamless integration into scikit-learn pipelines for tasks such as dimensionality reduction, clustering, and feature extraction.
36
+
Provides custom estimators that are fully compatible with scikit-learn's
37
+
API, enabling seamless integration into scikit-learn pipelines for tasks
38
+
such as dimensionality reduction, clustering, and feature extraction.
29
39
30
40
-**Flexible visualization**
31
41
32
-
Multiple visualization backends supported (e.g., Plotly, Matplotlib) for generating high-quality Mapper graph representations with adjustable layouts and styling.
42
+
Multiple visualization backends supported (e.g., Plotly, Matplotlib) for
43
+
generating high-quality Mapper graph representations with adjustable
44
+
layouts and styling.
33
45
34
46
-**Interactive app**
35
47
36
-
Provides an interactive web-based interface (via Streamlit) for dynamic exploration of Mapper graph structures, offering real-time adjustments to parameters and visualizations.
48
+
Provides an interactive web-based interface (via Streamlit) for dynamic
49
+
exploration of Mapper graph structures, offering real-time adjustments to
50
+
parameters and visualizations.
37
51
38
52
## Background
39
53
40
-
The Mapper algorithm extracts topological features from complex datasets, representing them as graphs that highlight clusters, transitions, and key structural patterns. These insights reveal hidden data relationships and are applicable across diverse fields, including social sciences, biology, and machine learning. For an in-depth overview of Mapper, including its mathematical foundations and practical applications, read [the original paper](https://research.math.osu.edu/tgda/mapperPBG.pdf).
54
+
The Mapper algorithm extracts topological features from complex datasets,
55
+
representing them as graphs that highlight clusters, transitions, and key
56
+
structural patterns. These insights reveal hidden data relationships and are
57
+
applicable across diverse fields, including social sciences, biology, and
58
+
machine learning. For an in-depth overview of Mapper, including its
59
+
mathematical foundations and practical applications, read
60
+
[the original paper](https://research.math.osu.edu/tgda/mapperPBG.pdf).
41
61
42
62
| Step 1 | Step 2 | Step 3 | Step 4 |
43
63
| ------ | ------ | ------ | ------ |
@@ -46,7 +66,13 @@ The Mapper algorithm extracts topological features from complex datasets, repres
46
66
47
67
## Citations
48
68
49
-
If you use **tda-mapper** in your work, please consider citing both the [library](https://doi.org/10.5281/zenodo.10642381), archived in a permanent Zenodo record, and the [paper](https://openreview.net/pdf?id=lTX4bYREAZ), which provides a broader methodological overview. We recommend citing the specific version of the library used in your research, along with the paper. For citation examples, please refer to the [documentation](https://tda-mapper.readthedocs.io/en/main/#citations).
69
+
If you use **tda-mapper** in your work, please consider citing both the
70
+
[library](https://doi.org/10.5281/zenodo.10642381), archived in a permanent
71
+
Zenodo record, and the [paper](https://openreview.net/pdf?id=lTX4bYREAZ),
72
+
which provides a broader methodological overview. We recommend citing the
73
+
specific version of the library used in your research, along with the paper.
Here's a minimal example using the **circles dataset** from `scikit-learn` to demonstrate how to use **tda-mapper**. This example demonstrates how to apply the Mapper algorithm on a synthetic dataset (concentric circles). The goal is to extract a topological graph representation using `PCA` as a lens and `DBSCAN` for clustering. We proceed as follows:
89
+
Here's a minimal example using the **circles dataset** from `scikit-learn` to
90
+
demonstrate how to use **tda-mapper**. This example demonstrates how to apply
91
+
the Mapper algorithm on a synthetic dataset (concentric circles). The goal is
92
+
to extract a topological graph representation using `PCA` as a lens and
Left: the original dataset consisting of two concentric circles with noise, colored by class label. Right: the resulting Mapper graph, built from the PCA projection and clustered using DBSCAN. The two concentric circles are well identified by the connected components in the Mapper graph.
131
+
Left: the original dataset consisting of two concentric circles with noise,
132
+
colored by class label. Right: the resulting Mapper graph, built from the PCA
133
+
projection and clustered using DBSCAN. The two concentric circles are well
134
+
identified by the connected components in the Mapper graph.
or locally on your machine. The first time you run the app locally, you may need to install the required dependencies from the `requirements.txt` file by running
144
+
or locally on your machine. The first time you run the app locally, you may
145
+
need to install the required dependencies from the `requirements.txt` file by
0 commit comments