Skip to content

Commit fb1042f

Browse files
committed
docs: improved styling
1 parent aff0985 commit fb1042f

File tree

1 file changed

+15
-14
lines changed

1 file changed

+15
-14
lines changed

README.md

Lines changed: 15 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -38,17 +38,17 @@
3838

3939
### Distance Metrics
4040

41-
- **Kullback-Leibler** (symmetric & non-symmetric)
42-
- **Jensen-Shannon divergence**
43-
- **Jeffrey's divergence**
44-
- **Hellinger & Bhattacharyya distances**
45-
- **Total variation distance**
46-
- **Jaccard index**
41+
- Kullback-Leibler (symmetric & non-symmetric)
42+
- Jensen-Shannon divergence
43+
- Jeffrey's divergence
44+
- Hellinger & Bhattacharyya distances
45+
- Total variation distance
46+
- Jaccard index
4747

4848
### Dimensionality Reduction
4949

50-
- **t-SNE****SpectralEmbedding****MDS**
51-
- **LocallyLinearEmbedding****Isomap**
50+
- t-SNE • SpectralEmbedding • MDS
51+
- LocallyLinearEmbedding\*\* • Isomap
5252

5353
## Donate
5454

@@ -87,7 +87,7 @@ tmp.plot_scatter_topics(coords, size_col='size')
8787

8888
## Advanced Examples
8989

90-
### Compare Multiple Models
90+
### Get Stable Topics
9191

9292
```python
9393
import tmplot as tmp
@@ -98,7 +98,7 @@ closest_topics, distances = tmp.get_closest_topics(models)
9898
stable_topics, stable_distances = tmp.get_stable_topics(closest_topics, distances)
9999
```
100100

101-
### Model Optimization
101+
### Analyze Model
102102

103103
```python
104104
# Calculate entropy for model selection
@@ -108,7 +108,7 @@ entropy_score = tmp.entropy(phi_matrix)
108108
saliency = tmp.get_salient_terms(phi, theta)
109109
```
110110

111-
### Custom Visualizations
111+
### Visualize
112112

113113
```python
114114
# Create topic distance matrix with different metrics
@@ -121,11 +121,12 @@ tmp.plot_scatter_topics(coords, topic=3) # Highlight topic 3
121121

122122
## Documentation & Examples
123123

124-
- **[Complete Tutorial](https://tmplot.readthedocs.io/en/latest/tutorial.html)** - Step-by-step guide
125-
- **[API Reference](https://tmplot.readthedocs.io/)** - Full documentation
126-
- **[Example Notebooks](https://github.com/maximtrp/tmplot/tree/main/examples)** - Jupyter examples
124+
- [Complete Tutorial](https://tmplot.readthedocs.io/en/latest/tutorial.html) - Step-by-step guide
125+
- [API Reference](https://tmplot.readthedocs.io/) - Full documentation
126+
- [Example Notebooks](https://github.com/maximtrp/tmplot/tree/main/examples) - Jupyter examples
127127

128128
## Requirements
129129

130130
**Core dependencies:** `numpy`, `scipy`, `scikit-learn`, `pandas`, `altair`, `ipywidgets`
131+
131132
**Optional models:** `tomotopy`, `gensim`, `bitermplus`

0 commit comments

Comments
 (0)