Skip to main content

A Python package for estimating tail parameters of heavy-tailed distributions, which is useful for analyzing power-law behavior in complex networks.

Project description

tailestim

A Python package for estimating tail parameters of heavy-tailed distributions, which is useful for analyzing power-law behavior in complex networks. Currently in development (alpha version).

PyPI version PyPI status Test CI status GitHub license

[!NOTE] The original estimation implementations are from ivanvoitalov/tail-estimation, which is based on the paper "Scale-free networks well done" (Voitalov et al. 2019). tailestim is a wrapper package that provides a more convenient/modern interface and logging, installable through pip.

Features

  • Multiple estimation methods including Hill, Moments, Kernel, Pickands, and Smooth Hill estimators
  • Double-bootstrap procedure for optimal threshold selection
  • Built-in example datasets

Installation

pip install tailestim

Quick Start

Using Built-in Datasets

from tailestim import TailData
from tailestim import HillEstimator, KernelTypeEstimator, MomentsEstimator

# Load a sample dataset
data = TailData(name='CAIDA_KONECT').data

# Initialize and fit the Hill estimator
estimator = HillEstimator()
estimator.fit(data)

# Get the estimated parameters
result = estimator.get_parameters()
gamma = result['gamma']

# Print full results
print(estimator)

Using degree sequence from networkx graphs

import networkx as nx
from tailestim import HillEstimator, KernelTypeEstimator, MomentsEstimator

# Create or load your network
G = nx.barabasi_albert_graph(10000, 2)
degree = list(dict(G.degree()).values()) # Degree sequence

# Initialize and fit the Hill estimator
estimator = HillEstimator()
estimator.fit(degree)

# Get the estimated parameters
result = estimator.get_parameters()
gamma = result['gamma']

# Print full results
print(estimator)

Available Estimators

The package provides several estimators for tail estimation. For details on parameters that can be specified to each estimator, please refer to the original repository ivanvoitalov/tail-estimation, original paper, or the actual code.

  1. Hill Estimator (HillEstimator)
    • Classical Hill estimator with double-bootstrap for optimal threshold selection
    • Generally recommended for power law analysis
  2. Moments Estimator (MomentsEstimator)
    • Moments-based estimation with double-bootstrap
    • More robust to certain types of deviations from pure power law
  3. Kernel-type Estimator (KernelEstimator)
    • Kernel-based estimation with double-bootstrap and bandwidth selection
  4. Pickands Estimator (PickandsEstimator)
    • Pickands-based estimation (no bootstrap)
    • Provides arrays of estimates across different thresholds
  5. Smooth Hill Estimator (SmoothHillEstimator)
    • Smoothed version of the Hill estimator (no bootstrap)

Results

The full result can be obtained by estimator.get_parameters(), which returns a dictionary. This includes:

  • gamma: Power law exponent (γ = 1 + 1/ξ)
  • xi_star: Tail index (ξ)
  • k_star: Optimal order statistic
  • Bootstrap results (when applicable):
    • First and second bootstrap AMSE values
    • Optimal bandwidths or minimum AMSE fractions

Example Output

When you print(estimator) after fitting, you will get the following output.

==================================================
Tail Estimation Results (HillEstimator)
==================================================

Parameters:
--------------------
Optimal order statistic (k*): 26708
Tail index (ξ): 0.3974
Gamma (powerlaw exponent) (γ): 3.5167

Bootstrap Results:
--------------------
First bootstrap minimum AMSE fraction: 0.2744
Second bootstrap minimum AMSE fraction: 0.2745

Built-in Datasets

The package includes several example datasets:

  • CAIDA_KONECT
  • Libimseti_in_KONECT
  • Pareto (Follows power-law with $\gamma=2.5$)

Load any example dataset using:

from tailestim import TailData
data = TailData(name='dataset_name').data

Loaded data

References

Citations

If you use tailestim in your research or projects, I would greatly appreciate if you could cite this package, the original implementation, and the original paper (Voitalov et al. 2019).

@article{voitalov2019scalefree,
  title = {Scale-free networks well done},
  author = {Voitalov, Ivan and van der Hoorn, Pim and van der Hofstad, Remco and Krioukov, Dmitri},
  journal = {Phys. Rev. Res.},
  volume = {1},
  issue = {3},
  pages = {033034},
  numpages = {30},
  year = {2019},
  month = {Oct},
  publisher = {American Physical Society},
  doi = {10.1103/PhysRevResearch.1.033034},
  url = {https://link.aps.org/doi/10.1103/PhysRevResearch.1.033034}
}

@software{voitalov2018tailestimation,
  author       = {Voitalov, Ivan},
  title        = {tail-estimation},
  month        = mar,
  year         = 2018,
  publisher    = {GitHub},
  url          = {https://github.com/ivanvoitalov/tail-estimation}
}

@software{ueda2025tailestim,
  author       = {Ueda, Minami},
  title        = {tailestim: A Python package for estimating tail parameters of heavy-tailed distributions},
  month        = mar,
  year         = 2025,
  publisher    = {GitHub},
  url          = {https://github.com/mu373/tailestim}
}

License

tailestim is distributed under the terms of the MIT license.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

tailestim-0.1.5.tar.gz (74.0 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

tailestim-0.1.5-py3-none-any.whl (72.8 kB view details)

Uploaded Python 3

File details

Details for the file tailestim-0.1.5.tar.gz.

File metadata

  • Download URL: tailestim-0.1.5.tar.gz
  • Upload date:
  • Size: 74.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for tailestim-0.1.5.tar.gz
Algorithm Hash digest
SHA256 1ac22d22b0f149cca4b5f526824a7ac38d9a79acc6281dd3784fb00689720918
MD5 107d204ad00f2e656ce56662cce595e8
BLAKE2b-256 772632707a21fa3ea09104b0a089a929a14ad8f0ff2b6cec8644297b0f8d6a9b

See more details on using hashes here.

Provenance

The following attestation bundles were made for tailestim-0.1.5.tar.gz:

Publisher: release.yml on mu373/tailestim

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file tailestim-0.1.5-py3-none-any.whl.

File metadata

  • Download URL: tailestim-0.1.5-py3-none-any.whl
  • Upload date:
  • Size: 72.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for tailestim-0.1.5-py3-none-any.whl
Algorithm Hash digest
SHA256 66cb022ab63d0ef61fce057a4be7e5345eb13f3c5ea47a363e93524fdfe4ff3b
MD5 c2e14d697fe7250fbb6b23604f8af9ad
BLAKE2b-256 cb456548e24f136f5073c685e977388c682c4d0fdd80e6118637a014e798ab98

See more details on using hashes here.

Provenance

The following attestation bundles were made for tailestim-0.1.5-py3-none-any.whl:

Publisher: release.yml on mu373/tailestim

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page