Skip to content
This repository was archived by the owner on Jan 8, 2026. It is now read-only.

Commit 80c2827

Browse files
committed
Correct documentation
1 parent dfb75dc commit 80c2827

File tree

1 file changed

+2
-13
lines changed

1 file changed

+2
-13
lines changed

README.rst

Lines changed: 2 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -49,17 +49,6 @@ For interactive visualization during evaluation, add the ``--show-plot`` option:
4949
--pyp-clusters output/clusters_output_pyp.csv \
5050
--show-plot
5151
52-
.. note::
53-
54-
The package comes with sensible defaults, but optimal parameters depend on your dataset:
55-
56-
* Default values: DP (α=0.5, κ=0.3), PYP (α=0.3, κ=0.3, σ=0.3)
57-
* For a dataset of ~7,000 sentences, these values worked well:
58-
* Dirichlet Process: α=15.0, κ=25.0 (formed ~10-20 clusters)
59-
* Pitman-Yor Process: α=12.0, κ=25.0, σ=0.5 (formed ~20-30 clusters)
60-
61-
For guidance on parameter tuning for your specific dataset, see the `Usage Guide <https://clusterium.readthedocs.io/en/latest/usage.html>`_.
62-
6352
Python API Example
6453
------------------
6554

@@ -72,10 +61,10 @@ Python API Example
7261
texts = load_data("your_data.txt")
7362
7463
# Perform clustering with default parameters
75-
dp = DirichletProcess(alpha=0.5, kappa=0.3) # Default parameters
64+
dp = DirichletProcess(alpha=1.0, kappa=0.8)
7665
clusters_dp = dp.fit_predict(texts)
7766
78-
pyp = PitmanYorProcess(alpha=0.3, kappa=0.3, sigma=0.3) # Default parameters
67+
pyp = PitmanYorProcess(alpha=0.8, kappa=0.6, sigma=0.3)
7968
clusters_pyp = pyp.fit_predict(texts)
8069
8170
# Print number of clusters found

0 commit comments

Comments
 (0)