Skip to main content

A package for performing discriminative clustering with gemini-trained models

Project description

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 .

Related paper

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.

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

gemclus-1.1.1.tar.gz (241.9 kB view details)

Uploaded Source

Built Distribution

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

gemclus-1.1.1-cp313-cp313-win_amd64.whl (352.8 kB view details)

Uploaded CPython 3.13Windows x86-64

File details

Details for the file gemclus-1.1.1.tar.gz.

File metadata

  • Download URL: gemclus-1.1.1.tar.gz
  • Upload date:
  • Size: 241.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.5

File hashes

Hashes for gemclus-1.1.1.tar.gz
Algorithm Hash digest
SHA256 b563f64b5052e44522d6fbd6d5af7f006ed1b3029be3464dd454e2aed22841c1
MD5 be16f0b319337e82805f05947dfe9eab
BLAKE2b-256 1da8c7abe899e0ed680ce9442da10543027bc3c376739da412cc3fd22daef14b

See more details on using hashes here.

File details

Details for the file gemclus-1.1.1-cp313-cp313-win_amd64.whl.

File metadata

  • Download URL: gemclus-1.1.1-cp313-cp313-win_amd64.whl
  • Upload date:
  • Size: 352.8 kB
  • Tags: CPython 3.13, Windows x86-64
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.5

File hashes

Hashes for gemclus-1.1.1-cp313-cp313-win_amd64.whl
Algorithm Hash digest
SHA256 ead16f7b8e316a94a2feaeb2c3bd142321fa918841f3d1982142a51a27c978ff
MD5 ee905d246a82edb5f975ad0921662853
BLAKE2b-256 28b28ff1ed180acbda77b69b2941fc27a869ffc0c64b7993a58ea011a204868b

See more details on using hashes here.

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