Welcome to GemClus documentation!¶
Welcome and thank you for checking GEMINI out, this really pleasures us.
GEMINI is a clustering-dedicated function derived from information theory that allows to do clustering without hypotheses on the data distributions. We try to provide overall some implementations of small-scale discriminative clustering methods in this package. These methods include small neural networks, logistic regression, decision trees and work from other paper that we will relevant to the discriminative clustering field in the GEMINI spirit.
Contents¶
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 .
Reference¶
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.
