How to cite this repo?

[isaac-chung]

Hi! Wondering if there's a standard way to cite this repo. If there's a bibtex that has been circulating that I missed, please let me know!

CC @vict0rsch @benoit-cty @SaboniAmine

[benoit-cty]

Thanks for asking, we have one for https://github.com/mlco2/impact but I did not find it for CodeCarbon. @sashavor do you know if there is a publication for CodeCarbon ?

@article{lacoste2019quantifying,
  title={Quantifying the Carbon Emissions of Machine Learning},
  author={Lacoste, Alexandre and Luccioni, Alexandra and Schmidt, Victor and Dandres, Thomas},
  journal={arXiv preprint arXiv:1910.09700},
  year={2019}
}

[vict0rsch]

There was another one previously on the Readme but it was removed at some point.

You can find a citation under a variety of formats on Zenodo https://zenodo.org/records/11171501

[isaac-chung]

Thanks! There are 3 links there. Which one would you say is the most suitable?

1. Lacoste et al

@misc{lacoste2021foundation,
      title={Toward Foundation Models for Earth Monitoring: Proposal for a Climate Change Benchmark}, 
      author={Alexandre Lacoste and Evan David Sherwin and Hannah Kerner and Hamed Alemohammad and Björn Lütjens and Jeremy Irvin and David Dao and Alex Chang and Mehmet Gunturkun and Alexandre Drouin and Pau Rodriguez and David Vazquez},
      year={2021},
      eprint={2112.00570},
      archivePrefix={arXiv},
      primaryClass={cs.LG}
}

2. Asikis

@misc{asikis2022multiobjective,
      title={Multi-Objective Optimization for Value-Sensitive and Sustainable Basket Recommendations}, 
      author={Thomas Asikis},
      year={2022},
      eprint={2111.05944},
      archivePrefix={arXiv},
      primaryClass={cs.NE}
}

3. Naidu et al

@misc{naidu2021quantifying,
      title={Towards Quantifying the Carbon Emissions of Differentially Private Machine Learning}, 
      author={Rakshit Naidu and Harshita Diddee and Ajinkya Mulay and Aleti Vardhan and Krithika Ramesh and Ahmed Zamzam},
      year={2021},
      eprint={2107.06946},
      archivePrefix={arXiv},
      primaryClass={cs.CR}
}

[sashavor]

Those are the citations that we refer to. You should cite the one at the bottom of the Zenodo page: Benoit Courty, Victor Schmidt, Goyal-Kamal, MarionCoutarel, Boris Feld, Jérémy Lecourt, LiamConnell, SabAmine, inimaz, supatomic, Mathilde Léval, Luis Blanche, Alexis Cruveiller, ouminasara, Franklin Zhao, Aditya Joshi, Alexis Bogroff, Amine Saboni, Hugues de Lavoreille, … MinervaBooks. (2024). mlco2/codecarbon: v2.4.1 (v2.4.1). Zenodo. https://doi.org/10.5281/zenodo.11171501

…

On Thu, May 16, 2024, 14:39 Isaac Chung ***@***.***> wrote: Thanks! There are 3 links there. Which one would you say is the most suitable? 1. Lacoste et al @misc{lacoste2021foundation, title={Toward Foundation Models for Earth Monitoring: Proposal for a Climate Change Benchmark}, author={Alexandre Lacoste and Evan David Sherwin and Hannah Kerner and Hamed Alemohammad and Björn Lütjens and Jeremy Irvin and David Dao and Alex Chang and Mehmet Gunturkun and Alexandre Drouin and Pau Rodriguez and David Vazquez}, year={2021}, eprint={2112.00570}, archivePrefix={arXiv}, primaryClass={cs.LG} } 2. Asikis @misc{asikis2022multiobjective, title={Multi-Objective Optimization for Value-Sensitive and Sustainable Basket Recommendations}, author={Thomas Asikis}, year={2022}, eprint={2111.05944}, archivePrefix={arXiv}, primaryClass={cs.NE} } 3. Naidu et al @misc{naidu2021quantifying, title={Towards Quantifying the Carbon Emissions of Differentially Private Machine Learning}, author={Rakshit Naidu and Harshita Diddee and Ajinkya Mulay and Aleti Vardhan and Krithika Ramesh and Ahmed Zamzam}, year={2021}, eprint={2107.06946}, archivePrefix={arXiv}, primaryClass={cs.CR} } — Reply to this email directly, view it on GitHub <#550 (reply in thread)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/ADMMIISTHW2LFFND6P7VWEDZCSSINAVCNFSM6AAAAABHX66UPGVHI2DSMVQWIX3LMV43SRDJONRXK43TNFXW4Q3PNVWWK3TUHM4TINJXGYYTG> . You are receiving this because you were mentioned.Message ID: ***@***.***>

[isaac-chung]

Thanks! FYI here's the bibtex in case you want to paste that into the README later.

@software{benoit_courty_2024_11171501,
  author       = {Benoit Courty and
                  Victor Schmidt and
                  Goyal-Kamal and
                  MarionCoutarel and
                  Boris Feld and
                  Jérémy Lecourt and
                  LiamConnell and
                  SabAmine and
                  inimaz and
                  supatomic and
                  Mathilde Léval and
                  Luis Blanche and
                  Alexis Cruveiller and
                  ouminasara and
                  Franklin Zhao and
                  Aditya Joshi and
                  Alexis Bogroff and
                  Amine Saboni and
                  Hugues de Lavoreille and
                  Niko Laskaris and
                  Edoardo Abati and
                  Douglas Blank and
                  Ziyao Wang and
                  Armin Catovic and
                  alencon and
                  Michał Stęchły and
                  Christian Bauer and
                  Lucas-Otavio and
                  JPW and
                  MinervaBooks},
  title        = {mlco2/codecarbon: v2.4.1},
  month        = may,
  year         = 2024,
  publisher    = {Zenodo},
  version      = {v2.4.1},
  doi          = {10.5281/zenodo.11171501},
  url          = {https://doi.org/10.5281/zenodo.11171501}
}

[benoit-cty]

Thanks, I open a PR : #553