Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 0 additions & 31 deletions .github/ISSUE_TEMPLATE/bug_report.md

This file was deleted.

122 changes: 122 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,122 @@
name: Bug report
description: Something in CodeCarbon is not working as expected
labels: ["bug"]
body:
- type: markdown
attributes:
value: |
Thanks for taking the time to file a report.

Before you start: if your emissions look wrong rather than the tool
crashing, please check the
[troubleshooting guide](https://docs.codecarbon.io/latest/how-to/troubleshooting/)
first — many measurement issues are configuration, especially RAPL
permissions on Linux.

- type: textarea
id: what-happened
attributes:
label: What happened?
description: What did you expect, and what did you get instead?
validations:
required: true

- type: textarea
id: reproduce
attributes:
label: Minimal code to reproduce
description: The smallest script that shows the problem.
render: python
validations:
required: true

- type: textarea
id: detect-output
attributes:
label: Output of `codecarbon detect`
description: |
Run `codecarbon detect` in the same environment and paste the full
output. This tells us what hardware and measurement backends
CodeCarbon found, and it answers most questions immediately.
render: shell
validations:
required: true

- type: textarea
id: logs
attributes:
label: Debug log
description: |
Re-run with `EmissionsTracker(log_level="debug")` and paste the
CodeCarbon log output. Warnings about RAPL, CPU detection, or
another running instance are especially relevant.
render: shell
validations:
required: false

- type: input
id: version
attributes:
label: CodeCarbon version
description: "Output of `codecarbon --version`"
placeholder: "3.3.0"
validations:
required: true

- type: input
id: python-version
attributes:
label: Python version
placeholder: "3.12.4"
validations:
required: true

- type: dropdown
id: os
attributes:
label: Operating system
options:
- Linux
- macOS (Apple Silicon)
- macOS (Intel)
- Windows
- Windows (WSL)
- Other
validations:
required: true

- type: dropdown
id: environment
attributes:
label: Where is this running?
options:
- Directly on my machine
- Docker / container
- Virtual machine
- Cloud VM (AWS / GCP / Azure / other)
- HPC cluster / SLURM
- CI pipeline
- Jupyter notebook / Colab
- Other
validations:
required: true

- type: dropdown
id: install-method
attributes:
label: How did you install CodeCarbon?
options:
- pip
- uv
- conda + pip
- from source
- other
validations:
required: true

- type: textarea
id: context
attributes:
label: Anything else?
validations:
required: false
14 changes: 14 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
blank_issues_enabled: false
contact_links:
- name: Question or help getting started
url: https://discord.gg/GS9js2XkJR
about: Ask on Discord — usually the fastest way to get an answer.
- name: Troubleshooting guide
url: https://docs.codecarbon.io/latest/how-to/troubleshooting/
about: Common problems, error messages, and how to fix them.
- name: FAQ
url: https://docs.codecarbon.io/latest/explanation/faq/
about: Accuracy, data sources, platform support, and more.
- name: Documentation
url: https://docs.codecarbon.io/
about: Full documentation.
16 changes: 0 additions & 16 deletions .github/ISSUE_TEMPLATE/documentation_improvement.md

This file was deleted.

26 changes: 26 additions & 0 deletions .github/ISSUE_TEMPLATE/documentation_improvement.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
name: Documentation improvement
description: Report something missing, wrong, or confusing in the documentation
labels: ["documentation"]
body:
- type: input
id: location
attributes:
label: Which page?
description: URL or file path of the page that needs improvement.
placeholder: "https://docs.codecarbon.io/latest/how-to/configuration/"
validations:
required: true

- type: textarea
id: problem
attributes:
label: What is wrong or missing?
validations:
required: true

- type: textarea
id: suggestion
attributes:
label: What would you suggest instead?
validations:
required: false
19 changes: 0 additions & 19 deletions .github/ISSUE_TEMPLATE/feature_request.md

This file was deleted.

35 changes: 35 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
name: Feature request
description: Suggest a capability or improvement for CodeCarbon
labels: ["enhancement"]
body:
- type: textarea
id: goal
attributes:
label: What are you trying to accomplish?
description: |
Describe the goal rather than the implementation — what are you
measuring, and what makes it hard or impossible today?
validations:
required: true

- type: textarea
id: proposal
attributes:
label: What would you like CodeCarbon to do?
validations:
required: true

- type: textarea
id: alternatives
attributes:
label: What have you tried or considered?
description: Workarounds, other tools, or configuration you already tested.
validations:
required: false

- type: textarea
id: context
attributes:
label: Anything else?
validations:
required: false
13 changes: 11 additions & 2 deletions .github/release-drafter.yml
Original file line number Diff line number Diff line change
@@ -1,8 +1,17 @@
# Release drafter configuration https://github.com/release-drafter/release-drafter#configuration
# Emojis were chosen to match the https://gitmoji.carloscuesta.me/

name-template: "v$NEXT_PATCH_VERSION"
tag-template: "v$NEXT_PATCH_VERSION"
name-template: "v$RESOLVED_VERSION"
tag-template: "v$RESOLVED_VERSION"

version-resolver:
major:
labels: [breaking]
minor:
labels: [enhancement, feature]
patch:
labels: [bug, bugfix, fix, refactoring, dependencies]
default: patch

categories:
- title: ":rocket: Features"
Expand Down
62 changes: 62 additions & 0 deletions CITATION.cff
Original file line number Diff line number Diff line change
@@ -0,0 +1,62 @@
cff-version: 1.2.0
message: "If you use this software, please cite it using the metadata from this file."
title: "CodeCarbon: Estimate and track carbon emissions from computing"
abstract: >-
CodeCarbon estimates the electricity consumed by the hardware running your
code and converts it to CO2 emissions using the carbon intensity of the
local electricity grid.
type: software
authors:
- given-names: Benoit
family-names: Courty
- given-names: Victor
family-names: Schmidt
- given-names: Sasha
family-names: Luccioni
- given-names: Boris
family-names: Feld
- given-names: Jérémy
family-names: Lecourt
- given-names: Mathilde
family-names: Léval
- given-names: Luis
family-names: Blanche
- given-names: Alexis
family-names: Cruveiller
- given-names: Aditya
family-names: Joshi
- given-names: Alexis
family-names: Bogroff
- given-names: Hugues
family-names: de Lavoreille
- given-names: Niko
family-names: Laskaris
- given-names: Edoardo
family-names: Abati
- given-names: Douglas
family-names: Blank
- given-names: Ziyao
family-names: Wang
- given-names: Armin
family-names: Catovic
- given-names: Marc
family-names: Alencon
- given-names: Michał
family-names: Stęchły
- given-names: Christian
family-names: Bauer
- given-names: Lucas Otávio N.
family-names: de Araújo
- name: "The CodeCarbon contributors"
repository-code: "https://github.com/mlco2/codecarbon"
url: "https://codecarbon.io"
license: MIT
version: 3.3.0
doi: 10.5281/zenodo.4658424
date-released: 2026-08-04
keywords:
- carbon emissions
- green AI
- sustainable computing
- energy consumption
- machine learning
Loading
Loading