Skip to content

Commit d4fea24

Browse files
author
benoit-cty
committed
rebuild docs
1 parent e902c4b commit d4fea24

21 files changed

+92
-150
lines changed

‎docs/.buildinfo‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
# Sphinx build info version 1
22
# This file records the configuration used when building these files. When it is not found, a full rebuild will be done.
3-
config: 8f56d239af23b25df3d5f772dbc83864
3+
config: 1aa3323cde259091ddcc13297ad65ae6
44
tags: 645f666f9bcd5a90fca523b33c5a78b7

‎docs/_static/documentation_options.js‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
const DOCUMENTATION_OPTIONS = {
2-
VERSION: '3.0.0_rc1',
2+
VERSION: '3.0.0_rc3',
33
LANGUAGE: 'en',
44
COLLAPSE_INDEX: false,
55
BUILDER: 'html',

‎docs/_static/pygments.css‎

Lines changed: 33 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -6,70 +6,70 @@ span.linenos.special { color: #000000; background-color: #ffffc0; padding-left:
66
.highlight .hll { background-color: #ffffcc }
77
.highlight { background: #eeffcc; }
88
.highlight .c { color: #408090; font-style: italic } /* Comment */
9-
.highlight .err { border: 1px solid #F00 } /* Error */
9+
.highlight .err { border: 1px solid #FF0000 } /* Error */
1010
.highlight .k { color: #007020; font-weight: bold } /* Keyword */
11-
.highlight .o { color: #666 } /* Operator */
11+
.highlight .o { color: #666666 } /* Operator */
1212
.highlight .ch { color: #408090; font-style: italic } /* Comment.Hashbang */
1313
.highlight .cm { color: #408090; font-style: italic } /* Comment.Multiline */
1414
.highlight .cp { color: #007020 } /* Comment.Preproc */
1515
.highlight .cpf { color: #408090; font-style: italic } /* Comment.PreprocFile */
1616
.highlight .c1 { color: #408090; font-style: italic } /* Comment.Single */
17-
.highlight .cs { color: #408090; background-color: #FFF0F0 } /* Comment.Special */
17+
.highlight .cs { color: #408090; background-color: #fff0f0 } /* Comment.Special */
1818
.highlight .gd { color: #A00000 } /* Generic.Deleted */
1919
.highlight .ge { font-style: italic } /* Generic.Emph */
2020
.highlight .ges { font-weight: bold; font-style: italic } /* Generic.EmphStrong */
21-
.highlight .gr { color: #F00 } /* Generic.Error */
21+
.highlight .gr { color: #FF0000 } /* Generic.Error */
2222
.highlight .gh { color: #000080; font-weight: bold } /* Generic.Heading */
2323
.highlight .gi { color: #00A000 } /* Generic.Inserted */
24-
.highlight .go { color: #333 } /* Generic.Output */
25-
.highlight .gp { color: #C65D09; font-weight: bold } /* Generic.Prompt */
24+
.highlight .go { color: #333333 } /* Generic.Output */
25+
.highlight .gp { color: #c65d09; font-weight: bold } /* Generic.Prompt */
2626
.highlight .gs { font-weight: bold } /* Generic.Strong */
2727
.highlight .gu { color: #800080; font-weight: bold } /* Generic.Subheading */
28-
.highlight .gt { color: #04D } /* Generic.Traceback */
28+
.highlight .gt { color: #0044DD } /* Generic.Traceback */
2929
.highlight .kc { color: #007020; font-weight: bold } /* Keyword.Constant */
3030
.highlight .kd { color: #007020; font-weight: bold } /* Keyword.Declaration */
3131
.highlight .kn { color: #007020; font-weight: bold } /* Keyword.Namespace */
3232
.highlight .kp { color: #007020 } /* Keyword.Pseudo */
3333
.highlight .kr { color: #007020; font-weight: bold } /* Keyword.Reserved */
3434
.highlight .kt { color: #902000 } /* Keyword.Type */
3535
.highlight .m { color: #208050 } /* Literal.Number */
36-
.highlight .s { color: #4070A0 } /* Literal.String */
37-
.highlight .na { color: #4070A0 } /* Name.Attribute */
36+
.highlight .s { color: #4070a0 } /* Literal.String */
37+
.highlight .na { color: #4070a0 } /* Name.Attribute */
3838
.highlight .nb { color: #007020 } /* Name.Builtin */
39-
.highlight .nc { color: #0E84B5; font-weight: bold } /* Name.Class */
40-
.highlight .no { color: #60ADD5 } /* Name.Constant */
41-
.highlight .nd { color: #555; font-weight: bold } /* Name.Decorator */
42-
.highlight .ni { color: #D55537; font-weight: bold } /* Name.Entity */
39+
.highlight .nc { color: #0e84b5; font-weight: bold } /* Name.Class */
40+
.highlight .no { color: #60add5 } /* Name.Constant */
41+
.highlight .nd { color: #555555; font-weight: bold } /* Name.Decorator */
42+
.highlight .ni { color: #d55537; font-weight: bold } /* Name.Entity */
4343
.highlight .ne { color: #007020 } /* Name.Exception */
44-
.highlight .nf { color: #06287E } /* Name.Function */
44+
.highlight .nf { color: #06287e } /* Name.Function */
4545
.highlight .nl { color: #002070; font-weight: bold } /* Name.Label */
46-
.highlight .nn { color: #0E84B5; font-weight: bold } /* Name.Namespace */
46+
.highlight .nn { color: #0e84b5; font-weight: bold } /* Name.Namespace */
4747
.highlight .nt { color: #062873; font-weight: bold } /* Name.Tag */
48-
.highlight .nv { color: #BB60D5 } /* Name.Variable */
48+
.highlight .nv { color: #bb60d5 } /* Name.Variable */
4949
.highlight .ow { color: #007020; font-weight: bold } /* Operator.Word */
50-
.highlight .w { color: #BBB } /* Text.Whitespace */
50+
.highlight .w { color: #bbbbbb } /* Text.Whitespace */
5151
.highlight .mb { color: #208050 } /* Literal.Number.Bin */
5252
.highlight .mf { color: #208050 } /* Literal.Number.Float */
5353
.highlight .mh { color: #208050 } /* Literal.Number.Hex */
5454
.highlight .mi { color: #208050 } /* Literal.Number.Integer */
5555
.highlight .mo { color: #208050 } /* Literal.Number.Oct */
56-
.highlight .sa { color: #4070A0 } /* Literal.String.Affix */
57-
.highlight .sb { color: #4070A0 } /* Literal.String.Backtick */
58-
.highlight .sc { color: #4070A0 } /* Literal.String.Char */
59-
.highlight .dl { color: #4070A0 } /* Literal.String.Delimiter */
60-
.highlight .sd { color: #4070A0; font-style: italic } /* Literal.String.Doc */
61-
.highlight .s2 { color: #4070A0 } /* Literal.String.Double */
62-
.highlight .se { color: #4070A0; font-weight: bold } /* Literal.String.Escape */
63-
.highlight .sh { color: #4070A0 } /* Literal.String.Heredoc */
64-
.highlight .si { color: #70A0D0; font-style: italic } /* Literal.String.Interpol */
65-
.highlight .sx { color: #C65D09 } /* Literal.String.Other */
56+
.highlight .sa { color: #4070a0 } /* Literal.String.Affix */
57+
.highlight .sb { color: #4070a0 } /* Literal.String.Backtick */
58+
.highlight .sc { color: #4070a0 } /* Literal.String.Char */
59+
.highlight .dl { color: #4070a0 } /* Literal.String.Delimiter */
60+
.highlight .sd { color: #4070a0; font-style: italic } /* Literal.String.Doc */
61+
.highlight .s2 { color: #4070a0 } /* Literal.String.Double */
62+
.highlight .se { color: #4070a0; font-weight: bold } /* Literal.String.Escape */
63+
.highlight .sh { color: #4070a0 } /* Literal.String.Heredoc */
64+
.highlight .si { color: #70a0d0; font-style: italic } /* Literal.String.Interpol */
65+
.highlight .sx { color: #c65d09 } /* Literal.String.Other */
6666
.highlight .sr { color: #235388 } /* Literal.String.Regex */
67-
.highlight .s1 { color: #4070A0 } /* Literal.String.Single */
67+
.highlight .s1 { color: #4070a0 } /* Literal.String.Single */
6868
.highlight .ss { color: #517918 } /* Literal.String.Symbol */
6969
.highlight .bp { color: #007020 } /* Name.Builtin.Pseudo */
70-
.highlight .fm { color: #06287E } /* Name.Function.Magic */
71-
.highlight .vc { color: #BB60D5 } /* Name.Variable.Class */
72-
.highlight .vg { color: #BB60D5 } /* Name.Variable.Global */
73-
.highlight .vi { color: #BB60D5 } /* Name.Variable.Instance */
74-
.highlight .vm { color: #BB60D5 } /* Name.Variable.Magic */
70+
.highlight .fm { color: #06287e } /* Name.Function.Magic */
71+
.highlight .vc { color: #bb60d5 } /* Name.Variable.Class */
72+
.highlight .vg { color: #bb60d5 } /* Name.Variable.Global */
73+
.highlight .vi { color: #bb60d5 } /* Name.Variable.Instance */
74+
.highlight .vm { color: #bb60d5 } /* Name.Variable.Magic */
7575
.highlight .il { color: #208050 } /* Literal.Number.Integer.Long */

‎docs/api.html‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -6,14 +6,14 @@
66
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
77

88
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
9-
<title>CodeCarbon API &mdash; CodeCarbon 3.0.0_rc1 documentation</title>
9+
<title>CodeCarbon API &mdash; CodeCarbon 3.0.0_rc3 documentation</title>
1010
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=fa44fd50" />
1111
<link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=e59714d7" />
1212

1313

1414
<script src="_static/jquery.js?v=5d32c60e"></script>
1515
<script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
16-
<script src="_static/documentation_options.js?v=f6280c33"></script>
16+
<script src="_static/documentation_options.js?v=65a80240"></script>
1717
<script src="_static/doctools.js?v=9bcbadda"></script>
1818
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
1919
<script src="_static/js/theme.js"></script>
@@ -115,10 +115,10 @@ <h2>CodeCarbon API<a class="headerlink" href="#id1" title="Link to this heading"
115115
</pre></div>
116116
</div>
117117
<p>Or use the API in your code:</p>
118-
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">from</span><span class="w"> </span><span class="nn">codecarbon</span><span class="w"> </span><span class="kn">import</span> <span class="n">track_emissions</span>
118+
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">from</span> <span class="nn">codecarbon</span> <span class="kn">import</span> <span class="n">track_emissions</span>
119119

120120
<span class="nd">@track_emissions</span><span class="p">(</span><span class="n">save_to_api</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>
121-
<span class="k">def</span><span class="w"> </span><span class="nf">train_model</span><span class="p">():</span>
121+
<span class="k">def</span> <span class="nf">train_model</span><span class="p">():</span>
122122
<span class="c1"># GPU intensive training code goes here</span>
123123

124124
<span class="k">if</span> <span class="vm">__name__</span> <span class="o">==</span><span class="s2">&quot;__main__&quot;</span><span class="p">:</span>
@@ -131,15 +131,15 @@ <h2>CodeCarbon API<a class="headerlink" href="#id1" title="Link to this heading"
131131
<p>And so on for your team, project and experiment.</p>
132132
<p>You then have to set you experiment id in CodeCarbon, with two options:</p>
133133
<p>In the code:</p>
134-
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">from</span><span class="w"> </span><span class="nn">codecarbon</span><span class="w"> </span><span class="kn">import</span> <span class="n">track_emissions</span>
134+
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">from</span> <span class="nn">codecarbon</span> <span class="kn">import</span> <span class="n">track_emissions</span>
135135

136136
<span class="nd">@track_emissions</span><span class="p">(</span>
137137
<span class="n">measure_power_secs</span><span class="o">=</span><span class="mi">30</span><span class="p">,</span>
138138
<span class="n">api_call_interval</span><span class="o">=</span><span class="mi">4</span><span class="p">,</span>
139139
<span class="n">experiment_id</span><span class="o">=</span><span class="s2">&quot;your experiment id&quot;</span><span class="p">,</span>
140140
<span class="n">save_to_api</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span>
141141
<span class="p">)</span>
142-
<span class="k">def</span><span class="w"> </span><span class="nf">train_model</span><span class="p">():</span>
142+
<span class="k">def</span> <span class="nf">train_model</span><span class="p">():</span>
143143
<span class="o">...</span>
144144
</pre></div>
145145
</div>

‎docs/comet.html‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,14 +6,14 @@
66
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
77

88
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
9-
<title>Comet Integration &mdash; CodeCarbon 3.0.0_rc1 documentation</title>
9+
<title>Comet Integration &mdash; CodeCarbon 3.0.0_rc3 documentation</title>
1010
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=fa44fd50" />
1111
<link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=e59714d7" />
1212

1313

1414
<script src="_static/jquery.js?v=5d32c60e"></script>
1515
<script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
16-
<script src="_static/documentation_options.js?v=f6280c33"></script>
16+
<script src="_static/documentation_options.js?v=65a80240"></script>
1717
<script src="_static/doctools.js?v=9bcbadda"></script>
1818
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
1919
<script src="_static/js/theme.js"></script>

‎docs/examples.html‎

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -6,14 +6,14 @@
66
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
77

88
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
9-
<title>Examples &mdash; CodeCarbon 3.0.0_rc1 documentation</title>
9+
<title>Examples &mdash; CodeCarbon 3.0.0_rc3 documentation</title>
1010
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=fa44fd50" />
1111
<link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=e59714d7" />
1212

1313

1414
<script src="_static/jquery.js?v=5d32c60e"></script>
1515
<script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
16-
<script src="_static/documentation_options.js?v=f6280c33"></script>
16+
<script src="_static/documentation_options.js?v=65a80240"></script>
1717
<script src="_static/doctools.js?v=9bcbadda"></script>
1818
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
1919
<script src="_static/js/theme.js"></script>
@@ -100,9 +100,9 @@
100100
<p>Following are examples to train a Deep Learning model on MNIST Data to recognize digits in images using TensorFlow.</p>
101101
<section id="using-the-explicit-object">
102102
<h2>Using the Explicit Object<a class="headerlink" href="#using-the-explicit-object" title="Link to this heading"></a></h2>
103-
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">import</span><span class="w"> </span><span class="nn">tensorflow</span><span class="w"> </span><span class="k">as</span><span class="w"> </span><span class="nn">tf</span>
103+
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">import</span> <span class="nn">tensorflow</span> <span class="k">as</span> <span class="nn">tf</span>
104104

105-
<span class="kn">from</span><span class="w"> </span><span class="nn">codecarbon</span><span class="w"> </span><span class="kn">import</span> <span class="n">EmissionsTracker</span>
105+
<span class="kn">from</span> <span class="nn">codecarbon</span> <span class="kn">import</span> <span class="n">EmissionsTracker</span>
106106

107107
<span class="n">mnist</span> <span class="o">=</span> <span class="n">tf</span><span class="o">.</span><span class="n">keras</span><span class="o">.</span><span class="n">datasets</span><span class="o">.</span><span class="n">mnist</span>
108108

@@ -133,9 +133,9 @@ <h2>Using the Explicit Object<a class="headerlink" href="#using-the-explicit-obj
133133
</section>
134134
<section id="using-the-context-manager">
135135
<h2>Using the Context Manager<a class="headerlink" href="#using-the-context-manager" title="Link to this heading"></a></h2>
136-
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">import</span><span class="w"> </span><span class="nn">tensorflow</span><span class="w"> </span><span class="k">as</span><span class="w"> </span><span class="nn">tf</span>
136+
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">import</span> <span class="nn">tensorflow</span> <span class="k">as</span> <span class="nn">tf</span>
137137

138-
<span class="kn">from</span><span class="w"> </span><span class="nn">codecarbon</span><span class="w"> </span><span class="kn">import</span> <span class="n">EmissionsTracker</span>
138+
<span class="kn">from</span> <span class="nn">codecarbon</span> <span class="kn">import</span> <span class="n">EmissionsTracker</span>
139139

140140
<span class="n">mnist</span> <span class="o">=</span> <span class="n">tf</span><span class="o">.</span><span class="n">keras</span><span class="o">.</span><span class="n">datasets</span><span class="o">.</span><span class="n">mnist</span>
141141

@@ -162,13 +162,13 @@ <h2>Using the Context Manager<a class="headerlink" href="#using-the-context-mana
162162
</section>
163163
<section id="using-the-decorator">
164164
<h2>Using the Decorator<a class="headerlink" href="#using-the-decorator" title="Link to this heading"></a></h2>
165-
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">import</span><span class="w"> </span><span class="nn">tensorflow</span><span class="w"> </span><span class="k">as</span><span class="w"> </span><span class="nn">tf</span>
165+
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">import</span> <span class="nn">tensorflow</span> <span class="k">as</span> <span class="nn">tf</span>
166166

167-
<span class="kn">from</span><span class="w"> </span><span class="nn">codecarbon</span><span class="w"> </span><span class="kn">import</span> <span class="n">track_emissions</span>
167+
<span class="kn">from</span> <span class="nn">codecarbon</span> <span class="kn">import</span> <span class="n">track_emissions</span>
168168

169169

170170
<span class="nd">@track_emissions</span><span class="p">(</span><span class="n">project_name</span><span class="o">=</span><span class="s2">&quot;mnist&quot;</span><span class="p">)</span>
171-
<span class="k">def</span><span class="w"> </span><span class="nf">train_model</span><span class="p">():</span>
171+
<span class="k">def</span> <span class="nf">train_model</span><span class="p">():</span>
172172
<span class="n">mnist</span> <span class="o">=</span> <span class="n">tf</span><span class="o">.</span><span class="n">keras</span><span class="o">.</span><span class="n">datasets</span><span class="o">.</span><span class="n">mnist</span>
173173
<span class="p">(</span><span class="n">x_train</span><span class="p">,</span> <span class="n">y_train</span><span class="p">),</span> <span class="p">(</span><span class="n">x_test</span><span class="p">,</span> <span class="n">y_test</span><span class="p">)</span> <span class="o">=</span> <span class="n">mnist</span><span class="o">.</span><span class="n">load_data</span><span class="p">()</span>
174174
<span class="n">x_train</span><span class="p">,</span> <span class="n">x_test</span> <span class="o">=</span> <span class="n">x_train</span> <span class="o">/</span> <span class="mf">255.0</span><span class="p">,</span> <span class="n">x_test</span> <span class="o">/</span> <span class="mf">255.0</span>

‎docs/faq.html‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,14 +6,14 @@
66
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
77

88
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
9-
<title>Frequently Asked Questions &mdash; CodeCarbon 3.0.0_rc1 documentation</title>
9+
<title>Frequently Asked Questions &mdash; CodeCarbon 3.0.0_rc3 documentation</title>
1010
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=fa44fd50" />
1111
<link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=e59714d7" />
1212

1313

1414
<script src="_static/jquery.js?v=5d32c60e"></script>
1515
<script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
16-
<script src="_static/documentation_options.js?v=f6280c33"></script>
16+
<script src="_static/documentation_options.js?v=65a80240"></script>
1717
<script src="_static/doctools.js?v=9bcbadda"></script>
1818
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
1919
<script src="_static/js/theme.js"></script>

‎docs/genindex.html‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,14 +5,14 @@
55
<head>
66
<meta charset="utf-8" />
77
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
8-
<title>Index &mdash; CodeCarbon 3.0.0_rc1 documentation</title>
8+
<title>Index &mdash; CodeCarbon 3.0.0_rc3 documentation</title>
99
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=fa44fd50" />
1010
<link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=e59714d7" />
1111

1212

1313
<script src="_static/jquery.js?v=5d32c60e"></script>
1414
<script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
15-
<script src="_static/documentation_options.js?v=f6280c33"></script>
15+
<script src="_static/documentation_options.js?v=65a80240"></script>
1616
<script src="_static/doctools.js?v=9bcbadda"></script>
1717
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
1818
<script src="_static/js/theme.js"></script>

0 commit comments

Comments
 (0)