@graphty/algorithms / index / SyncClusteringOptions

Interface: SyncClusteringOptions

Defined in: indexed/sync.ts:8

Options of the index-based SynC clustering, matching the legacy syncClustering.

Properties

lambda?

readonly optional lambda?: number

Defined in: indexed/sync.ts:29

Weight of the neighbor and regularization terms in the reported loss (and its convergence test); default 0.1. The step divides it out, so it does not change the embeddings, except that 0 stops every node where it starts.

---

learningRate?

readonly optional learningRate?: number

Defined in: indexed/sync.ts:24

Fraction of the full step each node takes; default 0.5. The full step (1) moves a node to the mean of its out-neighbors' embeddings. Below 1 every part settles; at 1 a bipartite part swaps sides at every step.

---

maxIterations?

readonly optional maxIterations?: number

Defined in: indexed/sync.ts:12

Iteration cap; default 1000.

---

numClusters

readonly numClusters: number

Defined in: indexed/sync.ts:10

Number of cluster centres: an integer in [1, nodeCount] (legacy rounds a fraction up; the port throws).

---

seed?

readonly optional seed?: number

Defined in: indexed/sync.ts:19

Seed of the embedding initialisation and the centre draws; default 42.

---

tolerance?

readonly optional tolerance?: number

Defined in: indexed/sync.ts:17

Stop when the loss changes by less than this between iterations; default 1e-6. A run also stops once the cluster assignment has stayed the same for 10 iterations in a row.