This package encompasses a comprehensive set of tools designed to facilitate benchmark generation for analyzing evolving communities.

These tools are categorized into different functionalities:

  • Groundtruth generation: Enables the generation of interaction graphs alongside groundtruth evolving communities.

  • Metrics computation: Provides descriptive metrics for analyzing evolving communities.

This package offers a python API to generate, manipulate and analyze evolving communities and temporal graphs.

Quickstart

Generate your first groundtruth in 30 seconds!

Step 1: Install the Package

Make sure you have Python installed on your system. You can install the community analysis package by running the following command in your terminal:

pip install -i https://install:mdXqwvz1kw59N3SbU95t@gitlab.imt-atlantique.fr/api/v4/groups/5164/-/packages/pypi/simple dyn-benchmark

Note

This package can be installed with different optional dependencies to unlock full features:

  • pretty: add progress bars to generators

  • all: include all the above optional dependencies

If you want all optional dependencies for instance, do:

pip install -i https://install:mdXqwvz1kw59N3SbU95t@gitlab.imt-atlantique.fr/api/v4/groups/5164/-/packages/pypi/simple 'dyn-benchmark[all]'

Step 2: Generate Groundtruth Benchmark

To generate a groundtruth benchmark for community detection, you can simply run:

from dyn.benchmark.generator.groundtruth_generator import GroundtruthGenerator

generator = GroundtruthGenerator()
groundtruth = generator.generate()

Then you can have a look at the dyn.benchmark.generator.groundtruth_generator.Groundtruth object generated. It contains the following attributes:

  • tcommlist: memberships in a tcommlist format

  • graphs: temporal graph of connections between members

  • events: community events

Contributors

This package is growing continuously and contributions are welcomed. Contributions can come in the form of new features, bug fixes, documentation improvements or any combination thereof.

If you wan to contribute to this package, please read the Contributing guidelines. If you have any new ideas or have found bugs, feel free to create an issue. Finally, any contribution must be proposed for integration as a Merge Request.

Please visit our Gitlab for more details.

License

This software is licensed under the European Union Public Licence (EUPL) v1.2. For more information see this.

Citations

Todo

Add bibtex code block citing the benchmark generator publication