Skip to content

Commit b17a093

Browse files
committed
Fixed formatting
1 parent 114a64e commit b17a093

File tree

1 file changed

+45
-10
lines changed

1 file changed

+45
-10
lines changed

README.md

Lines changed: 45 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,13 @@
1010

1111
# tda-mapper
1212

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
19+
analysis.
1420

1521
Further details in the
1622
[documentation](https://tda-mapper.readthedocs.io/en/main/)
@@ -21,23 +27,37 @@ and in the
2127

2228
- **Efficient construction**
2329

24-
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.
2533

2634
- **Scikit-learn integration**
2735

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.
2939

3040
- **Flexible visualization**
3141

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.
3345

3446
- **Interactive app**
3547

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.
3751

3852
## Background
3953

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).
4161

4262
| Step 1 | Step 2 | Step 3 | Step 4 |
4363
| ------ | ------ | ------ | ------ |
@@ -46,7 +66,13 @@ The Mapper algorithm extracts topological features from complex datasets, repres
4666

4767
## Citations
4868

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.
74+
For citation examples, please refer to the
75+
[documentation](https://tda-mapper.readthedocs.io/en/main/#citations).
5076

5177
## Quick Start
5278

@@ -60,7 +86,11 @@ pip install tda-mapper
6086

6187
### How to Use
6288

63-
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
93+
`DBSCAN` for clustering. We proceed as follows:
6494

6595
```python
6696
import matplotlib.pyplot as plt
@@ -98,7 +128,10 @@ fig.show(config={"scrollZoom": True})
98128
| ---------------- | ------------ |
99129
| ![Original Dataset](https://github.com/lucasimi/tda-mapper-python/raw/main/resources/circles_dataset_v2.png) | ![Mapper Graph](https://github.com/lucasimi/tda-mapper-python/raw/main/resources/circles_mean_v2.png) |
100130

101-
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.
102135

103136
More examples can be found in the
104137
[documentation](https://tda-mapper.readthedocs.io/en/main/examples.html).
@@ -108,7 +141,9 @@ More examples can be found in the
108141
Use our Streamlit app to visualize and explore your data without writing code.
109142
You can run a live demo directly on
110143
[Streamlit Cloud](https://tda-mapper-app.streamlit.app/),
111-
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
146+
running
112147

113148
```bash
114149
pip install -r app/requirements.txt

0 commit comments

Comments
 (0)