Skip to content

Commit 4386993

Browse files
Added elementary docs for Topeax
1 parent 1587e77 commit 4386993

2 files changed

Lines changed: 18 additions & 0 deletions

File tree

docs/Topeax.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
# Topeax
2+
3+
Topeax is a probabilistic topic model based on the Peax clustering model, which finds topics based on peaks in point density in the embedding space.
4+
It can recover the number of topics automatically.
5+
6+
<br>
7+
<figure>
8+
<img src="../images/peax.png" width="100%" style="margin-left: auto;margin-right: auto;">
9+
<figcaption>Schematic overview of the steps of the Peax clustering algorithm</figcaption>
10+
</figure>
11+
12+
:warning: **This part of the documentation is still under construction, as more details and a paper are on their way.** :warning:
13+
14+
## API Reference
15+
16+
::: turftopic.models.topeax.Topeax
17+
18+
::: turftopic.models.topeax.Peax

docs/images/peax.png

260 KB
Loading

0 commit comments

Comments
 (0)