-
-
Notifications
You must be signed in to change notification settings - Fork 299
Expand file tree
/
Copy pathindex.html
More file actions
237 lines (216 loc) · 13.5 KB
/
Copy pathindex.html
File metadata and controls
237 lines (216 loc) · 13.5 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
<!DOCTYPE html>
<html class="writer-html5" lang="en" data-content_root="./">
<head>
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>CodeCarbon — CodeCarbon 3.2.3 documentation</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=03e43079" />
<link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=9edc463e" />
<script src="_static/jquery.js?v=5d32c60e"></script>
<script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
<script src="_static/documentation_options.js?v=7895512d"></script>
<script src="_static/doctools.js?v=fd6eb6e6"></script>
<script src="_static/sphinx_highlight.js?v=6ffebe34"></script>
<script src="_static/js/theme.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="Motivation" href="motivation.html" />
</head>
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="#" class="icon icon-home">
CodeCarbon
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
<p class="caption" role="heading"><span class="caption-text">Introduction</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="motivation.html">Motivation</a></li>
<li class="toctree-l1"><a class="reference internal" href="methodology.html">Methodology</a></li>
<li class="toctree-l1"><a class="reference internal" href="rapl.html">RAPL Metrics</a></li>
<li class="toctree-l1"><a class="reference internal" href="model_examples.html">Model Comparisons</a></li>
<li class="toctree-l1"><a class="reference internal" href="faq.html">Frequently Asked Questions</a></li>
</ul>
<p class="caption" role="heading"><span class="caption-text">Getting Started</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="installation.html">Installing CodeCarbon</a></li>
<li class="toctree-l1"><a class="reference internal" href="usage.html">Quickstart</a></li>
<li class="toctree-l1"><a class="reference internal" href="usage.html#configuration">Configuration</a></li>
<li class="toctree-l1"><a class="reference internal" href="api.html">CodeCarbon API</a></li>
<li class="toctree-l1"><a class="reference internal" href="parameters.html">Parameters</a></li>
<li class="toctree-l1"><a class="reference internal" href="examples.html">Examples</a></li>
<li class="toctree-l1"><a class="reference internal" href="comet.html">Comet Integration</a></li>
<li class="toctree-l1"><a class="reference internal" href="advanced_installation.html">Advanced Installation</a></li>
</ul>
<p class="caption" role="heading"><span class="caption-text">Logging</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="output.html">Output</a></li>
<li class="toctree-l1"><a class="reference internal" href="to_logger.html">Collecting emissions to a logger</a></li>
<li class="toctree-l1"><a class="reference internal" href="visualize.html">Visualize</a></li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="#">CodeCarbon</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="Page navigation">
<ul class="wy-breadcrumbs">
<li><a href="#" class="icon icon-home" aria-label="Home"></a></li>
<li class="breadcrumb-item active">CodeCarbon</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/index.rst.txt" rel="nofollow"> View page source</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<section id="codecarbon">
<h1>CodeCarbon<a class="headerlink" href="#codecarbon" title="Link to this heading"></a></h1>
<img alt="Banner" class="align-center" src="_images/banner.png" />
<div class="toctree-wrapper compound">
<p class="caption" role="heading"><span class="caption-text">Introduction</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="motivation.html">Motivation</a></li>
<li class="toctree-l1"><a class="reference internal" href="methodology.html">Methodology</a><ul>
<li class="toctree-l2"><a class="reference internal" href="methodology.html#carbon-intensity">Carbon Intensity</a></li>
<li class="toctree-l2"><a class="reference internal" href="methodology.html#power-usage">Power Usage</a></li>
<li class="toctree-l2"><a class="reference internal" href="methodology.html#cpu-hardware">CPU hardware</a></li>
<li class="toctree-l2"><a class="reference internal" href="methodology.html#rapl-metrics">RAPL Metrics</a></li>
<li class="toctree-l2"><a class="reference internal" href="methodology.html#cpu-metrics-priority">CPU metrics priority</a></li>
<li class="toctree-l2"><a class="reference internal" href="methodology.html#references">References</a></li>
<li class="toctree-l2"><a class="reference internal" href="methodology.html#estimation-of-equivalent-usage-emissions">Estimation of Equivalent Usage Emissions</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="rapl.html">RAPL Metrics</a><ul>
<li class="toctree-l2"><a class="reference internal" href="rapl.html#rapl-domain-architecture">RAPL Domain Architecture</a></li>
<li class="toctree-l2"><a class="reference internal" href="rapl.html#available-rapl-domains">Available RAPL Domains</a></li>
<li class="toctree-l2"><a class="reference internal" href="rapl.html#rapl-domain-hierarchy-and-double-counting">RAPL Domain Hierarchy and Double-Counting</a></li>
<li class="toctree-l2"><a class="reference internal" href="rapl.html#codecarbon-s-rapl-strategy">CodeCarbon’s RAPL Strategy</a></li>
<li class="toctree-l2"><a class="reference internal" href="rapl.html#platform-specific-behavior">Platform-Specific Behavior</a></li>
<li class="toctree-l2"><a class="reference internal" href="rapl.html#rapl-measurements-real-world-examples">RAPL Measurements: Real-World Examples</a></li>
<li class="toctree-l2"><a class="reference internal" href="rapl.html#key-takeaways-for-rapl-measurements">Key Takeaways for RAPL Measurements</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="model_examples.html">Model Comparisons</a><ul>
<li class="toctree-l2"><a class="reference internal" href="model_examples.html#impact-of-time-of-year-and-region">Impact of time of year and region</a></li>
<li class="toctree-l2"><a class="reference internal" href="model_examples.html#comparisons">Comparisons</a></li>
<li class="toctree-l2"><a class="reference internal" href="model_examples.html#references">References</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="faq.html">Frequently Asked Questions</a></li>
</ul>
</div>
<div class="toctree-wrapper compound">
<p class="caption" role="heading"><span class="caption-text">Getting Started</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="installation.html">Installing CodeCarbon</a><ul>
<li class="toctree-l2"><a class="reference internal" href="installation.html#from-pypi-repository">From PyPi repository</a></li>
<li class="toctree-l2"><a class="reference internal" href="installation.html#using-conda-environments">Using Conda environments</a></li>
<li class="toctree-l2"><a class="reference internal" href="installation.html#dependencies">Dependencies</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="usage.html">Quickstart</a><ul>
<li class="toctree-l2"><a class="reference internal" href="usage.html#online-mode">Online Mode</a></li>
<li class="toctree-l2"><a class="reference internal" href="usage.html#offline-mode">Offline Mode</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="usage.html#configuration">Configuration</a><ul>
<li class="toctree-l2"><a class="reference internal" href="usage.html#configuration-priority">Configuration priority</a></li>
<li class="toctree-l2"><a class="reference internal" href="usage.html#access-internet-through-proxy-server">Access internet through proxy server</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="api.html">CodeCarbon API</a><ul>
<li class="toctree-l2"><a class="reference internal" href="api.html#id1">CodeCarbon API</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="parameters.html">Parameters</a><ul>
<li class="toctree-l2"><a class="reference internal" href="parameters.html#input-parameters">Input Parameters</a></li>
<li class="toctree-l2"><a class="reference internal" href="parameters.html#output-parameters">Output parameters</a></li>
<li class="toctree-l2"><a class="reference internal" href="parameters.html#specific-parameters-for-offline-mode">Specific parameters for offline mode</a></li>
<li class="toctree-l2"><a class="reference internal" href="parameters.html#track-emissions">@track_emissions</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="examples.html">Examples</a><ul>
<li class="toctree-l2"><a class="reference internal" href="examples.html#using-the-decorator">Using the Decorator</a></li>
<li class="toctree-l2"><a class="reference internal" href="examples.html#using-the-context-manager">Using the Context Manager</a></li>
<li class="toctree-l2"><a class="reference internal" href="examples.html#using-the-explicit-object">Using the Explicit Object</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="comet.html">Comet Integration</a></li>
<li class="toctree-l1"><a class="reference internal" href="advanced_installation.html">Advanced Installation</a><ul>
<li class="toctree-l2"><a class="reference internal" href="advanced_installation.html#install-codecarbon-as-a-linux-service">Install CodeCarbon as a Linux service</a></li>
<li class="toctree-l2"><a class="reference internal" href="advanced_installation.html#deploy-codecarbon-cli-as-a-service-using-ansible">Deploy CodeCarbon CLI as a Service using Ansible</a></li>
</ul>
</li>
</ul>
</div>
<div class="toctree-wrapper compound">
<p class="caption" role="heading"><span class="caption-text">Logging</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="output.html">Output</a><ul>
<li class="toctree-l2"><a class="reference internal" href="output.html#csv">CSV</a></li>
<li class="toctree-l2"><a class="reference internal" href="output.html#prometheus">Prometheus</a></li>
<li class="toctree-l2"><a class="reference internal" href="output.html#logfire">Logfire</a></li>
<li class="toctree-l2"><a class="reference internal" href="output.html#http-output">HTTP Output</a></li>
<li class="toctree-l2"><a class="reference internal" href="output.html#codecarbon-api">CodeCarbon API</a></li>
<li class="toctree-l2"><a class="reference internal" href="output.html#logger-output">Logger Output</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="to_logger.html">Collecting emissions to a logger</a><ul>
<li class="toctree-l2"><a class="reference internal" href="to_logger.html#create-a-logger">Create a logger</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="visualize.html">Visualize</a><ul>
<li class="toctree-l2"><a class="reference internal" href="visualize.html#offline">Offline</a></li>
<li class="toctree-l2"><a class="reference internal" href="visualize.html#online">Online</a></li>
</ul>
</li>
</ul>
</div>
<section id="indices-and-tables">
<h2>Indices and tables<a class="headerlink" href="#indices-and-tables" title="Link to this heading"></a></h2>
<ul class="simple">
<li><p><a class="reference internal" href="genindex.html"><span class="std std-ref">Index</span></a></p></li>
<li><p><a class="reference internal" href="py-modindex.html"><span class="std std-ref">Module Index</span></a></p></li>
<li><p><a class="reference internal" href="search.html"><span class="std std-ref">Search Page</span></a></p></li>
</ul>
</section>
</section>
</div>
</div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="motivation.html" class="btn btn-neutral float-right" title="Motivation" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
</div>
<hr/>
<div role="contentinfo">
<p>© Copyright 2020, BCG GAMMA, Comet.ml, Haverford College, MILA.</p>
</div>
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script>
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>