Skip to main content

Pypy CircleCI Downloads codecov Tests

GEMCLUS - A package for discriminative clustering using GEMINI

The gemclus package provides simple tools to perform discriminative clustering using the generalised mutual information (GEMINI). The package was written to be a scikit-learn compatible extension.

You can find the complete documentation of the package here: https://gemini-clustering.github.io/

The documentation for the latest updates is at: https://gemini-clustering.github.io/main

The official source code can be found here: https://github.com/gemini-clustering/GemClus

Installation

Official package

Use the following instruction for installing the package:

pip install gemclus

The library requires a couple scientific package to run:

  • NumPy
  • Scipy
  • POT
  • Scikit-learn

Latest version

You may download the latest version of the package by installing the content of the repo.

git clone https://github.com/gemini-clustering/GemClus
cd GemClus
pip install .

If this work helped you, please cite our original NeurIPS work:

Ohl, L., Mattei, P. A., Bouveyron, C., Harchaoui, W., Leclercq, M., Droit, A., & Precioso, F.
(2022, October).
Generalised Mutual Information for Discriminative Clustering.
In Advances in Neural Information Processing Systems.

or

@inproceedings{ohl2022generalised,
title={Generalised Mutual Information for Discriminative Clustering},
author={Louis Ohl and Pierre-Alexandre Mattei and Charles Bouveyron and Warith Harchaoui and Micka{\"e}l Leclercq and Arnaud Droit and Frederic Precioso},
booktitle={Advances in Neural Information Processing Systems},
editor={Alice H. Oh and Alekh Agarwal and Danielle Belgrave and Kyunghyun Cho},
year={2022},
url={https://openreview.net/forum?id=0Oy3PiA-aDp}
}

Contributing

We are open to suggestions of models that can be relevant to the discriminative clustering spirit of GemClus.

Acknowledgements

This work has been supported by the French government, through the 3IA Côte d'Azur, Investment in the Future, project managed by the National Research Agency (ANR) with the reference number ANR-19-P3IA-0002. We would also like to thank the France Canada Research Fund (FFCR) for their contribution to the project. This work was partly supported by EU Horizon 2020 project AI4Media, under contract no. 951911.

Also many many thanks to Pierre-Alexandre Mattei, Frederic Precioso and Charles Bouveyron for their contribution in the GEMINI project, as well as Mickaël Leclercq and Arnaud Droit. Special thanks go to Jhonatan Torres for his insights on the development.

Metadata

Release files for gemclus 1.1.1

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

Source distribution (sdist)

Source distribution for gemclus 1.1.1
File Size Uploaded
gemclus-1.1.1.tar.gz 241.9 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for gemclus 1.1.1
File Interpreter ABI Platform
gemclus-1.1.1-cp313-cp313-win_amd64.whl CPython 3.13 CPython 3.13 Windows x86-64 Details

Total release size: 594.7 kB

Release files / gemclus-1.1.1.tar.gz

Download URL gemclus-1.1.1.tar.gz
Size 241.9 kB
Tags Source
SHA-256 checksum
How to use checksums
b563f64b5052e44522d6fbd6d5af7f006ed1b3029be3464dd454e2aed22841c1
BLAKE2b-256 checksum
How to use checksums
1da8c7abe899e0ed680ce9442da10543027bc3c376739da412cc3fd22daef14b
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.1.0 CPython/3.13.5

Release files / gemclus-1.1.1-cp313-cp313-win_amd64.whl

Download URL gemclus-1.1.1-cp313-cp313-win_amd64.whl
Size 352.8 kB
Tags CPython 3.13 Windows x86-64
SHA-256 checksum
How to use checksums
ead16f7b8e316a94a2feaeb2c3bd142321fa918841f3d1982142a51a27c978ff
BLAKE2b-256 checksum
How to use checksums
28b28ff1ed180acbda77b69b2941fc27a869ffc0c64b7993a58ea011a204868b
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.1.0 CPython/3.13.5

Release history Release notifications | RSS feed

This release

1.1.1 This release

2 release files

1.1.0

2 release files

1.0.0

1 release file

0.2.0

1 release file

0.1.1

2 release files

0.1.0

2 release files

0.0.2

2 release files

0.0.1

2 release files

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