EasyGraph

Copyright (C) <2020-2024> by DataNET Group, Fudan University

---

• Documentation: https://easy-graph.github.io/
• Source Code: https://github.com/easy-graph/Easy-Graph
• Issue Tracker: https://github.com/easy-graph/Easy-Graph/issues
• PyPI Homepage: https://pypi.org/project/Python-EasyGraph/
• Youtube channel: https://www.youtube.com/@python-easygraph

Introduction

EasyGraph is an open-source network analysis library primarily written in Python. It supports both undirected and directed networks and accommodates various network data formats. EasyGraph includes a comprehensive suite of network analysis algorithms such as community detection, structural hole spanner detection, network embedding, and motif detection. Additionally, it optimizes performance by implementing key components in C++ and utilizing multiprocessing.

👉 For more details, please refer to our documentation page.

News

• [09-27-2024] 🎉 Thanks to our amazing community! EasyGraph has reached 500,000 downloads!
• [09-20-2024] We released EasyGraph 1.4! This version features GPU-powered functions for efficient large network analysis.
• [05-27-2024] We released EasyGraph 1.3! This version has resolved several issues related to hypergraph analysis and visualization.
• [04-09-2024] We released EasyGraph 1.2! This version now fully supports Python 3.12.
• [03-06-2024] We received the Shanghai Open Source Innovation Outstanding Achievement Award (Grand Prize)! News
• [02-05-2024] We released EasyGraph 1.1! This version features hypergraph analysis and learning for higher-order network modeling and representation.
• [08-17-2023] We released EasyGraph 1.0!
• [08-08-2023] Our paper "EasyGraph: A Multifunctional, Cross-Platform, and Effective Library for Interdisciplinary Network Analysis" was accepted by Patterns (Cell Press)!

Stargazers

Install

Supported Versions

3.8 <= Python <= 3.13 is required.

Installation With pip

    $ pip install --upgrade Python-EasyGraph

The conda package is no longer updated or maintained.

If you've previously installed EasyGraph with conda, please uninstall it with conda and reinstall with pip.

Build From Source

If prebuilt EasyGraph wheels are not supported for your platform (OS / CPU arch, check here), or you want to have GPU-based functions enabled, you can build it locally.

Prerequisites

• CMake >= 3.23
• A compiler that fully supports C++11
• CUDA Toolkit 11.8 or later would be preferred (If need GPUs enabled)

Installation

On Linux

    git clone --recursive https://github.com/easy-graph/Easy-Graph
    export EASYGRAPH_ENABLE_GPU="TRUE"  # for users who want to enable GPUs
    pip install ./Easy-Graph

On Windows

    % For Windows users who want to enable GPU-based functions, %
    % you must execute the commands below in cmd but not PowerShell. %
    git clone --recursive https://github.com/easy-graph/Easy-Graph
    set EASYGRAPH_ENABLE_GPU=TRUE   % for users who want to enable GPUs %
    pip install ./Easy-Graph

On macOS

    # Since macOS doesn't support CUDA, we can't have GPUs enabled on macOS
    git clone --recursive https://github.com/easy-graph/Easy-Graph
    pip install ./Easy-Graph

Hint

EasyGraph uses 1.12.1 <= PyTorch < 2.0 for machine learning functions. Note that this does not prevent your from running non-machine learning functions normally, if there is no PyTorch in your environment. But you will receive some warnings which remind you some unavailable modules when they depend on it.

Simple Example

This example demonstrates the general usage of methods in EasyGraph.

  >>> import easygraph as eg
  >>> G = eg.Graph()
  >>> G.add_edges([(1,2), (2,3), (1,3), (3,4), (4,5), (3,5), (5,6)])
  >>> eg.pagerank(G)
  {1: 0.14272233049003707, 2: 0.14272233049003694, 3: 0.2685427766200994, 4: 0.14336430577918527, 5: 0.21634929087322705, 6: 0.0862989657474143}

This is a simple example for the detection of structural hole spanners using the HIS algorithm.

  >>> import easygraph as eg
  >>> G = eg.Graph()
  >>> G.add_edges([(1,2), (2,3), (1,3), (3,4), (4,5), (3,5), (5,6)])
  >>> _, _, H = eg.get_structural_holes_HIS(G, C=[frozenset([1,2,3]), frozenset([4,5,6])])
  >>> H # The structural hole score of each node. Note that node `4` is regarded as the most possible structural hole spanner.
  {1: {0: 0.703948974609375},
   2: {0: 0.703948974609375},
   3: {0: 1.2799804687499998},
   4: {0: 1.519976806640625},
   5: {0: 1.519976806640625},
   6: {0: 0.83595703125}
  }

Citation

If you use EasyGraph in a scientific publication, we kindly request that you cite the following paper:

  @article{gao2023easygraph,
      title={{EasyGraph: A Multifunctional, Cross-Platform, and Effective Library for Interdisciplinary Network Analysis}},
      author={Min Gao and Zheng Li and Ruichen Li and Chenhao Cui and Xinyuan Chen and Bodian Ye and Yupeng Li and Weiwei Gu and Qingyuan Gong and Xin Wang and Yang Chen},
      year={2023},
      journal={Patterns},
      volume={4},
      number={10},
      pages={100839},
  }

📢 If you notice anything unexpected, please open an issue and let us know. If you have any questions or require a specific feature, feel free to discuss them with us. We are motivated to constantly make EasyGraph even better and let more developers benefit!