CodeCarbon APIο
+CodeCarbon 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!
diff --git a/docs/comet.html b/docs/comet.html index 187798fe..5410c4c6 100644 --- a/docs/comet.html +++ b/docs/comet.html @@ -1,10 +1,10 @@ - + -Comet Integrationο
+Comet Integrationο
CodeCarbon can be automatically integrated with Comet for experiment tracking and visualization. Comet provides data scientists with powerful tools to track, compare, explain, and reproduce their experiments. Now, with CodeCarbon you can easily track the carbon footprint of your jobs along with your training metrics, hyperparameters, dataset samples, artifacts, and more.
To get started with the Comet-CodeCarbon integration, make sure you have comet-ml installed:
diff --git a/docs/edit/conf.py b/docs/edit/conf.py index 86db6873..e8d469b2 100644 --- a/docs/edit/conf.py +++ b/docs/edit/conf.py @@ -23,7 +23,7 @@ author = "BCG GAMMA, Comet.ml, Haverford College, MILA, Data For Good" # The full version, including alpha/beta/rc tags -release = "2.7.0" +release = "2.7.1" # -- General configuration --------------------------------------------------- diff --git a/docs/examples.html b/docs/examples.html index 14e1b8c8..4de12d50 100644 --- a/docs/examples.html +++ b/docs/examples.html @@ -1,10 +1,10 @@ - + -Examplesο
+Examplesο
Following are examples to train a Deep Learning model on MNIST Data to recognize digits in images using TensorFlow.
Using the Explicit Objectο
+Using the Explicit Objectο
import tensorflow as tf
from codecarbon import EmissionsTracker
@@ -134,7 +134,7 @@ Using the Explicit Object
-Using the Context Managerο
+Using the Context Managerο
import tensorflow as tf
from codecarbon import EmissionsTracker
@@ -163,7 +163,7 @@ Using the Context Manager
-Using the Decoratorο
+Using the Decoratorο
import tensorflow as tf
from codecarbon import track_emissions
diff --git a/docs/faq.html b/docs/faq.html
index ef18dc9c..1256f85d 100644
--- a/docs/faq.html
+++ b/docs/faq.html
@@ -1,10 +1,10 @@
-
+
- Frequently Asked Questions — CodeCarbon 2.7.0 documentation
+ Frequently Asked Questions — CodeCarbon 2.7.1 documentation
@@ -15,9 +15,9 @@
-
-
-
+
+
+
@@ -93,7 +93,7 @@
-Frequently Asked Questionsο
+Frequently Asked Questionsο
- How accurate are your estimations?
It is hard to quantify the entirety of computing emissions, because there are many factors in play, notably the life-cycle emissions of computing infrastructure. We therefore only focus on the direct emissions produced by running the actual code, but recognize that there is much work to be done to improve this estimation.
diff --git a/docs/genindex.html b/docs/genindex.html
index 88908891..810f4edf 100644
--- a/docs/genindex.html
+++ b/docs/genindex.html
@@ -1,9 +1,9 @@
-
+
- Index — CodeCarbon 2.7.0 documentation
+ Index — CodeCarbon 2.7.1 documentation
@@ -14,9 +14,9 @@
-
-
-
+
+
+
diff --git a/docs/index.html b/docs/index.html
index 2a9825b5..1b91f917 100644
--- a/docs/index.html
+++ b/docs/index.html
@@ -1,10 +1,10 @@
-
+
- CodeCarbon — CodeCarbon 2.7.0 documentation
+ CodeCarbon — CodeCarbon 2.7.1 documentation
@@ -15,9 +15,9 @@
-
-
-
+
+
+
@@ -92,7 +92,7 @@
-CodeCarbonο
+CodeCarbonο
Introduction
@@ -176,7 +176,7 @@ CodeCarbon
-Indices and tablesο
+Indices and tablesο
Installing CodeCarbon — CodeCarbon 2.7.0 documentation
+ Installing CodeCarbon — CodeCarbon 2.7.1 documentation
@@ -15,9 +15,9 @@
-
-
-
+
+
+
@@ -98,7 +98,7 @@
-Installing CodeCarbonο
+Installing CodeCarbonο
Create a virtual environment using conda for easier management of dependencies and packages.
For installing conda, follow the instructions on the
official conda website
@@ -107,7 +107,7 @@
-From PyPi repositoryο
+From PyPi repositoryο
The package is hosted on the pip repository here.
To install the package, run the following command in your terminal.
pip install codecarbon
@@ -115,7 +115,7 @@ From PyPi repository
-From conda repositoryο
+From conda repositoryο
The package is hosted on the conda repository here.
To install the package, run the following command in your terminal.
conda install -c codecarbon -c conda-forge codecarbon
@@ -127,7 +127,7 @@ From conda repository
-Dependenciesο
+Dependenciesο
The following packages are used by the CodeCarbon package, and will be installed along with the package itself:
arrow
pandas
diff --git a/docs/methodology.html b/docs/methodology.html
index d1e35867..9a07af79 100644
--- a/docs/methodology.html
+++ b/docs/methodology.html
@@ -1,10 +1,10 @@
-
+
- Methodology — CodeCarbon 2.7.0 documentation
+ Methodology — CodeCarbon 2.7.1 documentation
@@ -15,9 +15,9 @@
-
-
-
+
+
+
@@ -107,7 +107,7 @@
-Methodologyο
+Methodologyο
Carbon dioxide (COβ) emissions, expressed as kilograms of COβ-equivalents [COβeq], are the product of two main factors :
C = Carbon Intensity of the electricity consumed for computation: quantified as g of COβ emitted per kilowatt-hour of electricity.
@@ -116,14 +116,14 @@
Carbon dioxide emissions (COβeq) can then be calculated as C * E
-Carbon Intensityο
+Carbon Intensityο
Carbon Intensity of the consumed electricity is calculated as a weighted average of the emissions from the different
energy sources that are used to generate electricity, including fossil fuels and renewables. In this toolkit, the fossil fuels coal, petroleum, and natural gas are associated with specific carbon intensities: a known amount of carbon dioxide is emitted for each kilowatt-hour of electricity generated. Renewable or low-carbon fuels include solar power, hydroelectricity, biomass, geothermal, and more. The nearby energy grid contains a mixture of fossil fuels and low-carbon energy sources, called the Energy Mix. Based on the mix of energy sources in the local grid, this package calculates the Carbon Intensity of the electricity consumed.
When available, CodeCarbon uses global carbon intensity of electricity per cloud provider ( here ) or per country ( here ).
If we donβt have the global carbon intensity or electricity of a country, but we have its electricity mix, we compute the carbon intensity of electricity using this table:
