From 8e30793fc555e216503562b8991706efcdf4ced2 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?R=C3=A9mi=20Flamary?= Date: Thu, 28 Nov 2024 09:39:28 +0100 Subject: [PATCH 1/4] add cff --- CITATIONS.cff | 84 +++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 84 insertions(+) create mode 100644 CITATIONS.cff diff --git a/CITATIONS.cff b/CITATIONS.cff new file mode 100644 index 000000000..3d459d08d --- /dev/null +++ b/CITATIONS.cff @@ -0,0 +1,84 @@ +cff-version: 1.2.0 +title: POT Python Optimal Transport +message: >- + If you use this software, please cite it using the + metadata from this file. +type: software +authors: + - given-names: Rémi + family-names: Flamary + affiliation: École Polytechnique + orcid: 'https://orcid.org/0000-0002-4212-6627' + - given-names: Cédric + family-names: Vincent-Cuaz + affiliation: EPFL + - given-names: Nicolas + family-names: Courty + affiliation: Université Bretagne Sud + - given-names: Alexandre + family-names: Gramfort + affiliation: INRIA + - given-names: Oleksii + family-names: Kachaiev + affiliation: Università degli Studi di Genova + - given-names: Huy + family-names: Quang Tran + affiliation: Université Bretagne Sud + - given-names: Laurène + family-names: David + affiliation: Institut Polytechnique de Paris + - given-names: Clément + family-names: Bonet + affiliation: ENSAE - CREST + - given-names: Nathan + family-names: Cassereau + affiliation: IDRIS-CNRS + - given-names: Théo + family-names: Gnassounou + affiliation: INRIA + - given-names: Eloi + family-names: Tanguy + affiliation: Université Paris-Cité + - given-names: Julie + family-names: Delon + affiliation: Université Paris-Cité + - given-names: Antoine + family-names: Collas + affiliation: INRIA + - given-names: Sonia + family-names: Mazelet + affiliation: Ecole Polytechnique + - given-names: Laetitia + family-names: Chapel + affiliation: Institut Agro Rennes-Angers, IRISA + - given-names: Tanguy + family-names: Kerdoncuff + affiliation: Université de Lyon + - given-names: Xizheng + family-names: Yu + affiliation: Brown University + - given-names: Matthew + family-names: Feickert + affiliation: University of Wisconsin-Madison + - given-names: Paul + family-names: Krzakala + affiliation: Telecom Paris + - given-names: Tianlin + family-names: Liu + affiliation: University of Basel + - given-names: Eduardo + family-names: Fernandes Montesuma + affiliation: Université Paris-Saclay & CEA-List + orcid: 'https://orcid.org/0000-0003-3850-4602' + +identifiers: + - type: url + value: 'https://github.com/PythonOT/POT' + description: Code +repository-code: 'https://github.com/PythonOT/POT' +url: 'https://pythonot.github.io/' +keywords: + - optimal transport + - python +license: MIT +version: 0.9.5 From aa80d9dac001d9321be8ac937d785332c9d7a85c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?R=C3=A9mi=20Flamary?= Date: Thu, 28 Nov 2024 09:48:11 +0100 Subject: [PATCH 2/4] update --- CITATIONS.cff | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/CITATIONS.cff b/CITATIONS.cff index 3d459d08d..ac57f610a 100644 --- a/CITATIONS.cff +++ b/CITATIONS.cff @@ -1,3 +1,5 @@ +# CFF file for POT contributors + cff-version: 1.2.0 title: POT Python Optimal Transport message: >- @@ -70,7 +72,6 @@ authors: family-names: Fernandes Montesuma affiliation: Université Paris-Saclay & CEA-List orcid: 'https://orcid.org/0000-0003-3850-4602' - identifiers: - type: url value: 'https://github.com/PythonOT/POT' @@ -80,5 +81,8 @@ url: 'https://pythonot.github.io/' keywords: - optimal transport - python + - sinkhorn + - wasserstein + - gromov-wasserstein license: MIT version: 0.9.5 From 05fbfd1982f70d9261b6c142919e5cfb8d6db161 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?R=C3=A9mi=20Flamary?= Date: Thu, 28 Nov 2024 10:15:37 +0100 Subject: [PATCH 3/4] update reame --- CITATIONS.cff => CITATION.cff | 0 README.md | 19 ++++++++++++++----- 2 files changed, 14 insertions(+), 5 deletions(-) rename CITATIONS.cff => CITATION.cff (100%) diff --git a/CITATIONS.cff b/CITATION.cff similarity index 100% rename from CITATIONS.cff rename to CITATION.cff diff --git a/README.md b/README.md index 89e16b508..b98cf88c8 100644 --- a/README.md +++ b/README.md @@ -72,16 +72,25 @@ Some other examples are available in the [documentation](https://pythonot.githu #### Using and citing the toolbox If you use this toolbox in your research and find it useful, please cite POT -using the following reference from our [JMLR paper](https://jmlr.org/papers/v22/20-451.html): +using the following references from the current version and from our [JMLR +paper](https://jmlr.org/papers/v22/20-451.html): - Rémi Flamary, Nicolas Courty, Alexandre Gramfort, Mokhtar Z. Alaya, Aurélie Boisbunon, Stanislas Chambon, Laetitia Chapel, Adrien Corenflos, Kilian Fatras, Nemo Fournier, Léo Gautheron, Nathalie T.H. Gayraud, Hicham Janati, Alain Rakotomamonjy, Ievgen Redko, Antoine Rolet, Antony Schutz, Vivien Seguy, Danica J. Sutherland, Romain Tavenard, Alexander Tong, Titouan Vayer, - POT Python Optimal Transport library, - Journal of Machine Learning Research, 22(78):1−8, 2021. - Website: https://pythonot.github.io/ + Flamary R., Vincent-Cuaz C., Courty N., Gramfort A., Kachaiev O., Quang Tran H., David L., Bonet C., Cassereau N., Gnassounou T., Tanguy E., Delon J., Collas A., Mazelet S., Chapel L., Kerdoncuff T., Yu X., Feickert M., Krzakala P., Liu T., Fernandes Montesuma E. POT Python Optimal Transport (version 0.9.5). URL: https://github.com/PythonOT/POT + + + Rémi Flamary, Nicolas Courty, Alexandre Gramfort, Mokhtar Z. Alaya, Aurélie Boisbunon, Stanislas Chambon, Laetitia Chapel, Adrien Corenflos, Kilian Fatras, Nemo Fournier, Léo Gautheron, Nathalie T.H. Gayraud, Hicham Janati, Alain Rakotomamonjy, Ievgen Redko, Antoine Rolet, Antony Schutz, Vivien Seguy, Danica J. Sutherland, Romain Tavenard, Alexander Tong, Titouan Vayer, POT Python Optimal Transport library, Journal of Machine Learning Research, 22(78):1−8, 2021. URL: https://pythonot.github.io/ In Bibtex format: ```bibtex +@misc{flamary2024pot, + author = {Flamary, R{\'e}mi and Vincent-Cuaz, C{\'e}dric and Courty, Nicolas and Gramfort, Alexandre and Kachaiev, Oleksii and Quang Tran, Huy and David, Laurène and Bonet, Cl{\'e}ment and Cassereau, Nathan and Gnassounou, Th{\'e}o and Tanguy, Eloi and Delon, Julie and Collas, Antoine and Mazelet, Sonia and Chapel, Laetitia and Kerdoncuff, Tanguy and Yu, Xizheng and Feickert, Matthew and Krzakala, Paul and Liu, Tianlin and Fernandes Montesuma, Eduardo}, + title = {POT Python Optimal Transport (version 0.9.5)}, + url = {https://github.com/PythonOT/POT}, + year = {2024} +} + + @article{flamary2021pot, author = {R{\'e}mi Flamary and Nicolas Courty and Alexandre Gramfort and Mokhtar Z. Alaya and Aur{\'e}lie Boisbunon and Stanislas Chambon and Laetitia Chapel and Adrien Corenflos and Kilian Fatras and Nemo Fournier and L{\'e}o Gautheron and Nathalie T.H. Gayraud and Hicham Janati and Alain Rakotomamonjy and Ievgen Redko and Antoine Rolet and Antony Schutz and Vivien Seguy and Danica J. Sutherland and Romain Tavenard and Alexander Tong and Titouan Vayer}, title = {POT: Python Optimal Transport}, From 9d72b24590359e7a53b78b3cd7a98b168bc5d363 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?R=C3=A9mi=20Flamary?= Date: Thu, 28 Nov 2024 10:18:44 +0100 Subject: [PATCH 4/4] shorten ciation --- README.md | 2 -- 1 file changed, 2 deletions(-) diff --git a/README.md b/README.md index b98cf88c8..7bbae9e8a 100644 --- a/README.md +++ b/README.md @@ -77,7 +77,6 @@ paper](https://jmlr.org/papers/v22/20-451.html): Flamary R., Vincent-Cuaz C., Courty N., Gramfort A., Kachaiev O., Quang Tran H., David L., Bonet C., Cassereau N., Gnassounou T., Tanguy E., Delon J., Collas A., Mazelet S., Chapel L., Kerdoncuff T., Yu X., Feickert M., Krzakala P., Liu T., Fernandes Montesuma E. POT Python Optimal Transport (version 0.9.5). URL: https://github.com/PythonOT/POT - Rémi Flamary, Nicolas Courty, Alexandre Gramfort, Mokhtar Z. Alaya, Aurélie Boisbunon, Stanislas Chambon, Laetitia Chapel, Adrien Corenflos, Kilian Fatras, Nemo Fournier, Léo Gautheron, Nathalie T.H. Gayraud, Hicham Janati, Alain Rakotomamonjy, Ievgen Redko, Antoine Rolet, Antony Schutz, Vivien Seguy, Danica J. Sutherland, Romain Tavenard, Alexander Tong, Titouan Vayer, POT Python Optimal Transport library, Journal of Machine Learning Research, 22(78):1−8, 2021. URL: https://pythonot.github.io/ In Bibtex format: @@ -90,7 +89,6 @@ In Bibtex format: year = {2024} } - @article{flamary2021pot, author = {R{\'e}mi Flamary and Nicolas Courty and Alexandre Gramfort and Mokhtar Z. Alaya and Aur{\'e}lie Boisbunon and Stanislas Chambon and Laetitia Chapel and Adrien Corenflos and Kilian Fatras and Nemo Fournier and L{\'e}o Gautheron and Nathalie T.H. Gayraud and Hicham Janati and Alain Rakotomamonjy and Ievgen Redko and Antoine Rolet and Antony Schutz and Vivien Seguy and Danica J. Sutherland and Romain Tavenard and Alexander Tong and Titouan Vayer}, title = {POT: Python Optimal Transport},