Dedicated page for API

mlco2 · Aug 2, 2023 · 68f9216 · 68f9216
1 parent 5d4abf1
commit 68f9216
Show file tree

Hide file tree

Showing 24 changed files with 351 additions and 101 deletions.
diff --git a/docs/_sources/api.rst.txt b/docs/_sources/api.rst.txt
@@ -0,0 +1,74 @@
+.. _api:
+
+CodeCarbon API
+==============
+
+
+CodeCarbon API
+~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. warning::
+    This mode use the CodeCarbon API to upload the timeseries of your emissions on a central server. All data will be public!
+
+Before using it, you need an experiment_id, to get one, run:
+
+.. code-block:: console
+
+    codecarbon init
+
+It will create a experiment_id on the default project and save it to ``codecarbon.config``
+
+Then you could tell CodeCarbon to monitor your machine :
+
+.. code-block:: console
+
+    codecarbon monitor
+
+Or use the API in your code
+
+.. code-block:: python
+
+    from codecarbon import track_emissions
+
+    @track_emissions(save_to_api=True)
+    def train_model():
+        # GPU intensive training code  goes here
+    if __name__ =="__main__":
+        train_model()
+
+More options could be specified in ``@track_emissions`` or in ``.codecarbon.config``
+
+The `CodeCarbon dasboard <https://dashboard.codecarbon.io/>`_ use `CodeCarbon API <https://api.codecarbon.io/>`_ to get the data
+
+The API do not have a nice web interface to create your own organization and project, you have to use `OpenAPI interface <https://api.codecarbon.io/docs>`_ for that.
+
+And so on for your team, project and experiment.
+
+You then have to set you experiment id in CodeCarbon, with two options:
+
+In the code:
+
+.. code-block:: python
+
+    from codecarbon import track_emissions
+    @track_emissions(
+        measure_power_secs=30,
+        api_call_interval=4,
+        experiment_id="your experiment id",
+        save_to_api=True,
+    )
+    def train_model():
+
+
+Or in the config file `.codecarbon.config`:
+
+.. code-block:: ini
+
+    [codecarbon]
+    experiment_id = your experiment id
+    save_to_api = true
+
+But I see that you already did all that and have emissions data in the database, so we have to investigate for a bug in the interface.
+
+Thanks for taking time to report this.
+
diff --git a/docs/_sources/index.rst.txt b/docs/_sources/index.rst.txt
@@ -25,6 +25,7 @@ CodeCarbon
 
    installation
    usage
+   api
    parameters
    examples
    comet

diff --git a/docs/_sources/usage.rst.txt b/docs/_sources/usage.rst.txt
@@ -97,40 +97,6 @@ This mode is recommended if you have a training function.
 .. note::
     This will write a csv file named emissions.csv in the current directory
 
-CodeCarbon API
-~~~~~~~~~~~~~~~~~~~~~~~~
-
-.. warning::
-    This mode use the CodeCarbon API to upload the timeseries of your emissions on a central server. All data will be public!
-
-Before using it, you need an experiment_id, to get one, run:
-
-.. code-block:: console
-
-    codecarbon init
-
-It will create a experiment_id on the default project and save it to ``codecarbon.config``
-
-Then you could tell CodeCarbon to monitor your machine :
-
-.. code-block:: console
-
-    codecarbon monitor
-
-Or use the API in your code
-
-.. code-block:: python
-
-    from codecarbon import track_emissions
-
-    @track_emissions(save_to_api=True)
-    def train_model():
-        # GPU intensive training code  goes here
-    if __name__ =="__main__":
-        train_model()
-
-More options could be specified in ``@track_emissions`` or in ``.codecarbon.config``
-
 Offline Mode
 ------------
 An offline version is available to support restricted environments without internet access. The internal computations remain unchanged; however,

diff --git a/docs/api.html b/docs/api.html
@@ -0,0 +1,177 @@
+<!DOCTYPE html>
+<html class="writer-html5" lang="en" >
+<head>
+  <meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
+
+  <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+  <title>CodeCarbon API &mdash; CodeCarbon 2.3.0 documentation</title>
+      <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
+      <link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
+  <!--[if lt IE 9]>
+    <script src="_static/js/html5shiv.min.js"></script>
+  <![endif]-->
+
+        <script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
+        <script src="_static/jquery.js"></script>
+        <script src="_static/underscore.js"></script>
+        <script src="_static/_sphinx_javascript_frameworks_compat.js"></script>
+        <script src="_static/doctools.js"></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="Parameters" href="parameters.html" />
+    <link rel="prev" title="Quickstart" href="usage.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="index.html" 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" />
+    <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="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 class="current">
+<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 current"><a class="current reference internal" href="#">CodeCarbon API</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="#id1">CodeCarbon API</a></li>
+</ul>
+</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>
+</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="index.html">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="index.html" class="icon icon-home"></a> &raquo;</li>
+      <li>CodeCarbon API</li>
+      <li class="wy-breadcrumbs-aside">
+            <a href="_sources/api.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-api">
+<span id="api"></span><h1>CodeCarbon API<a class="headerlink" href="#codecarbon-api" title="Permalink to this heading"></a></h1>
+<section id="id1">
+<h2>CodeCarbon API<a class="headerlink" href="#id1" title="Permalink to this heading"></a></h2>
+<div class="admonition warning">
+<p class="admonition-title">Warning</p>
+<p>This mode use the CodeCarbon API to upload the timeseries of your emissions on a central server. All data will be public!</p>
+</div>
+<p>Before using it, you need an experiment_id, to get one, run:</p>
+<div class="highlight-console notranslate"><div class="highlight"><pre><span></span><span class="go">codecarbon init</span>
+</pre></div>
+</div>
+<p>It will create a experiment_id on the default project and save it to <code class="docutils literal notranslate"><span class="pre">codecarbon.config</span></code></p>
+<p>Then you could tell CodeCarbon to monitor your machine :</p>
+<div class="highlight-console notranslate"><div class="highlight"><pre><span></span><span class="go">codecarbon monitor</span>
+</pre></div>
+</div>
+<p>Or use the API in your code</p>
+<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>
+
+<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>
+<span class="k">def</span> <span class="nf">train_model</span><span class="p">():</span>
+    <span class="c1"># GPU intensive training code  goes here</span>
+<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>
+    <span class="n">train_model</span><span class="p">()</span>
+</pre></div>
+</div>
+<p>More options could be specified in <code class="docutils literal notranslate"><span class="pre">&#64;track_emissions</span></code> or in <code class="docutils literal notranslate"><span class="pre">.codecarbon.config</span></code></p>
+<p>The <a class="reference external" href="https://dashboard.codecarbon.io/">CodeCarbon dasboard</a> use <a class="reference external" href="https://api.codecarbon.io/">CodeCarbon API</a> to get the data</p>
+<p>The API do not have a nice web interface to create your own organization and project, you have to use <a class="reference external" href="https://api.codecarbon.io/docs">OpenAPI interface</a> for that.</p>
+<p>And so on for your team, project and experiment.</p>
+<p>You then have to set you experiment id in CodeCarbon, with two options:</p>
+<p>In the code:</p>
+<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>
+<span class="nd">@track_emissions</span><span class="p">(</span>
+    <span class="n">measure_power_secs</span><span class="o">=</span><span class="mi">30</span><span class="p">,</span>
+    <span class="n">api_call_interval</span><span class="o">=</span><span class="mi">4</span><span class="p">,</span>
+    <span class="n">experiment_id</span><span class="o">=</span><span class="s2">&quot;your experiment id&quot;</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>
+<span class="p">)</span>
+<span class="k">def</span> <span class="nf">train_model</span><span class="p">():</span>
+</pre></div>
+</div>
+<p>Or in the config file <cite>.codecarbon.config</cite>:</p>
+<div class="highlight-ini notranslate"><div class="highlight"><pre><span></span><span class="k">[codecarbon]</span><span class="w"></span>
+<span class="na">experiment_id</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">your experiment id</span><span class="w"></span>
+<span class="na">save_to_api</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">true</span><span class="w"></span>
+</pre></div>
+</div>
+<p>But I see that you already did all that and have emissions data in the database, so we have to investigate for a bug in the interface.</p>
+<p>Thanks for taking time to report this.</p>
+</section>
+</section>
+
+
+           </div>
+          </div>
+          <footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
+        <a href="usage.html" class="btn btn-neutral float-left" title="Quickstart" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
+        <a href="parameters.html" class="btn btn-neutral float-right" title="Parameters" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
+    </div>
+
+  <hr/>
+
+  <div role="contentinfo">
+    <p>&#169; 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>
diff --git a/docs/comet.html b/docs/comet.html
@@ -50,6 +50,7 @@
 <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 current"><a class="current reference internal" href="#">Comet Integration</a></li>

diff --git a/docs/edit/api.rst b/docs/edit/api.rst
@@ -0,0 +1,74 @@
+.. _api:
+
+CodeCarbon API
+==============
+
+
+CodeCarbon API
+~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. warning::
+    This mode use the CodeCarbon API to upload the timeseries of your emissions on a central server. All data will be public!
+
+Before using it, you need an experiment_id, to get one, run:
+
+.. code-block:: console
+
+    codecarbon init
+
+It will create a experiment_id on the default project and save it to ``codecarbon.config``
+
+Then you could tell CodeCarbon to monitor your machine :
+
+.. code-block:: console
+
+    codecarbon monitor
+
+Or use the API in your code
+
+.. code-block:: python
+
+    from codecarbon import track_emissions
+
+    @track_emissions(save_to_api=True)
+    def train_model():
+        # GPU intensive training code  goes here
+    if __name__ =="__main__":
+        train_model()
+
+More options could be specified in ``@track_emissions`` or in ``.codecarbon.config``
+
+The `CodeCarbon dasboard <https://dashboard.codecarbon.io/>`_ use `CodeCarbon API <https://api.codecarbon.io/>`_ to get the data
+
+The API do not have a nice web interface to create your own organization and project, you have to use `OpenAPI interface <https://api.codecarbon.io/docs>`_ for that.
+
+And so on for your team, project and experiment.
+
+You then have to set you experiment id in CodeCarbon, with two options:
+
+In the code:
+
+.. code-block:: python
+
+    from codecarbon import track_emissions
+    @track_emissions(
+        measure_power_secs=30,
+        api_call_interval=4,
+        experiment_id="your experiment id",
+        save_to_api=True,
+    )
+    def train_model():
+
+
+Or in the config file `.codecarbon.config`:
+
+.. code-block:: ini
+
+    [codecarbon]
+    experiment_id = your experiment id
+    save_to_api = true
+
+But I see that you already did all that and have emissions data in the database, so we have to investigate for a bug in the interface.
+
+Thanks for taking time to report this.
+
diff --git a/docs/edit/index.rst b/docs/edit/index.rst
@@ -25,6 +25,7 @@ CodeCarbon
 
    installation
    usage
+   api
    parameters
    examples
    comet