You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: .github/PULL_REQUEST_TEMPLATE.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -20,7 +20,7 @@ What types of changes does your code introduce? Put an `x` in all the boxes that
20
20
21
21
## AI Usage Disclosure
22
22
23
-
Please refer to [docs/how-to/ai-policy.md](https://docs.codecarbon.io/how-to/ai_policy/) for detailed guidelines on how to disclose AI usage in your PR. Accurately completing this section is mandatory.
23
+
Please refer to [docs/how-to/ai-policy.md](https://docs.codecarbon.io/latest/how-to/ai_policy/) for detailed guidelines on how to disclose AI usage in your PR. Accurately completing this section is mandatory.
24
24
25
25
-[ ] 🟥 AI-vibecoded: You cannot explain the logic. Car analogy : the car drive by itself, you are outside it and just tell it where to go.
26
26
-[ ] 🟠 AI-generated: Car analogy : the car drive by itself, you are inside and give instructions.
@@ -32,7 +32,7 @@ Go over all the following points, and put an `x` in all the boxes that apply.
32
32
-[ ] My code follows the code style of this project.
33
33
-[ ] My change requires a change to the documentation.
34
34
-[ ] I have updated the documentation accordingly.
35
-
-[ ] I have read the **[docs/how-to/contributing.md](https://docs.codecarbon.io/how-to/contributing/)** document.
35
+
-[ ] I have read the **[docs/how-to/contributing.md](https://docs.codecarbon.io/latest/how-to/contributing/)** document.
Full CLI guide: [CLI tutorial](https://docs.codecarbon.io/tutorials/cli/).
60
+
Full CLI guide: [CLI tutorial](https://docs.codecarbon.io/latest/tutorials/cli/).
61
61
62
62
## Configuration
63
63
@@ -68,34 +68,34 @@ You can configure CodeCarbon using:
68
68
-`CODECARBON_*` environment variables
69
69
- Python arguments (`EmissionsTracker(...)`)
70
70
71
-
Configuration precedence and examples: [configuration guide](https://docs.codecarbon.io/how-to/configuration/).
71
+
Configuration precedence and examples: [configuration guide](https://docs.codecarbon.io/latest/how-to/configuration/).
72
72
73
73
## How it works
74
74
75
75
We created a Python package that estimates your hardware electricity power consumption (GPU + CPU + RAM) and we apply to it the carbon intensity of the region where the computing is done.
We explain more about this calculation in the [**Methodology**](https://docs.codecarbon.io/explanation/methodology/) section of the documentation.
79
+
We explain more about this calculation in the [**Methodology**](https://docs.codecarbon.io/latest/explanation/methodology/) section of the documentation.
80
80
81
81
## Visualize
82
82
83
-
You can visualize your experiment emissions on the [dashboard](https://dashboard.codecarbon.io/) or locally with [carbonboard](https://docs.codecarbon.io/how-to/visualize/).
83
+
You can visualize your experiment emissions on the [dashboard](https://dashboard.codecarbon.io/) or locally with [carbonboard](https://docs.codecarbon.io/latest/how-to/visualize/).
84
84
85
85

86
86
87
87
## Quick links
88
88
89
89
| Section | Description |
90
90
|---------|-------------|
91
-
|[Quickstart](https://docs.codecarbon.io/tutorials/first-tracking/)| Get started in 5 minutes |
Copy file name to clipboardExpand all lines: docs/how-to/ai_policy.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -72,7 +72,7 @@ AI models often hallucinate comments or reinvent existing utilities.
72
72
73
73
If you are an AI agent (GitHub Copilot, CodeRabbit, etc.) reviewing a PR for CodeCarbon, you must follow the repository's dedicated reviewer instructions.
74
74
75
-
The **canonical and up-to-date instructions for AI reviewers** are maintained in [`.github/copilot-instructions.md`](https://docs.codecarbon.io/how-to/agent-instructions/). That document defines:
75
+
The **canonical and up-to-date instructions for AI reviewers** are maintained in [`.github/copilot-instructions.md`](https://docs.codecarbon.io/latest/how-to/agent-instructions/). That document defines:
76
76
77
77
- The expected reviewer persona and responsibilities
78
78
- The checks to perform on PR descriptions, code, tests, and comments
Copy file name to clipboardExpand all lines: docs/how-to/contributing.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -39,7 +39,7 @@
39
39
<!-- TOC --><aname="have-a-question"></a>
40
40
## </a> Have a Question?
41
41
42
-
Please see the [FAQ](https://docs.codecarbon.io/explanation/faq/) for questions.
42
+
Please see the [FAQ](https://docs.codecarbon.io/latest/explanation/faq/) for questions.
43
43
44
44
45
45
<!-- TOC --><aname="found-a-bug"></a>
@@ -148,7 +148,7 @@ To test CodeCarbon, it is useful to stress your computer to make it use its full
148
148
149
149
- 7Zip is often already installed, running it with `7z b` makes a quick CPU test.
150
150
-[GPU-burn](https://github.com/wilicc/gpu-burn) will load test the GPU for a configurable duration.
151
-
- To test the CPU : `stress-ng --cpu 0 --cpu-method matrixprod --metrics-brief --rapl --perf -t 60s` See [our documentation](https://docs.codecarbon.io/how-to/test-on-scaleway/) to install it.
151
+
- To test the CPU : `stress-ng --cpu 0 --cpu-method matrixprod --metrics-brief --rapl --perf -t 60s` See [our documentation](https://docs.codecarbon.io/latest/how-to/test-on-scaleway/) to install it.
152
152
- To do useful computation while testing [Folding At Home](https://foldingathome.org/) is a good option.
153
153
-[OCCT](https://www.ocbase.com/download) is a proprietary tool but free for non-commercial use and available for Windows and Linux.
0 commit comments