Skip to main content
Pre-release

This release is a pre-release and may not be stable for production use.

Chinese Whispers for Python

This is an implementation of the Chinese Whispers clustering algorithm in Python. Since this library is based on NetworkX, it is simple to use.

Unit Tests Read the Docs PyPI Version

Given a NetworkX graph G, this library can cluster it using the following code:

from chinese_whispers import chinese_whispers
chinese_whispers(G, weighting='top', iterations=20)

As the result, each node of the input graph is provided with the label attribute that stores the cluster label.

The library also offers a convenient command-line interface (CLI) for clustering graphs represented in the ABC tab-separated format (source\ttarget\tweight).

# Write karate_club.tsv (just as example)
python3 -c 'import networkx as nx; nx.write_weighted_edgelist(nx.karate_club_graph(), "karate_club.tsv", delimiter="\t")'

# Using as CLI
chinese-whispers karate_club.tsv

# Using as module (same CLI as above)
python3 -mchinese_whispers karate_club.tsv

A more complete usage example is available in the example notebook and at https://nlpub.github.io/chinese-whispers-python/.

In case you require higher performance, please consider our Java implementation that also includes other graph clustering algorithms: https://github.com/nlpub/watset-java.

Citation

@article{Ustalov:19:cl,
  author    = {Ustalov, Dmitry and Panchenko, Alexander and Biemann, Chris and Ponzetto, Simone Paolo},
  title     = {{Watset: Local-Global Graph Clustering with Applications in Sense and Frame Induction}},
  journal   = {Computational Linguistics},
  year      = {2019},
  volume    = {45},
  number    = {3},
  pages     = {423--479},
  doi       = {10.1162/COLI_a_00354},
  publisher = {MIT Press},
  issn      = {0891-2017},
  language  = {english},
}

Copyright (c) 2018–2022 Dmitry Ustalov. See LICENSE for details.

Metadata

Release files for chinese-whispers 0.8.1rc1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for chinese-whispers 0.8.1rc1
File Size Uploaded
chinese_whispers-0.8.1rc1.tar.gz 6.3 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for chinese-whispers 0.8.1rc1
File Interpreter ABI Platform
chinese_whispers-0.8.1rc1-py3-none-any.whl Python 3 none any Details

Total release size: 14.2 kB

Release files / chinese_whispers-0.8.1rc1.tar.gz

Download URL chinese_whispers-0.8.1rc1.tar.gz
Size 6.3 kB
Tags Source
SHA-256 checksum
How to use checksums
edb15da8a4ffc29072c2aef1ea06962809211502325a6c64bd5b3a03addf346a
BLAKE2b-256 checksum
How to use checksums
a48bb4406b6ab682c35e6bce3c6fb2d05782252f2d3c1da7623e9eecc7d1f895
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.1 CPython/3.11.1

Release files / chinese_whispers-0.8.1rc1-py3-none-any.whl

Download URL chinese_whispers-0.8.1rc1-py3-none-any.whl
Size 7.8 kB
Tags Python 3
SHA-256 checksum
How to use checksums
a5e04db4af4657eb073526b202934c5cc4c2447fe3d7a38fd945be4f73c14ad4
BLAKE2b-256 checksum
How to use checksums
9cfe25d86845c1ff724c7c34ba539c496f9f3a48d58717945e126dfc900e2599
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.1 CPython/3.11.1
Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page