Skip to content

Commit a75b8db

Browse files
committed
Add missing blank lines to fix lists
1 parent bcfa2d0 commit a75b8db

3 files changed

Lines changed: 16 additions & 11 deletions

File tree

docs/_sources/methodology.rst.txt

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -237,6 +237,7 @@ CPU metrics priority
237237

238238
CodeCarbon will first try to read the energy consumption of the CPU from low level interface like RAPL or ``powermetrics``.
239239
If none of the tracking tools are available, CodeCarbon will be switched to a fallback mode:
240+
240241
- It will first detect which CPU hardware is currently in use, and then map it to a data source listing 2000+ Intel and AMD CPUs and their corresponding thermal design powers (TDPs).
241242
- If the CPU is not found in the data source, a global constant will be applied.
242243
- If ``psutil`` is available, CodeCarbon will try to estimate the energy consumption from the TDP and the CPU load.
@@ -317,6 +318,7 @@ The equivalent emissions are calculated using this formula:
317318
\text{Equivalent Emissions} = \frac{\text{Total Emissions (kgCO₂)}}{\text{Emission Factor (kgCO₂/unit)}}
318319
319320
For example:
321+
320322
- **Car Usage**: *1 kWh* of energy consumption is approximately equivalent to:
321323

322324
- *8.33 kilometers driven by a car* (*1 ÷ 0.12*).

docs/edit/methodology.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -237,6 +237,7 @@ CPU metrics priority
237237

238238
CodeCarbon will first try to read the energy consumption of the CPU from low level interface like RAPL or ``powermetrics``.
239239
If none of the tracking tools are available, CodeCarbon will be switched to a fallback mode:
240+
240241
- It will first detect which CPU hardware is currently in use, and then map it to a data source listing 2000+ Intel and AMD CPUs and their corresponding thermal design powers (TDPs).
241242
- If the CPU is not found in the data source, a global constant will be applied.
242243
- If ``psutil`` is available, CodeCarbon will try to estimate the energy consumption from the TDP and the CPU load.
@@ -317,6 +318,7 @@ The equivalent emissions are calculated using this formula:
317318
\text{Equivalent Emissions} = \frac{\text{Total Emissions (kgCO₂)}}{\text{Emission Factor (kgCO₂/unit)}}
318319
319320
For example:
321+
320322
- **Car Usage**: *1 kWh* of energy consumption is approximately equivalent to:
321323

322324
- *8.33 kilometers driven by a car* (*1 ÷ 0.12*).

docs/methodology.html

Lines changed: 12 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -308,11 +308,13 @@ <h2>RAPL Metrics<a class="headerlink" href="#rapl-metrics" title="Link to this h
308308
<section id="cpu-metrics-priority">
309309
<h2>CPU metrics priority<a class="headerlink" href="#cpu-metrics-priority" title="Link to this heading"></a></h2>
310310
<p>CodeCarbon will first try to read the energy consumption of the CPU from low level interface like RAPL or <code class="docutils literal notranslate"><span class="pre">powermetrics</span></code>.
311-
If none of the tracking tools are available, CodeCarbon will be switched to a fallback mode:
312-
- It will first detect which CPU hardware is currently in use, and then map it to a data source listing 2000+ Intel and AMD CPUs and their corresponding thermal design powers (TDPs).
313-
- If the CPU is not found in the data source, a global constant will be applied.
314-
- If <code class="docutils literal notranslate"><span class="pre">psutil</span></code> is available, CodeCarbon will try to estimate the energy consumption from the TDP and the CPU load.
315-
- CodeCarbon assumes that 50% of the TDP will be the average power consumption to make this approximation.</p>
311+
If none of the tracking tools are available, CodeCarbon will be switched to a fallback mode:</p>
312+
<ul class="simple">
313+
<li><p>It will first detect which CPU hardware is currently in use, and then map it to a data source listing 2000+ Intel and AMD CPUs and their corresponding thermal design powers (TDPs).</p></li>
314+
<li><p>If the CPU is not found in the data source, a global constant will be applied.</p></li>
315+
<li><p>If <code class="docutils literal notranslate"><span class="pre">psutil</span></code> is available, CodeCarbon will try to estimate the energy consumption from the TDP and the CPU load.</p></li>
316+
<li><p>CodeCarbon assumes that 50% of the TDP will be the average power consumption to make this approximation.</p></li>
317+
</ul>
316318
<p>Here is a drawing of the fallback mode:</p>
317319
<img alt="CPU Fallback" class="align-center" src="_images/cpu_fallback.png" />
318320
<p>The code doing this is available in <a class="reference external" href="https://github.com/mlco2/codecarbon/blob/master/codecarbon/core/resource_tracker.py#L24">codecarbon/core/resource_tracker.py</a>.</p>
@@ -368,15 +370,14 @@ <h3>Calculation Formula<a class="headerlink" href="#calculation-formula" title="
368370
<p>The equivalent emissions are calculated using this formula:</p>
369371
<div class="math notranslate nohighlight">
370372
\[\text{Equivalent Emissions} = \frac{\text{Total Emissions (kgCO₂)}}{\text{Emission Factor (kgCO₂/unit)}}\]</div>
371-
<p>For example:
372-
- <strong>Car Usage</strong>: <em>1 kWh</em> of energy consumption is approximately equivalent to:</p>
373-
<blockquote>
374-
<div><ul class="simple">
373+
<p>For example:</p>
374+
<ul class="simple">
375+
<li><p><strong>Car Usage</strong>: <em>1 kWh</em> of energy consumption is approximately equivalent to:</p>
376+
<ul>
375377
<li><p><em>8.33 kilometers driven by a car</em> (<em>1 ÷ 0.12</em>).</p></li>
376378
<li><p><em>11.9 hours of TV usage</em> (<em>1 ÷ 0.084</em>), if emissions are considered.</p></li>
377379
</ul>
378-
</div></blockquote>
379-
<ul class="simple">
380+
</li>
380381
<li><p><strong>US Citizen Emissions</strong>:</p>
381382
<ul>
382383
<li><p><em>1 kWh</em> of energy consumption can be compared to a fraction of the average weekly emissions of a US citizen:</p></li>

0 commit comments

Comments
 (0)