未提供项目描述
项目描述
估算和跟踪您的计算机碳排放，量化和分析其影响。
关于CodeCarbon 💡
CodeCarbon 从一个相当简单的问题开始
我的计算机程序产生的碳足迹影响是什么？ :shrug
我们找到了一些全球数据，例如“计算目前大约占全球能源消耗的0.5%”，但没有关于我们个人/组织层面影响的数据。
在CodeCarbon，我们和尼尔斯·玻尔一样相信，“不测量则不存在”。因此，我们找到了一种方法来估算在运行代码时产生的二氧化碳量。
如何做到呢？
我们创建了一个Python包，用于估算您的硬件电力消耗（GPU + CPU + RAM），并将计算所在地区的碳排放强度应用到它上面。
关于这种计算方法，我们将在文档的方法部分进行更多解释。
我们希望这个包能够被广泛用于估算计算产生的碳足迹，并建立有关披露和减少这一足迹的最佳实践。
准备好“一次运行改变世界”了吗？让我们从一个非常快速的设置开始。
快速入门 🚀
安装 🔧
从PyPI仓库
pip install codecarbon
从Conda仓库
conda install -c conda-forge codecarbon
要查看更多安装选项，请参阅文档：安装
开始估算您的影响 📏
要获取实验_id，请输入
! codecarbon init
现在您可以将它存储在项目根目录下的.codecarbon.config中
[codecarbon]
log_level = DEBUG
save_to_api = True
experiment_id = 2bcbcbb8-850d-4692-af0d-76f6f36d79b2 #the experiment_id you get with init
现在您有两个主要选项
监控您的机器 💻
在您的命令提示符中使用：codecarbon monitor 该包将独立于您的代码跟踪您的排放。
在您的Python代码 🐍 中
from codecarbon import track_emissions
@track_emissions()
def your_function_to_track():
# your code
该包将跟踪您函数执行产生的排放。
还有其他使用 codecarbon 包的方法，请参阅文档了解详细信息：使用
可视化 📊
您现在可以在 仪表板 上可视化您的实验排放。
请注意，目前，所有发送到codecarbon API的排放数据都是公开的。
希望您享受监控您的碳计算影响的第一步！感谢了不起的codecarbon社区 💪🏼，使用 codecarbon 还可以提供更多选项，包括
- 离线模式
- 云模式
- Comet集成...
请探索 文档 了解相关信息。如果您的需求尚未实现，请通过 issues 告诉我们，甚至更好的是，成为我们 🦸🏼♀️🦸🏼♂️ 贡献者！更多信息 👇🏼
贡献 🤝
我们希望开源社区能帮助我们编辑代码，使其更好！
欢迎您提出问题，甚至建议解决方案，更好的是，贡献修复/改进！如果您不确定从哪里开始，但又想帮助我们，我们可以为您提供指导 🥇
为了向我们的代码库贡献更改，请通过GitHub提交一个pull request (PR)，我们团队将审查它并接受它。
查看我们的 贡献指南 :arrow_upper_right:
如果您想定期贡献，请联系 @vict0rsch 以加入我们的Slack工作空间！
如何引用 📝
如果您的研究发现CodeCarbon对您的研究有用，您可以在Zenodo上找到各种格式的引用。
以下是一个BibTeX示例
@software{benoit_courty_2024_11171501,
author = {Benoit Courty and
Victor Schmidt and
Sasha Luccioni and
Goyal-Kamal and
MarionCoutarel and
Boris Feld and
Jérémy Lecourt and
LiamConnell and
Amine Saboni 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
Hugues de Lavoreille and
Niko Laskaris and
Edoardo Abati and
Douglas Blank and
Ziyao Wang and
Armin Catovic and
Marc Alencon and
Michał Stęchły and
Christian Bauer and
Lucas Otávio N. de Araújo 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}
}
联系 📝
维护者是 @vict0rsch @benoit-cty 和 @SaboniAmine。Codecarbon是由来自 Mila 和 DataForGoodFR 社区的志愿者开发的，同时还有来自 Comet.ml 和 BCG GAMMA 的工程师捐赠的专业时间。
下载文件
下载适用于您平台文件的文件。如果您不确定选择哪个，请了解有关 安装包 的更多信息。
