diff --git a/docs/.buildinfo b/docs/.buildinfo index 4f83654bb..481b696ff 100644 --- a/docs/.buildinfo +++ b/docs/.buildinfo @@ -1,4 +1,4 @@ # Sphinx build info version 1 # This file records the configuration used when building these files. When it is not found, a full rebuild will be done. -config: 17ecbb66283862d6a160c35238add531 +config: 6a3f5c9be9eaecb995e0506550ec299d tags: 645f666f9bcd5a90fca523b33c5a78b7 diff --git a/docs/_sources/installation.rst.txt b/docs/_sources/installation.rst.txt index 4539c5ffc..abaa43ca3 100644 --- a/docs/_sources/installation.rst.txt +++ b/docs/_sources/installation.rst.txt @@ -3,6 +3,7 @@ Installing CodeCarbon ===================== + From PyPi repository -------------------- @@ -57,3 +58,18 @@ The following packages are used by the CodeCarbon package, and will be installed Please refer to `pyproject.toml `_ for the latest list of the packages used. + +(Non-Python users) Standalone installer +--------------------------------------- +If you are not using Python but you still would like to run CodeCarbon (for instance to use the :ref:`CodeCarbon Command line `)), we provide a standalone installer to download and install CodeCarbon on your machine. + +Use curl to download the script and execute it with sh: + +.. code-block:: bash + + curl -LsSf https://codecarbon.io/scripts/install.sh | sh +or for Windows users, using powershell: + +.. code-block:: powershell + + powershell -ExecutionPolicy ByPass -c "irm https://codecarbon.io/scripts/install.ps1 | iex" \ No newline at end of file diff --git a/docs/_sources/usage.rst.txt b/docs/_sources/usage.rst.txt index 63774359a..c2373af0b 100644 --- a/docs/_sources/usage.rst.txt +++ b/docs/_sources/usage.rst.txt @@ -11,6 +11,8 @@ Online Mode When the environment has internet access, the ``EmissionsTracker`` object or the ``track_emissions`` decorator can be used, which has the ``offline`` parameter set to ``False`` by default. +.. _usage-command-line: + Command line ~~~~~~~~~~~~ diff --git a/docs/_static/basic.css b/docs/_static/basic.css index 4738b2edc..7ebbd6d07 100644 --- a/docs/_static/basic.css +++ b/docs/_static/basic.css @@ -741,6 +741,14 @@ abbr, acronym { cursor: help; } +.translated { + background-color: rgba(207, 255, 207, 0.2) +} + +.untranslated { + background-color: rgba(255, 207, 207, 0.2) +} + /* -- code displays --------------------------------------------------------- */ pre { diff --git a/docs/_static/doctools.js b/docs/_static/doctools.js index 807cdb176..0398ebb9f 100644 --- a/docs/_static/doctools.js +++ b/docs/_static/doctools.js @@ -59,7 +59,7 @@ const Documentation = { Object.assign(Documentation.TRANSLATIONS, catalog.messages); Documentation.PLURAL_EXPR = new Function( "n", - `return (${catalog.plural_expr})`, + `return (${catalog.plural_expr})` ); Documentation.LOCALE = catalog.locale; }, @@ -89,7 +89,7 @@ const Documentation = { const togglerElements = document.querySelectorAll("img.toggler"); togglerElements.forEach((el) => - el.addEventListener("click", (event) => toggler(event.currentTarget)), + el.addEventListener("click", (event) => toggler(event.currentTarget)) ); togglerElements.forEach((el) => (el.style.display = "")); if (DOCUMENTATION_OPTIONS.COLLAPSE_INDEX) togglerElements.forEach(toggler); @@ -98,15 +98,14 @@ const Documentation = { initOnKeyListeners: () => { // only install a listener if it is really needed if ( - !DOCUMENTATION_OPTIONS.NAVIGATION_WITH_KEYS - && !DOCUMENTATION_OPTIONS.ENABLE_SEARCH_SHORTCUTS + !DOCUMENTATION_OPTIONS.NAVIGATION_WITH_KEYS && + !DOCUMENTATION_OPTIONS.ENABLE_SEARCH_SHORTCUTS ) return; document.addEventListener("keydown", (event) => { // bail for input elements - if (BLACKLISTED_KEY_CONTROL_ELEMENTS.has(document.activeElement.tagName)) - return; + if (BLACKLISTED_KEY_CONTROL_ELEMENTS.has(document.activeElement.tagName)) return; // bail with special keys if (event.altKey || event.ctrlKey || event.metaKey) return; diff --git a/docs/_static/language_data.js b/docs/_static/language_data.js index 577678642..c7fe6c6fa 100644 --- a/docs/_static/language_data.js +++ b/docs/_static/language_data.js @@ -1,13 +1,192 @@ /* * This script contains the language-specific data used by searchtools.js, - * namely the set of stopwords, stemmer, scorer and splitter. + * namely the list of stopwords, stemmer, scorer and splitter. */ -const stopwords = new Set(["a", "about", "above", "after", "again", "against", "all", "am", "an", "and", "any", "are", "aren't", "as", "at", "be", "because", "been", "before", "being", "below", "between", "both", "but", "by", "can't", "cannot", "could", "couldn't", "did", "didn't", "do", "does", "doesn't", "doing", "don't", "down", "during", "each", "few", "for", "from", "further", "had", "hadn't", "has", "hasn't", "have", "haven't", "having", "he", "he'd", "he'll", "he's", "her", "here", "here's", "hers", "herself", "him", "himself", "his", "how", "how's", "i", "i'd", "i'll", "i'm", "i've", "if", "in", "into", "is", "isn't", "it", "it's", "its", "itself", "let's", "me", "more", "most", "mustn't", "my", "myself", "no", "nor", "not", "of", "off", "on", "once", "only", "or", "other", "ought", "our", "ours", "ourselves", "out", "over", "own", "same", "shan't", "she", "she'd", "she'll", "she's", "should", "shouldn't", "so", "some", "such", "than", "that", "that's", "the", "their", "theirs", "them", "themselves", "then", "there", "there's", "these", "they", "they'd", "they'll", "they're", "they've", "this", "those", "through", "to", "too", "under", "until", "up", "very", "was", "wasn't", "we", "we'd", "we'll", "we're", "we've", "were", "weren't", "what", "what's", "when", "when's", "where", "where's", "which", "while", "who", "who's", "whom", "why", "why's", "with", "won't", "would", "wouldn't", "you", "you'd", "you'll", "you're", "you've", "your", "yours", "yourself", "yourselves"]); -window.stopwords = stopwords; // Export to global scope +var stopwords = ["a", "and", "are", "as", "at", "be", "but", "by", "for", "if", "in", "into", "is", "it", "near", "no", "not", "of", "on", "or", "such", "that", "the", "their", "then", "there", "these", "they", "this", "to", "was", "will", "with"]; -/* Non-minified versions are copied as separate JavaScript files, if available */ -BaseStemmer=function(){this.current="",this.cursor=0,this.limit=0,this.limit_backward=0,this.bra=0,this.ket=0,this.setCurrent=function(t){this.current=t,this.cursor=0,this.limit=this.current.length,this.limit_backward=0,this.bra=this.cursor,this.ket=this.limit},this.getCurrent=function(){return this.current},this.copy_from=function(t){this.current=t.current,this.cursor=t.cursor,this.limit=t.limit,this.limit_backward=t.limit_backward,this.bra=t.bra,this.ket=t.ket},this.in_grouping=function(t,r,i){return!(this.cursor>=this.limit||i<(i=this.current.charCodeAt(this.cursor))||i>>3]&1<<(7&i))||(this.cursor++,0))},this.go_in_grouping=function(t,r,i){for(;this.cursor>>3]&1<<(7&s)))return!0;this.cursor++}return!1},this.in_grouping_b=function(t,r,i){return!(this.cursor<=this.limit_backward||i<(i=this.current.charCodeAt(this.cursor-1))||i>>3]&1<<(7&i))||(this.cursor--,0))},this.go_in_grouping_b=function(t,r,i){for(;this.cursor>this.limit_backward;){var s=this.current.charCodeAt(this.cursor-1);if(i>>3]&1<<(7&s)))return!0;this.cursor--}return!1},this.out_grouping=function(t,r,i){return!(this.cursor>=this.limit)&&(i<(i=this.current.charCodeAt(this.cursor))||i>>3]&1<<(7&i)))&&(this.cursor++,!0)},this.go_out_grouping=function(t,r,i){for(;this.cursor>>3]&1<<(7&s)))return!0;this.cursor++}return!1},this.out_grouping_b=function(t,r,i){return!(this.cursor<=this.limit_backward)&&(i<(i=this.current.charCodeAt(this.cursor-1))||i>>3]&1<<(7&i)))&&(this.cursor--,!0)},this.go_out_grouping_b=function(t,r,i){for(;this.cursor>this.limit_backward;){var s=this.current.charCodeAt(this.cursor-1);if(s<=i&&r<=s&&0!=(t[(s-=r)>>>3]&1<<(7&s)))return!0;this.cursor--}return!1},this.eq_s=function(t){return!(this.limit-this.cursor>>1),o=0,a=e=(l=t[r])[0].length){if(this.cursor=s+l[0].length,l.length<4)return l[2];var g=l[3](this);if(this.cursor=s+l[0].length,g)return l[2]}}while(0<=(r=l[1]));return 0},this.find_among_b=function(t){for(var r=0,i=t.length,s=this.cursor,h=this.limit_backward,e=0,n=0,c=!1;;){for(var u,o=r+(i-r>>1),a=0,l=e=(u=t[r])[0].length){if(this.cursor=s-u[0].length,u.length<4)return u[2];var g=u[3](this);if(this.cursor=s-u[0].length,g)return u[2]}}while(0<=(r=u[1]));return 0},this.replace_s=function(t,r,i){var s=i.length-(r-t);return this.current=this.current.slice(0,t)+i+this.current.slice(r),this.limit+=s,this.cursor>=r?this.cursor+=s:this.cursor>t&&(this.cursor=t),s},this.slice_check=function(){return!(this.bra<0||this.bra>this.ket||this.ket>this.limit||this.limit>this.current.length)},this.slice_from=function(t){var r=!1;return this.slice_check()&&(this.replace_s(this.bra,this.ket,t),r=!0),r},this.slice_del=function(){return this.slice_from("")},this.insert=function(t,r,i){r=this.replace_s(t,r,i);t<=this.bra&&(this.bra+=r),t<=this.ket&&(this.ket+=r)},this.slice_to=function(){var t="";return t=this.slice_check()?this.current.slice(this.bra,this.ket):t},this.assign_to=function(){return this.current.slice(0,this.limit)}}; -var EnglishStemmer=function(){var a=new BaseStemmer,c=[["arsen",-1,-1],["commun",-1,-1],["emerg",-1,-1],["gener",-1,-1],["later",-1,-1],["organ",-1,-1],["past",-1,-1],["univers",-1,-1]],o=[["'",-1,1],["'s'",0,1],["'s",-1,1]],u=[["ied",-1,2],["s",-1,3],["ies",1,2],["sses",1,1],["ss",1,-1],["us",1,-1]],t=[["succ",-1,1],["proc",-1,1],["exc",-1,1]],l=[["even",-1,2],["cann",-1,2],["inn",-1,2],["earr",-1,2],["herr",-1,2],["out",-1,2],["y",-1,1]],n=[["",-1,-1],["ed",0,2],["eed",1,1],["ing",0,3],["edly",0,2],["eedly",4,1],["ingly",0,2]],f=[["",-1,3],["bb",0,2],["dd",0,2],["ff",0,2],["gg",0,2],["bl",0,1],["mm",0,2],["nn",0,2],["pp",0,2],["rr",0,2],["at",0,1],["tt",0,2],["iz",0,1]],_=[["anci",-1,3],["enci",-1,2],["ogi",-1,14],["li",-1,16],["bli",3,12],["abli",4,4],["alli",3,8],["fulli",3,9],["lessli",3,15],["ousli",3,10],["entli",3,5],["aliti",-1,8],["biliti",-1,12],["iviti",-1,11],["tional",-1,1],["ational",14,7],["alism",-1,8],["ation",-1,7],["ization",17,6],["izer",-1,6],["ator",-1,7],["iveness",-1,11],["fulness",-1,9],["ousness",-1,10],["ogist",-1,13]],m=[["icate",-1,4],["ative",-1,6],["alize",-1,3],["iciti",-1,4],["ical",-1,4],["tional",-1,1],["ational",5,2],["ful",-1,5],["ness",-1,5]],b=[["ic",-1,1],["ance",-1,1],["ence",-1,1],["able",-1,1],["ible",-1,1],["ate",-1,1],["ive",-1,1],["ize",-1,1],["iti",-1,1],["al",-1,1],["ism",-1,1],["ion",-1,2],["er",-1,1],["ous",-1,1],["ant",-1,1],["ent",-1,1],["ment",15,1],["ement",16,1]],k=[["e",-1,1],["l",-1,2]],g=[["andes",-1,-1],["atlas",-1,-1],["bias",-1,-1],["cosmos",-1,-1],["early",-1,5],["gently",-1,3],["howe",-1,-1],["idly",-1,2],["news",-1,-1],["only",-1,6],["singly",-1,7],["skies",-1,1],["sky",-1,-1],["ugly",-1,4]],d=[17,64],v=[17,65,16,1],i=[1,17,65,208,1],w=[55,141,2],p=!1,y=0,h=0;function q(){var r=a.limit-a.cursor;return!!(a.out_grouping_b(i,89,121)&&a.in_grouping_b(v,97,121)&&a.out_grouping_b(v,97,121)||(a.cursor=a.limit-r,a.out_grouping_b(v,97,121)&&a.in_grouping_b(v,97,121)&&!(a.cursor>a.limit_backward))||(a.cursor=a.limit-r,a.eq_s_b("past")))}function z(){return h<=a.cursor}function Y(){return y<=a.cursor}this.stem=function(){var r=a.cursor;if(!(()=>{var r;if(a.bra=a.cursor,0!=(r=a.find_among(g))&&(a.ket=a.cursor,!(a.cursora.limit)a.cursor=i;else{a.cursor=e,a.cursor=r,(()=>{p=!1;var r=a.cursor;if(a.bra=a.cursor,!a.eq_s("'")||(a.ket=a.cursor,a.slice_del())){a.cursor=r;r=a.cursor;if(a.bra=a.cursor,a.eq_s("y")){if(a.ket=a.cursor,!a.slice_from("Y"))return;p=!0}a.cursor=r;for(r=a.cursor;;){var i=a.cursor;r:{for(;;){var e=a.cursor;if(a.in_grouping(v,97,121)&&(a.bra=a.cursor,a.eq_s("y"))){a.ket=a.cursor,a.cursor=e;break}if(a.cursor=e,a.cursor>=a.limit)break r;a.cursor++}if(!a.slice_from("Y"))return;p=!0;continue}a.cursor=i;break}a.cursor=r}})(),h=a.limit,y=a.limit;i=a.cursor;r:{var s=a.cursor;if(0==a.find_among(c)){if(a.cursor=s,!a.go_out_grouping(v,97,121))break r;if(a.cursor++,!a.go_in_grouping(v,97,121))break r;a.cursor++}h=a.cursor,a.go_out_grouping(v,97,121)&&(a.cursor++,a.go_in_grouping(v,97,121))&&(a.cursor++,y=a.cursor)}a.cursor=i,a.limit_backward=a.cursor,a.cursor=a.limit;var e=a.limit-a.cursor,r=((()=>{var r=a.limit-a.cursor;if(a.ket=a.cursor,0==a.find_among_b(o))a.cursor=a.limit-r;else if(a.bra=a.cursor,!a.slice_del())return;if(a.ket=a.cursor,0!=(r=a.find_among_b(u)))switch(a.bra=a.cursor,r){case 1:if(a.slice_from("ss"))break;return;case 2:r:{var i=a.limit-a.cursor,e=a.cursor-2;if(!(e{a.ket=a.cursor,o=a.find_among_b(n),a.bra=a.cursor;r:{var r=a.limit-a.cursor;i:{switch(o){case 1:var i=a.limit-a.cursor;e:{var e=a.limit-a.cursor;if(0==a.find_among_b(t)||a.cursor>a.limit_backward){if(a.cursor=a.limit-e,!z())break e;if(!a.slice_from("ee"))return}}a.cursor=a.limit-i;break;case 2:break i;case 3:if(0==(o=a.find_among_b(l)))break i;switch(o){case 1:var s=a.limit-a.cursor;if(!a.out_grouping_b(v,97,121))break i;if(a.cursor>a.limit_backward)break i;if(a.cursor=a.limit-s,a.bra=a.cursor,a.slice_from("ie"))break;return;case 2:if(a.cursor>a.limit_backward)break i}}break r}a.cursor=a.limit-r;var c=a.limit-a.cursor;if(!a.go_out_grouping_b(v,97,121))return;if(a.cursor--,a.cursor=a.limit-c,!a.slice_del())return;a.ket=a.cursor,a.bra=a.cursor;var o,c=a.limit-a.cursor;switch(o=a.find_among_b(f)){case 1:return a.slice_from("e");case 2:var u=a.limit-a.cursor;if(a.in_grouping_b(d,97,111)&&!(a.cursor>a.limit_backward))return;a.cursor=a.limit-u;break;case 3:return a.cursor!=h||(u=a.limit-a.cursor,q()&&(a.cursor=a.limit-u,a.slice_from("e")))}if(a.cursor=a.limit-c,a.ket=a.cursor,a.cursor<=a.limit_backward)return;if(a.cursor--,a.bra=a.cursor,!a.slice_del())return}})(),a.cursor=a.limit-r,a.limit-a.cursor),r=(a.ket=a.cursor,e=a.limit-a.cursor,(a.eq_s_b("y")||(a.cursor=a.limit-e,a.eq_s_b("Y")))&&(a.bra=a.cursor,a.out_grouping_b(v,97,121))&&a.cursor>a.limit_backward&&a.slice_from("i"),a.cursor=a.limit-i,a.limit-a.cursor),e=((()=>{var r;if(a.ket=a.cursor,0!=(r=a.find_among_b(_))&&(a.bra=a.cursor,z()))switch(r){case 1:if(a.slice_from("tion"))break;return;case 2:if(a.slice_from("ence"))break;return;case 3:if(a.slice_from("ance"))break;return;case 4:if(a.slice_from("able"))break;return;case 5:if(a.slice_from("ent"))break;return;case 6:if(a.slice_from("ize"))break;return;case 7:if(a.slice_from("ate"))break;return;case 8:if(a.slice_from("al"))break;return;case 9:if(a.slice_from("ful"))break;return;case 10:if(a.slice_from("ous"))break;return;case 11:if(a.slice_from("ive"))break;return;case 12:if(a.slice_from("ble"))break;return;case 13:if(a.slice_from("og"))break;return;case 14:if(!a.eq_s_b("l"))return;if(a.slice_from("og"))break;return;case 15:if(a.slice_from("less"))break;return;case 16:if(!a.in_grouping_b(w,99,116))return;if(a.slice_del())break}})(),a.cursor=a.limit-r,a.limit-a.cursor),i=((()=>{var r;if(a.ket=a.cursor,0!=(r=a.find_among_b(m))&&(a.bra=a.cursor,z()))switch(r){case 1:if(a.slice_from("tion"))break;return;case 2:if(a.slice_from("ate"))break;return;case 3:if(a.slice_from("al"))break;return;case 4:if(a.slice_from("ic"))break;return;case 5:if(a.slice_del())break;return;case 6:if(!Y())return;if(a.slice_del())break}})(),a.cursor=a.limit-e,a.limit-a.cursor),r=((()=>{var r;if(a.ket=a.cursor,0!=(r=a.find_among_b(b))&&(a.bra=a.cursor,Y()))switch(r){case 1:if(a.slice_del())break;return;case 2:var i=a.limit-a.cursor;if(!a.eq_s_b("s")&&(a.cursor=a.limit-i,!a.eq_s_b("t")))return;if(a.slice_del())break}})(),a.cursor=a.limit-i,a.limit-a.cursor),e=((()=>{var r;if(a.ket=a.cursor,0!=(r=a.find_among_b(k)))switch(a.bra=a.cursor,r){case 1:if(!Y()){if(!z())return;var i=a.limit-a.cursor;if(q())return;a.cursor=a.limit-i}if(a.slice_del())break;return;case 2:if(!Y())return;if(!a.eq_s_b("l"))return;if(a.slice_del())break}})(),a.cursor=a.limit-r,a.cursor=a.limit_backward,a.cursor);(()=>{if(p)for(;;){var r=a.cursor;r:{for(;;){var i=a.cursor;if(a.bra=a.cursor,a.eq_s("Y")){a.ket=a.cursor,a.cursor=i;break}if(a.cursor=i,a.cursor>=a.limit)break r;a.cursor++}if(a.slice_from("y"))continue;return}a.cursor=r;break}})(),a.cursor=e}}return!0},this.stemWord=function(r){return a.setCurrent(r),this.stem(),a.getCurrent()}}; -window.Stemmer = EnglishStemmer; +/* Non-minified version is copied as a separate JS file, if available */ + +/** + * Porter Stemmer + */ +var Stemmer = function() { + + var step2list = { + ational: 'ate', + tional: 'tion', + enci: 'ence', + anci: 'ance', + izer: 'ize', + bli: 'ble', + alli: 'al', + entli: 'ent', + eli: 'e', + ousli: 'ous', + ization: 'ize', + ation: 'ate', + ator: 'ate', + alism: 'al', + iveness: 'ive', + fulness: 'ful', + ousness: 'ous', + aliti: 'al', + iviti: 'ive', + biliti: 'ble', + logi: 'log' + }; + + var step3list = { + icate: 'ic', + ative: '', + alize: 'al', + iciti: 'ic', + ical: 'ic', + ful: '', + ness: '' + }; + + var c = "[^aeiou]"; // consonant + var v = "[aeiouy]"; // vowel + var C = c + "[^aeiouy]*"; // consonant sequence + var V = v + "[aeiou]*"; // vowel sequence + + var mgr0 = "^(" + C + ")?" + V + C; // [C]VC... is m>0 + var meq1 = "^(" + C + ")?" + V + C + "(" + V + ")?$"; // [C]VC[V] is m=1 + var mgr1 = "^(" + C + ")?" + V + C + V + C; // [C]VCVC... is m>1 + var s_v = "^(" + C + ")?" + v; // vowel in stem + + this.stemWord = function (w) { + var stem; + var suffix; + var firstch; + var origword = w; + + if (w.length < 3) + return w; + + var re; + var re2; + var re3; + var re4; + + firstch = w.substr(0,1); + if (firstch == "y") + w = firstch.toUpperCase() + w.substr(1); + + // Step 1a + re = /^(.+?)(ss|i)es$/; + re2 = /^(.+?)([^s])s$/; + + if (re.test(w)) + w = w.replace(re,"$1$2"); + else if (re2.test(w)) + w = w.replace(re2,"$1$2"); + + // Step 1b + re = /^(.+?)eed$/; + re2 = /^(.+?)(ed|ing)$/; + if (re.test(w)) { + var fp = re.exec(w); + re = new RegExp(mgr0); + if (re.test(fp[1])) { + re = /.$/; + w = w.replace(re,""); + } + } + else if (re2.test(w)) { + var fp = re2.exec(w); + stem = fp[1]; + re2 = new RegExp(s_v); + if (re2.test(stem)) { + w = stem; + re2 = /(at|bl|iz)$/; + re3 = new RegExp("([^aeiouylsz])\\1$"); + re4 = new RegExp("^" + C + v + "[^aeiouwxy]$"); + if (re2.test(w)) + w = w + "e"; + else if (re3.test(w)) { + re = /.$/; + w = w.replace(re,""); + } + else if (re4.test(w)) + w = w + "e"; + } + } + + // Step 1c + re = /^(.+?)y$/; + if (re.test(w)) { + var fp = re.exec(w); + stem = fp[1]; + re = new RegExp(s_v); + if (re.test(stem)) + w = stem + "i"; + } + + // Step 2 + re = /^(.+?)(ational|tional|enci|anci|izer|bli|alli|entli|eli|ousli|ization|ation|ator|alism|iveness|fulness|ousness|aliti|iviti|biliti|logi)$/; + if (re.test(w)) { + var fp = re.exec(w); + stem = fp[1]; + suffix = fp[2]; + re = new RegExp(mgr0); + if (re.test(stem)) + w = stem + step2list[suffix]; + } + + // Step 3 + re = /^(.+?)(icate|ative|alize|iciti|ical|ful|ness)$/; + if (re.test(w)) { + var fp = re.exec(w); + stem = fp[1]; + suffix = fp[2]; + re = new RegExp(mgr0); + if (re.test(stem)) + w = stem + step3list[suffix]; + } + + // Step 4 + re = /^(.+?)(al|ance|ence|er|ic|able|ible|ant|ement|ment|ent|ou|ism|ate|iti|ous|ive|ize)$/; + re2 = /^(.+?)(s|t)(ion)$/; + if (re.test(w)) { + var fp = re.exec(w); + stem = fp[1]; + re = new RegExp(mgr1); + if (re.test(stem)) + w = stem; + } + else if (re2.test(w)) { + var fp = re2.exec(w); + stem = fp[1] + fp[2]; + re2 = new RegExp(mgr1); + if (re2.test(stem)) + w = stem; + } + + // Step 5 + re = /^(.+?)e$/; + if (re.test(w)) { + var fp = re.exec(w); + stem = fp[1]; + re = new RegExp(mgr1); + re2 = new RegExp(meq1); + re3 = new RegExp("^" + C + v + "[^aeiouwxy]$"); + if (re.test(stem) || (re2.test(stem) && !(re3.test(stem)))) + w = stem; + } + re = /ll$/; + re2 = new RegExp(mgr1); + if (re.test(w) && re2.test(w)) { + re = /.$/; + w = w.replace(re,""); + } + + // and turn initial Y back to y + if (firstch == "y") + w = firstch.toLowerCase() + w.substr(1); + return w; + } +} + diff --git a/docs/_static/searchtools.js b/docs/_static/searchtools.js index e29b1c754..2c774d17a 100644 --- a/docs/_static/searchtools.js +++ b/docs/_static/searchtools.js @@ -41,12 +41,11 @@ if (typeof Scorer === "undefined") { } // Global search result kind enum, used by themes to style search results. -// prettier-ignore class SearchResultKind { - static get index() { return "index"; } - static get object() { return "object"; } - static get text() { return "text"; } - static get title() { return "title"; } + static get index() { return "index"; } + static get object() { return "object"; } + static get text() { return "text"; } + static get title() { return "title"; } } const _removeChildren = (element) => { @@ -59,15 +58,6 @@ const _removeChildren = (element) => { const _escapeRegExp = (string) => string.replace(/[.*+\-?^${}()|[\]\\]/g, "\\$&"); // $& means the whole matched string -const _escapeHTML = (text) => { - return text - .replaceAll("&", "&") - .replaceAll("<", "<") - .replaceAll(">", ">") - .replaceAll('"', """) - .replaceAll("'", "'"); -}; - const _displayItem = (item, searchTerms, highlightTerms) => { const docBuilder = DOCUMENTATION_OPTIONS.BUILDER; const docFileSuffix = DOCUMENTATION_OPTIONS.FILE_SUFFIX; @@ -100,30 +90,25 @@ const _displayItem = (item, searchTerms, highlightTerms) => { let linkEl = listItem.appendChild(document.createElement("a")); linkEl.href = linkUrl + anchor; linkEl.dataset.score = score; - linkEl.innerHTML = _escapeHTML(title); + linkEl.innerHTML = title; if (descr) { listItem.appendChild(document.createElement("span")).innerHTML = - ` (${_escapeHTML(descr)})`; + " (" + descr + ")"; // highlight search terms in the description - if (SPHINX_HIGHLIGHT_ENABLED) - // SPHINX_HIGHLIGHT_ENABLED is set in sphinx_highlight.js - highlightTerms.forEach((term) => - _highlightText(listItem, term, "highlighted"), - ); - } else if (showSearchSummary) + if (SPHINX_HIGHLIGHT_ENABLED) // set in sphinx_highlight.js + highlightTerms.forEach((term) => _highlightText(listItem, term, "highlighted")); + } + else if (showSearchSummary) fetch(requestUrl) .then((responseData) => responseData.text()) .then((data) => { if (data) listItem.appendChild( - Search.makeSearchSummary(data, searchTerms, anchor), + Search.makeSearchSummary(data, searchTerms, anchor) ); // highlight search terms in the summary - if (SPHINX_HIGHLIGHT_ENABLED) - // SPHINX_HIGHLIGHT_ENABLED is set in sphinx_highlight.js - highlightTerms.forEach((term) => - _highlightText(listItem, term, "highlighted"), - ); + if (SPHINX_HIGHLIGHT_ENABLED) // set in sphinx_highlight.js + highlightTerms.forEach((term) => _highlightText(listItem, term, "highlighted")); }); Search.output.appendChild(listItem); }; @@ -132,14 +117,14 @@ const _finishSearch = (resultCount) => { Search.title.innerText = _("Search Results"); if (!resultCount) Search.status.innerText = Documentation.gettext( - "Your search did not match any documents. Please make sure that all words are spelled correctly and that you've selected enough categories.", + "Your search did not match any documents. Please make sure that all words are spelled correctly and that you've selected enough categories." ); else Search.status.innerText = Documentation.ngettext( "Search finished, found one page matching the search query.", "Search finished, found ${resultCount} pages matching the search query.", resultCount, - ).replace("${resultCount}", resultCount); + ).replace('${resultCount}', resultCount); }; const _displayNextItem = ( results, @@ -153,7 +138,7 @@ const _displayNextItem = ( _displayItem(results.pop(), searchTerms, highlightTerms); setTimeout( () => _displayNextItem(results, resultCount, searchTerms, highlightTerms), - 5, + 5 ); } // search finished, update title and status message @@ -185,10 +170,9 @@ const _orderResultsByScoreThenName = (a, b) => { * This is the same as ``\W+`` in Python, preserving the surrogate pair area. */ if (typeof splitQuery === "undefined") { - var splitQuery = (query) => - query + var splitQuery = (query) => query .split(/[^\p{Letter}\p{Number}_\p{Emoji_Presentation}]+/gu) - .filter((term) => term); // remove remaining empty strings + .filter(term => term) // remove remaining empty strings } /** @@ -200,23 +184,16 @@ const Search = { _pulse_status: -1, htmlToText: (htmlString, anchor) => { - const htmlElement = new DOMParser().parseFromString( - htmlString, - "text/html", - ); + const htmlElement = new DOMParser().parseFromString(htmlString, 'text/html'); for (const removalQuery of [".headerlink", "script", "style"]) { - htmlElement.querySelectorAll(removalQuery).forEach((el) => { - el.remove(); - }); + htmlElement.querySelectorAll(removalQuery).forEach((el) => { el.remove() }); } if (anchor) { - const anchorContent = htmlElement.querySelector( - `[role="main"] ${anchor}`, - ); + const anchorContent = htmlElement.querySelector(`[role="main"] ${anchor}`); if (anchorContent) return anchorContent.textContent; console.warn( - `Anchored content block not found. Sphinx search tries to obtain it via DOM query '[role=main] ${anchor}'. Check your theme or template.`, + `Anchored content block not found. Sphinx search tries to obtain it via DOM query '[role=main] ${anchor}'. Check your theme or template.` ); } @@ -225,7 +202,7 @@ const Search = { if (docContent) return docContent.textContent; console.warn( - "Content block not found. Sphinx search tries to obtain it via DOM query '[role=main]'. Check your theme or template.", + "Content block not found. Sphinx search tries to obtain it via DOM query '[role=main]'. Check your theme or template." ); return ""; }, @@ -310,8 +287,12 @@ const Search = { const queryTermLower = queryTerm.toLowerCase(); // maybe skip this "word" - // stopwords set is from language_data.js - if (stopwords.has(queryTermLower) || queryTerm.match(/^\d+$/)) return; + // stopwords array is from language_data.js + if ( + stopwords.indexOf(queryTermLower) !== -1 || + queryTerm.match(/^\d+$/) + ) + return; // stem the word let word = stemmer.stemWord(queryTermLower); @@ -323,12 +304,8 @@ const Search = { } }); - if (SPHINX_HIGHLIGHT_ENABLED) { - // SPHINX_HIGHLIGHT_ENABLED is set in sphinx_highlight.js - localStorage.setItem( - "sphinx_highlight_terms", - [...highlightTerms].join(" "), - ); + if (SPHINX_HIGHLIGHT_ENABLED) { // set in sphinx_highlight.js + localStorage.setItem("sphinx_highlight_terms", [...highlightTerms].join(" ")) } // console.debug("SEARCH: searching for:"); @@ -341,13 +318,7 @@ const Search = { /** * execute search (requires search index to be loaded) */ - _performSearch: ( - query, - searchTerms, - excludedTerms, - highlightTerms, - objectTerms, - ) => { + _performSearch: (query, searchTerms, excludedTerms, highlightTerms, objectTerms) => { const filenames = Search._index.filenames; const docNames = Search._index.docnames; const titles = Search._index.titles; @@ -363,15 +334,10 @@ const Search = { const queryLower = query.toLowerCase().trim(); for (const [title, foundTitles] of Object.entries(allTitles)) { - if ( - title.toLowerCase().trim().includes(queryLower) - && queryLower.length >= title.length / 2 - ) { + if (title.toLowerCase().trim().includes(queryLower) && (queryLower.length >= title.length/2)) { for (const [file, id] of foundTitles) { - const score = Math.round( - (Scorer.title * queryLower.length) / title.length, - ); - const boost = titles[file] === title ? 1 : 0; // add a boost for document titles + const score = Math.round(Scorer.title * queryLower.length / title.length); + const boost = titles[file] === title ? 1 : 0; // add a boost for document titles normalResults.push([ docNames[file], titles[file] !== title ? `${titles[file]} > ${title}` : title, @@ -387,9 +353,9 @@ const Search = { // search for explicit entries in index directives for (const [entry, foundEntries] of Object.entries(indexEntries)) { - if (entry.includes(queryLower) && queryLower.length >= entry.length / 2) { + if (entry.includes(queryLower) && (queryLower.length >= entry.length/2)) { for (const [file, id, isMain] of foundEntries) { - const score = Math.round((100 * queryLower.length) / entry.length); + const score = Math.round(100 * queryLower.length / entry.length); const result = [ docNames[file], titles[file], @@ -410,13 +376,11 @@ const Search = { // lookup as object objectTerms.forEach((term) => - normalResults.push(...Search.performObjectSearch(term, objectTerms)), + normalResults.push(...Search.performObjectSearch(term, objectTerms)) ); // lookup as search terms in fulltext - normalResults.push( - ...Search.performTermsSearch(searchTerms, excludedTerms), - ); + normalResults.push(...Search.performTermsSearch(searchTerms, excludedTerms)); // let the scorer override scores with a custom scoring function if (Scorer.score) { @@ -437,11 +401,7 @@ const Search = { // note the reversing of results, so that in the case of duplicates, the highest-scoring entry is kept let seen = new Set(); results = results.reverse().reduce((acc, result) => { - let resultStr = result - .slice(0, 4) - .concat([result[5]]) - .map((v) => String(v)) - .join(","); + let resultStr = result.slice(0, 4).concat([result[5]]).map(v => String(v)).join(','); if (!seen.has(resultStr)) { acc.push(result); seen.add(resultStr); @@ -453,20 +413,8 @@ const Search = { }, query: (query) => { - const [ - searchQuery, - searchTerms, - excludedTerms, - highlightTerms, - objectTerms, - ] = Search._parseQuery(query); - const results = Search._performSearch( - searchQuery, - searchTerms, - excludedTerms, - highlightTerms, - objectTerms, - ); + const [searchQuery, searchTerms, excludedTerms, highlightTerms, objectTerms] = Search._parseQuery(query); + const results = Search._performSearch(searchQuery, searchTerms, excludedTerms, highlightTerms, objectTerms); // for debugging //Search.lastresults = results.slice(); // a copy @@ -489,7 +437,7 @@ const Search = { const results = []; const objectSearchCallback = (prefix, match) => { - const name = match[4]; + const name = match[4] const fullname = (prefix ? prefix + "." : "") + name; const fullnameLower = fullname.toLowerCase(); if (fullnameLower.indexOf(object) < 0) return; @@ -541,7 +489,9 @@ const Search = { ]); }; Object.keys(objects).forEach((prefix) => - objects[prefix].forEach((array) => objectSearchCallback(prefix, array)), + objects[prefix].forEach((array) => + objectSearchCallback(prefix, array) + ) ); return results; }, @@ -563,17 +513,9 @@ const Search = { // perform the search on the required terms searchTerms.forEach((word) => { const files = []; - // find documents, if any, containing the query word in their text/title term indices - // use Object.hasOwnProperty to avoid mismatching against prototype properties const arr = [ - { - files: terms.hasOwnProperty(word) ? terms[word] : undefined, - score: Scorer.term, - }, - { - files: titleTerms.hasOwnProperty(word) ? titleTerms[word] : undefined, - score: Scorer.title, - }, + { files: terms[word], score: Scorer.term }, + { files: titleTerms[word], score: Scorer.title }, ]; // add support for partial matches if (word.length > 2) { @@ -605,17 +547,15 @@ const Search = { // set score for the word in each file recordFiles.forEach((file) => { - if (!scoreMap.has(file)) scoreMap.set(file, new Map()); - const fileScores = scoreMap.get(file); - fileScores.set(word, record.score); + if (!scoreMap.has(file)) scoreMap.set(file, {}); + scoreMap.get(file)[word] = record.score; }); }); // create the mapping files.forEach((file) => { if (!fileMap.has(file)) fileMap.set(file, [word]); - else if (fileMap.get(file).indexOf(word) === -1) - fileMap.get(file).push(word); + else if (fileMap.get(file).indexOf(word) === -1) fileMap.get(file).push(word); }); }); @@ -626,11 +566,11 @@ const Search = { // as search terms with length < 3 are discarded const filteredTermCount = [...searchTerms].filter( - (term) => term.length > 2, + (term) => term.length > 2 ).length; if ( - wordList.length !== searchTerms.size - && wordList.length !== filteredTermCount + wordList.length !== searchTerms.size && + wordList.length !== filteredTermCount ) continue; @@ -638,16 +578,16 @@ const Search = { if ( [...excludedTerms].some( (term) => - terms[term] === file - || titleTerms[term] === file - || (terms[term] || []).includes(file) - || (titleTerms[term] || []).includes(file), + terms[term] === file || + titleTerms[term] === file || + (terms[term] || []).includes(file) || + (titleTerms[term] || []).includes(file) ) ) break; // select one (max) score for the file. - const score = Math.max(...wordList.map((w) => scoreMap.get(file).get(w))); + const score = Math.max(...wordList.map((w) => scoreMap.get(file)[w])); // add result to the result list results.push([ docNames[file], @@ -683,8 +623,7 @@ const Search = { let summary = document.createElement("p"); summary.classList.add("context"); - summary.textContent = - top + text.substr(startWithContext, 240).trim() + tail; + summary.textContent = top + text.substr(startWithContext, 240).trim() + tail; return summary; }, diff --git a/docs/_static/sphinx_highlight.js b/docs/_static/sphinx_highlight.js index a74e103a8..8a96c69a1 100644 --- a/docs/_static/sphinx_highlight.js +++ b/docs/_static/sphinx_highlight.js @@ -1,7 +1,7 @@ /* Highlighting utilities for Sphinx HTML documentation. */ "use strict"; -const SPHINX_HIGHLIGHT_ENABLED = true; +const SPHINX_HIGHLIGHT_ENABLED = true /** * highlight a given string on a node by wrapping it in @@ -13,9 +13,9 @@ const _highlight = (node, addItems, text, className) => { const parent = node.parentNode; const pos = val.toLowerCase().indexOf(text); if ( - pos >= 0 - && !parent.classList.contains(className) - && !parent.classList.contains("nohighlight") + pos >= 0 && + !parent.classList.contains(className) && + !parent.classList.contains("nohighlight") ) { let span; @@ -30,7 +30,13 @@ const _highlight = (node, addItems, text, className) => { span.appendChild(document.createTextNode(val.substr(pos, text.length))); const rest = document.createTextNode(val.substr(pos + text.length)); - parent.insertBefore(span, parent.insertBefore(rest, node.nextSibling)); + parent.insertBefore( + span, + parent.insertBefore( + rest, + node.nextSibling + ) + ); node.nodeValue = val.substr(0, pos); /* There may be more occurrences of search term in this node. So call this * function recursively on the remaining fragment. @@ -40,7 +46,7 @@ const _highlight = (node, addItems, text, className) => { if (isInSVG) { const rect = document.createElementNS( "http://www.w3.org/2000/svg", - "rect", + "rect" ); const bbox = parent.getBBox(); rect.x.baseVal.value = bbox.x; @@ -59,7 +65,7 @@ const _highlightText = (thisNode, text, className) => { let addItems = []; _highlight(thisNode, addItems, text, className); addItems.forEach((obj) => - obj.parent.insertAdjacentElement("beforebegin", obj.target), + obj.parent.insertAdjacentElement("beforebegin", obj.target) ); }; @@ -67,31 +73,25 @@ const _highlightText = (thisNode, text, className) => { * Small JavaScript module for the documentation. */ const SphinxHighlight = { + /** * highlight the search words provided in localstorage in the text */ highlightSearchWords: () => { - if (!SPHINX_HIGHLIGHT_ENABLED) return; // bail if no highlight + if (!SPHINX_HIGHLIGHT_ENABLED) return; // bail if no highlight // get and clear terms from localstorage const url = new URL(window.location); const highlight = - localStorage.getItem("sphinx_highlight_terms") - || url.searchParams.get("highlight") - || ""; - localStorage.removeItem("sphinx_highlight_terms"); - // Update history only if '?highlight' is present; otherwise it - // clears text fragments (not set in window.location by the browser) - if (url.searchParams.has("highlight")) { - url.searchParams.delete("highlight"); - window.history.replaceState({}, "", url); - } + localStorage.getItem("sphinx_highlight_terms") + || url.searchParams.get("highlight") + || ""; + localStorage.removeItem("sphinx_highlight_terms") + url.searchParams.delete("highlight"); + window.history.replaceState({}, "", url); // get individual terms from highlight string - const terms = highlight - .toLowerCase() - .split(/\s+/) - .filter((x) => x); + const terms = highlight.toLowerCase().split(/\s+/).filter(x => x); if (terms.length === 0) return; // nothing to do // There should never be more than one element matching "div.body" @@ -107,11 +107,11 @@ const SphinxHighlight = { document .createRange() .createContextualFragment( - '

' - + '' - + _("Hide Search Matches") - + "

", - ), + '

' + + '' + + _("Hide Search Matches") + + "

" + ) ); }, @@ -125,7 +125,7 @@ const SphinxHighlight = { document .querySelectorAll("span.highlighted") .forEach((el) => el.classList.remove("highlighted")); - localStorage.removeItem("sphinx_highlight_terms"); + localStorage.removeItem("sphinx_highlight_terms") }, initEscapeListener: () => { @@ -134,15 +134,10 @@ const SphinxHighlight = { document.addEventListener("keydown", (event) => { // bail for input elements - if (BLACKLISTED_KEY_CONTROL_ELEMENTS.has(document.activeElement.tagName)) - return; + if (BLACKLISTED_KEY_CONTROL_ELEMENTS.has(document.activeElement.tagName)) return; // bail with special keys - if (event.shiftKey || event.altKey || event.ctrlKey || event.metaKey) - return; - if ( - DOCUMENTATION_OPTIONS.ENABLE_SEARCH_SHORTCUTS - && event.key === "Escape" - ) { + if (event.shiftKey || event.altKey || event.ctrlKey || event.metaKey) return; + if (DOCUMENTATION_OPTIONS.ENABLE_SEARCH_SHORTCUTS && (event.key === "Escape")) { SphinxHighlight.hideSearchWords(); event.preventDefault(); } diff --git a/docs/advanced_installation.html b/docs/advanced_installation.html index dfc2db4a2..62c8eb6bf 100644 --- a/docs/advanced_installation.html +++ b/docs/advanced_installation.html @@ -14,8 +14,8 @@ - - + + diff --git a/docs/api.html b/docs/api.html index 4a8b3a748..440342e64 100644 --- a/docs/api.html +++ b/docs/api.html @@ -14,8 +14,8 @@ - - + + diff --git a/docs/comet.html b/docs/comet.html index e06c7f5ff..005bc2b93 100644 --- a/docs/comet.html +++ b/docs/comet.html @@ -14,8 +14,8 @@ - - + + diff --git a/docs/edit/installation.rst b/docs/edit/installation.rst index 4539c5ffc..5267b000c 100755 --- a/docs/edit/installation.rst +++ b/docs/edit/installation.rst @@ -3,6 +3,7 @@ Installing CodeCarbon ===================== + From PyPi repository -------------------- @@ -57,3 +58,18 @@ The following packages are used by the CodeCarbon package, and will be installed Please refer to `pyproject.toml `_ for the latest list of the packages used. + +(Non-Python users) Standalone installer +--------------------------------------- +If you are not using Python but you still would like to run CodeCarbon (for instance to use the :ref:`CodeCarbon Command line `), we provide a standalone installer to download and install CodeCarbon on your machine. + +Use curl to download the script and execute it with sh: + +.. code-block:: bash + + curl -LsSf https://codecarbon.io/scripts/install.sh | sh +or for Windows users, using powershell: + +.. code-block:: powershell + + powershell -ExecutionPolicy ByPass -c "irm https://codecarbon.io/scripts/install.ps1 | iex" \ No newline at end of file diff --git a/docs/edit/usage.rst b/docs/edit/usage.rst index 63774359a..c2373af0b 100644 --- a/docs/edit/usage.rst +++ b/docs/edit/usage.rst @@ -11,6 +11,8 @@ Online Mode When the environment has internet access, the ``EmissionsTracker`` object or the ``track_emissions`` decorator can be used, which has the ``offline`` parameter set to ``False`` by default. +.. _usage-command-line: + Command line ~~~~~~~~~~~~ diff --git a/docs/examples.html b/docs/examples.html index 082f325d4..4a38c109d 100644 --- a/docs/examples.html +++ b/docs/examples.html @@ -14,8 +14,8 @@ - - + + diff --git a/docs/faq.html b/docs/faq.html index c8b8abe84..397e1edeb 100644 --- a/docs/faq.html +++ b/docs/faq.html @@ -14,8 +14,8 @@ - - + + diff --git a/docs/genindex.html b/docs/genindex.html index fb72a6399..386aceaaa 100644 --- a/docs/genindex.html +++ b/docs/genindex.html @@ -13,8 +13,8 @@ - - + + diff --git a/docs/index.html b/docs/index.html index e6440f8d5..1af591d91 100644 --- a/docs/index.html +++ b/docs/index.html @@ -14,8 +14,9 @@ - - + + + @@ -134,6 +135,7 @@

CodeCarbonFrom PyPi repository
  • Using Conda environments
  • Dependencies
    • +
  • (Non-Python users) Standalone installer
  • Quickstart
  • Quickstart
    • @@ -144,6 +145,18 @@

    Dependenciespyproject.toml for the latest list of the packages used.

    +
    +

    (Non-Python users) Standalone installer

    +

    If you are not using Python but you still would like to run CodeCarbon (for instance to use the CodeCarbon Command line)), we provide a standalone installer to download and install CodeCarbon on your machine.

    +

    Use curl to download the script and execute it with sh:

    +
    curl -LsSf https://codecarbon.io/scripts/install.sh | sh
+
    +
    +

    or for Windows users, using powershell:

    +
    powershell -ExecutionPolicy ByPass -c "irm https://codecarbon.io/scripts/install.ps1 | iex"
+
    +
    +
    diff --git a/docs/methodology.html b/docs/methodology.html index 096b9acfa..68d10d533 100644 --- a/docs/methodology.html +++ b/docs/methodology.html @@ -14,9 +14,9 @@ - - - + + + diff --git a/docs/model_examples.html b/docs/model_examples.html index 869ce21ab..2cd35de91 100644 --- a/docs/model_examples.html +++ b/docs/model_examples.html @@ -14,8 +14,8 @@ - - + + diff --git a/docs/motivation.html b/docs/motivation.html index fd67d5230..d1ee39de9 100644 --- a/docs/motivation.html +++ b/docs/motivation.html @@ -14,8 +14,8 @@ - - + + diff --git a/docs/objects.inv b/docs/objects.inv index a959c98a5..f554d65bc 100644 Binary files a/docs/objects.inv and b/docs/objects.inv differ diff --git a/docs/output.html b/docs/output.html index 6a3acc2a0..bfef35b3a 100644 --- a/docs/output.html +++ b/docs/output.html @@ -14,8 +14,8 @@ - - + + diff --git a/docs/parameters.html b/docs/parameters.html index ee5ef8fa4..d1af8b810 100644 --- a/docs/parameters.html +++ b/docs/parameters.html @@ -14,8 +14,8 @@ - - + + diff --git a/docs/rapl.html b/docs/rapl.html index 8cca08d92..3f9aeea99 100644 --- a/docs/rapl.html +++ b/docs/rapl.html @@ -14,8 +14,8 @@ - - + + diff --git a/docs/search.html b/docs/search.html index 43cca792b..f5e39133c 100644 --- a/docs/search.html +++ b/docs/search.html @@ -14,8 +14,8 @@ - - + + diff --git a/docs/searchindex.js b/docs/searchindex.js index cd2ac86ad..58bdb4cce 100644 --- a/docs/searchindex.js +++ b/docs/searchindex.js @@ -1 +1 @@ -Search.setIndex({"alltitles":{"@track_emissions":[[11,"track-emissions"]],"Access internet through proxy server":[[15,"access-internet-through-proxy-server"]],"Advanced Installation":[[0,null]],"Authentication":[[14,"authentication"]],"Available RAPL Domains":[[12,"available-rapl-domains"]],"CPU":[[7,"cpu"]],"CPU hardware":[[7,"cpu-hardware"]],"CPU metrics priority":[[7,"cpu-metrics-priority"]],"CSV":[[10,"csv"]],"Calculation Formula":[[7,"calculation-formula"]],"Car Usage":[[7,"car-usage"]],"Carbon Intensity":[[7,"carbon-intensity"]],"Carbon Intensity Across Energy Sources":[[7,"id2"]],"Cloud Regions":[[16,"cloud-regions"]],"CodeCarbon":[[5,null]],"CodeCarbon API":[[1,null],[1,"id1"],[10,"codecarbon-api"]],"CodeCarbon\u2019s RAPL Strategy":[[12,"codecarbon-s-rapl-strategy"]],"Collecting emissions to a logger":[[14,null]],"Comet Integration":[[2,null]],"Command line":[[15,"command-line"]],"Comparisons":[[8,"comparisons"]],"Configuration":[[15,"configuration"]],"Configuration priority":[[15,"configuration-priority"]],"Context manager":[[15,"context-manager"],[15,"id2"]],"Create a logger":[[14,"create-a-logger"]],"Create an EmissionTracker":[[14,"create-an-emissiontracker"]],"Data Fields Logged for Each Experiment":[[10,"id4"]],"Decorator":[[15,"decorator"],[15,"id3"]],"Dependencies":[[6,"dependencies"]],"Deploy CodeCarbon CLI as a Service using Ansible":[[0,"deploy-codecarbon-cli-as-a-service-using-ansible"]],"Desktop: AMD Ryzen Threadripper 1950X (16-Core, 32 threads, Multi-die)":[[12,"desktop-amd-ryzen-threadripper-1950x-16-core-32-threads-multi-die"]],"Directory Structure":[[0,"directory-structure"]],"Electricity consumption of AI cloud instance":[[8,"id1"]],"Electricity production carbon intensity per country":[[16,"electricity-production-carbon-intensity-per-country"]],"Estimation of Equivalent Usage Emissions":[[7,"estimation-of-equivalent-usage-emissions"]],"Example":[[14,"example"]],"Examples":[[3,null]],"Explicit Object":[[15,"explicit-object"],[15,"id1"]],"Frequently Asked Questions":[[4,null]],"From PyPi repository":[[6,"from-pypi-repository"]],"GPU":[[7,"gpu"]],"Getting Started":[[5,null]],"Google Cloud Logging":[[14,"google-cloud-logging"]],"HTTP Output":[[10,"http-output"]],"How CodeCarbon Works":[[7,"how-codecarbon-works"]],"How to test in local":[[10,"how-to-test-in-local"]],"How to use it":[[10,"how-to-use-it"]],"Impact of time of year and region":[[8,"impact-of-time-of-year-and-region"]],"Indices and tables":[[5,"indices-and-tables"]],"Input Parameters":[[11,"input-parameters"],[11,"id6"]],"Input Parameters to @track_emissions":[[11,"id9"]],"Input Parameters to OfflineEmissionsTracker":[[11,"id8"]],"Install CodeCarbon as a Linux service":[[0,"install-codecarbon-as-a-linux-service"]],"Installation":[[16,"installation"]],"Installing CodeCarbon":[[6,null]],"Introduction":[[5,null]],"Key Takeaways for RAPL Measurements":[[12,"key-takeaways-for-rapl-measurements"]],"Laptop: Intel(R) Core(TM) Ultra 7 265H (TDP 28W)":[[12,"laptop-intel-r-core-tm-ultra-7-265h-tdp-28w"]],"Laptop: Intel(R) Core(TM) i7-7600U (TDP 15W, 7th Gen Kaby Lake)":[[12,"laptop-intel-r-core-tm-i7-7600u-tdp-15w-7th-gen-kaby-lake"]],"Logfire":[[10,"logfire"]],"Logger Output":[[10,"logger-output"]],"Logging":[[5,null]],"Methodology":[[7,null]],"Model Comparisons":[[8,null]],"Motivation":[[9,null]],"Offline":[[16,"offline"]],"Offline Mode":[[15,"offline-mode"]],"Online":[[16,"online"]],"Online Mode":[[15,"online-mode"]],"Output":[[10,null]],"Output Parameters":[[11,"id7"]],"Output parameters":[[11,"output-parameters"]],"Parameters":[[11,null]],"Platform-Specific Behavior":[[12,"platform-specific-behavior"]],"Power Usage":[[7,"power-usage"]],"Prerequisites":[[0,"prerequisites"]],"Prometheus":[[10,"prometheus"]],"Python logger":[[14,"python-logger"]],"Quick Start":[[0,"quick-start"]],"Quickstart":[[15,null]],"RAM":[[7,"ram"]],"RAPL Domain Architecture":[[12,"rapl-domain-architecture"]],"RAPL Domain Hierarchy and Double-Counting":[[12,"rapl-domain-hierarchy-and-double-counting"]],"RAPL Measurements: Real-World Examples":[[12,"rapl-measurements-real-world-examples"]],"RAPL Metrics":[[7,"rapl-metrics"],[12,null]],"References":[[7,"references"],[8,"references"]],"Regional Comparisons":[[16,"regional-comparisons"]],"Running Any Command with CodeCarbon":[[15,"running-any-command-with-codecarbon"]],"Source Code":[[7,"source-code"]],"Specific parameters for offline mode":[[11,"specific-parameters-for-offline-mode"]],"Summary and Equivalents":[[16,"summary-and-equivalents"]],"TV Usage":[[7,"tv-usage"]],"Test of CodeCarbon on Scaleway hardware":[[13,null]],"US Citizen Weekly Emissions":[[7,"us-citizen-weekly-emissions"]],"Usage":[[16,"usage"]],"Using CodeCarbon with logfire":[[10,"using-codecarbon-with-logfire"]],"Using CodeCarbon with prometheus":[[10,"using-codecarbon-with-prometheus"]],"Using Conda environments":[[6,"using-conda-environments"]],"Using the Context Manager":[[3,"using-the-context-manager"]],"Using the Decorator":[[3,"using-the-decorator"]],"Using the Explicit Object":[[3,"using-the-explicit-object"]],"Visualize":[[16,null]],"What the Playbook Does":[[0,"what-the-playbook-does"]],"detailed":[[16,"detailed"]],"from global\u2026":[[16,"from-global"]],"to more and more\u2026":[[16,"to-more-and-more"]]},"docnames":["advanced_installation","api","comet","examples","faq","index","installation","methodology","model_examples","motivation","output","parameters","rapl","test_on_scaleway","to_logger","usage","visualize"],"envversion":{"sphinx":66,"sphinx.domains.c":3,"sphinx.domains.changeset":1,"sphinx.domains.citation":1,"sphinx.domains.cpp":9,"sphinx.domains.index":1,"sphinx.domains.javascript":3,"sphinx.domains.math":2,"sphinx.domains.python":4,"sphinx.domains.rst":2,"sphinx.domains.std":2},"filenames":["advanced_installation.rst","api.rst","comet.rst","examples.rst","faq.rst","index.rst","installation.rst","methodology.rst","model_examples.rst","motivation.rst","output.rst","parameters.rst","rapl.rst","test_on_scaleway.rst","to_logger.rst","usage.rst","visualize.rst"],"indexentries":{},"objects":{},"objnames":{},"objtypes":{},"terms":{"00w":12,"02w":12,"04w":12,"07w":12,"100w":12,"1065g7":10,"10th":12,"10w":7,"128gb":7,"131w":12,"14w":12,"1tb":7,"20w":7,"21w":12,"22w":12,"235b1da5":15,"23w":12,"27w":12,"280w":12,"2w":12,"30ghz":10,"31w":12,"32gb":7,"35w":12,"37w":12,"3w":7,"3x":12,"40ghz":13,"40w":[7,12],"44w":12,"46w":12,"47w":12,"4f":3,"4gib":7,"4w":12,"54w":12,"5w":[7,12],"60s":13,"64gb":7,"66w":12,"69w":12,"6b":8,"6w":12,"73w":12,"7600u":7,"77778e":7,"8024p":13,"85w":12,"88w":12,"893681599d2c":15,"8gb":7,"8w":12,"8x128gb":7,"97w":12,"A":[7,11,14,15,16],"ALL":7,"After":0,"All":[7,12],"An":[3,7,15],"And":[1,2],"As":[7,9,12],"Below":12,"But":[3,4,7],"By":[10,12],"Do":15,"Each":[12,16],"For":[4,7,9,10,11,12,13,15],"From":[2,5],"Here":[7,8],"How":4,"I":[4,12],"IT":4,"If":[3,4,6,7,10,11,12,15,16],"In":[1,2,7,8,9,11,14,15],"It":[0,1,4,7,10,14,15,16],"More":[1,12],"Most":12,"NOT":12,"No":12,"OR":12,"On":[7,8,12],"Or":[1,15],"Other":[3,12,14],"Our":7,"So":[7,10,12],"Some":7,"The":[0,1,3,6,7,8,10,11,12,14,15,16],"Then":[1,7],"There":[4,7,12],"These":[7,11],"They":[7,12],"This":[0,1,3,7,9,10,12,14,15],"To":[0,2,6,7,13],"Under":12,"We":[3,4,6,7,12,13],"What":[4,12],"When":[4,7,11,12,15],"While":[6,12],"With":9,"Would":12,"YOUR":2,"You":[0,1,2,3,7,10,13,15],"_":15,"__main__":[1,3],"__name__":[1,3],"_channel":14,"_logger":14,"_scheduler_monitor_pow":7,"a100":8,"aaaa":15,"abl":[2,10],"abov":[0,6,7,12],"absenc":15,"access":[0,5,7,12],"account":[0,1,2,7],"accur":[4,7,12],"accuraci":[3,7,12],"achiev":9,"acm":12,"across":[8,9,10,12,16],"action":12,"activ":[3,6,7,16],"actual":[4,7,12],"adam":3,"add":[2,3,4,7,11,12,13,14],"addhandl":14,"addit":[7,11,15,16],"administr":7,"advanc":[5,9],"affect":[11,12],"agenc":[7,8],"agent":12,"ai":9,"alert":10,"algorithm":7,"allow":[10,11,14,15],"allow_multiple_run":11,"alon":12,"along":[2,6,15],"alongsid":2,"alphabet":[10,15],"also":[9,14,15,16],"although":4,"alway":[0,3],"amazon":4,"amd":[7,13],"american":16,"amount":[7,9,16],"analysi":12,"analyz":4,"ani":[4,7],"annual":7,"anoth":[7,8,16],"ansibl":5,"ansible_ssh_private_key_fil":0,"ansible_us":0,"anymor":7,"api":[0,2,5,11,15,16],"api_call_interv":[0,1,11,15],"api_endpoint":[0,11],"api_key":[0,2,11],"app":[15,16],"appear":[10,12],"append":11,"appl":7,"appli":7,"applic":15,"approach":[7,9,12],"approx":7,"approxim":7,"apr":12,"apt":[0,13],"architectur":5,"argument":[11,15,16],"arm":7,"arrow":6,"art":9,"artifact":[2,11],"artifici":9,"asia":10,"ask":[5,10],"associ":7,"assum":7,"assumpt":7,"astral":13,"attribut":15,"auth":10,"autom":0,"automat":[2,3,7,11,12],"avail":[3,4,5,7,10,11,13,14,15,16],"averag":[0,4,7,8,10,12,16],"avoid":12,"aw":10,"awar":[7,15],"azur":[8,10],"b112x":13,"back":[2,7,12,13],"background":3,"backward":16,"bar":16,"barchart":16,"base":[0,7,8,10,12,14,15],"baselin":12,"baseoutput":10,"bash":15,"batteri":12,"becaus":[4,7,12,13,15],"becom":9,"befor":[1,12],"begin":[3,15],"behavior":5,"benchmark":[15,16],"bert":8,"bert_infer":15,"best":[3,4,12],"better":[7,16],"bin":[0,7,13],"biomass":7,"black":8,"block":[3,7,15],"blog":[7,12],"blue":8,"bookworm":13,"boolean":11,"boot":12,"brazilsouth":10,"brief":13,"broader":9,"bubbl":16,"build":[14,15],"build_model":15,"built":[10,16],"buy":7,"c":[7,11,15],"cach":12,"calcul":4,"california":11,"call":[3,7,10,11,15],"can":[1,2,3,4,6,7,8,9,10,11,12,13,14,15,16],"canada":11,"capac":7,"capita":7,"car":9,"carbon":[2,4,5,8,9,15],"carbonboard":16,"case":[4,8,10,15,16],"caus":12,"cd":13,"cell":15,"center":11,"central":[1,14],"ceram":7,"certain":1,"chang":[0,12],"chapter":0,"charact":15,"characterist":12,"chart":16,"check":0,"checkout":13,"chess":9,"chih":[7,12],"chip":[7,12],"chipset":[11,12],"chmod":[0,12,13],"choic":4,"choos":[4,11,12,13],"chose":16,"chown":0,"citi":[10,11],"class":[0,7,10,12,13,14],"clevercloud":1,"cli":[5,6,15,16],"click":[2,6,16],"client":[6,14],"clone":13,"close":12,"cloud":[4,7,10,11],"cloud_provid":[10,11],"cloud_region":[10,11],"co2":[7,15],"co2eq":[3,15],"co2sign":11,"coal":7,"code":[1,2,3,4,10,11,13,15],"codecarbon":[2,3,4,8,11,14,16],"codecarbon_":[10,15],"codecarbon_cli_as_a_servic":0,"codecarbon_gpu_id":15,"codecarbon_log_level":15,"colin":13,"collect":[5,10],"collector":14,"com":[0,4,11,12,13],"combust":9,"come":[15,16],"comet":5,"comet_ml":2,"comma":11,"command":[6,7,13,16],"common":12,"communiti":4,"compar":[2,7,8,16],"compare_cpu_load_and_rapl":13,"comparison":[5,7],"compat":16,"compil":3,"complet":[11,12,15],"compon":12,"compos":[10,15],"comprehens":12,"comput":[3,4,7,8,9,10,12,15],"concern":16,"conda":5,"condit":[7,10],"conf":0,"config":[0,1,15],"configpars":15,"configur":[0,5,7,10],"connect":[13,14,16],"consequ":9,"consid":7,"consider":[8,12],"consist":[11,12],"consol":13,"constant":7,"consum":[7,9,11,12,16],"consumpt":[7,11,12,16],"consumption_percentag":11,"contact":7,"contain":[7,12,16],"context":5,"continu":3,"contribut":7,"control":12,"convert":7,"copi":[2,3],"core":[7,10],"correct":12,"correspond":[7,15],"count":[4,5,7],"counter":[7,12],"countri":[4,7,10,11,15],"country_2letter_iso_cod":11,"country_iso_cod":[10,11,15],"country_nam":10,"cover":4,"co\u2082":[7,9,10],"co\u2082eq":[7,9,10],"cpu":[5,10,11,12,13,15],"cpu_count":10,"cpu_energi":10,"cpu_load_profil":13,"cpu_model":10,"cpu_pow":10,"cpu_utilization_perc":10,"cpuinfo":6,"cpus":[7,12],"crash":3,"creat":[0,1,2,5,6,12,15],"credenti":0,"critic":[11,12,14],"csv":[5,11,13,15,16],"ctrl":15,"cuda_visible_devic":11,"curl":13,"current":[7,9,10,11,12,15,16],"curtail":9,"custom":10,"cve":12,"cycl":4,"daili":[7,16],"dash":16,"dashboard":[0,1,7,16],"data":[1,2,3,4,7,9,11,12,13,14,15],"databas":10,"datacent":4,"dataset":[2,3,15],"day":7,"ddr":12,"ddr4":7,"debian":[0,13],"debug":[11,14,15],"decor":[5,11],"decreas":7,"dedic":[0,11,14],"dedupl":12,"deep":[3,8],"def":[1,3,15],"default":[1,2,4,7,10,11,12,14,15,16],"defin":7,"definit":2,"delet":13,"delta_0":12,"demonstr":14,"dens":[3,8],"depend":[5,9,12,15,16],"deploy":[5,9,10],"deposit":7,"deprec":16,"deriv":[7,10],"describ":[0,8,11],"descript":[0,10,11],"design":7,"desir":12,"desktop":7,"despit":[7,12],"detail":[2,11,12,15],"detect":[7,12,15],"develop":[8,9,10,15],"devic":[10,12],"die":7,"differ":[4,7,8,9,12,16],"digit":3,"dimm":[7,11],"dioxid":[7,9],"direct":[4,7],"directori":[7,10,11,12,15],"disabl":12,"discharg":12,"discontinu":7,"discret":12,"discuss":[7,12],"disk":15,"display":[3,8,10,12,15,16],"distinct":14,"distribut":12,"dive":16,"divid":[7,10,16],"docker":[10,15],"document":[12,14,15],"doe":[4,12],"doesn":7,"doi":12,"domain":[5,11],"don":[3,7,12],"done":[0,4,10,15],"doubl":[5,15],"dram":[11,12],"draw":7,"drive":[7,9,12],"driven":[7,16],"dropout":3,"dt":10,"due":12,"duplic":12,"durat":10,"dure":[3,7,9,10,12,15],"e":[3,7,10,12],"e3":13,"e5":13,"easili":2,"east":10,"east1":10,"echo":[0,15],"eco":16,"ecolog":7,"effect":11,"effici":[7,9],"either":11,"electr":[4,7,9,11,15],"electricitymap":11,"electricitymaps_api_token":[11,15],"els":2,"em":13,"emiss":[1,2,3,4,5,8,9,10,11,15,16],"emissions_endpoint":15,"emissions_r":10,"emissionstrack":[2,3,14,15],"emissiontrack":10,"emit":[7,8,9],"enabl":[0,9,12,15],"encapsul":11,"end":[3,7,11,15],"endpoint":[11,15],"energi":[4,8,9,10,12,16],"energy_consum":10,"energy_uj":[0,7,12],"enhanc":10,"enorm":9,"ensur":[3,7],"ensurepath":13,"entail":9,"enter":7,"enterpris":4,"entir":[11,12,15],"entireti":4,"entri":15,"environ":[0,2,5,7,10,15],"environment":[7,8,9],"eof":0,"epoch":3,"epyc":13,"eq":[4,7],"equival":[5,8,9,10],"eras":11,"error":[3,11],"estim":[4,5,8,9,11],"etc":[0,12,14],"etch":7,"european":7,"eval":12,"evalu":10,"even":[3,4],"ever":[7,16],"everi":[0,2,7,11],"everyth":[2,12,15],"exact":7,"exampl":[2,5,7,9,10,11,13,15,16],"excel":12,"except":[3,7,12],"exclud":12,"exclus":12,"execstart":0,"execut":[15,16],"exemplari":16,"exist":[4,7,11,15,16],"expect":12,"experi":[1,2,9,11,12,15,16],"experiment_id":[0,1,11,15],"explain":2,"explan":12,"explicit":5,"export":[13,15],"expos":[10,11,12],"express":[7,9,10],"extra":16,"f":3,"face":9,"fact":9,"factor":[4,7,11],"fall":[7,12],"fallback":7,"fals":[0,11,12,15],"fan":12,"fast":7,"featur":[7,9,12],"fetch":15,"fief":6,"figur":12,"file":[0,1,2,7,10,11,12,14,15,16],"filehandl":14,"filepath":16,"filter":[12,14],"final":[3,15],"final_emiss":3,"final_emissions_data":3,"find":4,"fine":15,"finish":3,"fintetun":8,"first":[0,7,8,10,14,15],"fit":3,"flatten":3,"float":[3,14],"flush":[11,15],"fn":11,"focus":4,"folder":15,"follow":[0,3,4,6,7,8,10,11,13,15,16],"footprint":[2,4,7,9],"forbid":14,"forc":11,"force_cpu_pow":11,"force_ram_pow":[7,11],"format":10,"former":11,"fossil":[7,9],"found":[2,7,15],"fourth":8,"fra":15,"frac":7,"fraction":7,"framework":15,"free":[1,2],"french":7,"frequent":[5,7],"friend":16,"from_logit":3,"fuel":[7,9],"full":[7,12,13],"function":[3,4,11,15],"futur":[11,12],"g":[0,3,7,10,12,15],"gadget":7,"galleri":2,"game":[9,12],"gas":7,"gase":9,"gb":[7,10,13],"gco2":[4,7],"gcp":10,"geforc":10,"general":[7,12],"generat":[7,9,12,15,16],"geograph":10,"geotherm":7,"get":[0,1,2,3,7,11,13,15,16],"getlogg":14,"git":13,"github":[3,7,12,13],"give":[0,7],"given":10,"global":[4,7,9,11,15],"global_energy_mix":11,"globalpetrolpric":4,"go":[0,2,9,10],"goe":[1,15],"gold":[4,7],"good":[4,7,10],"googl":[4,11],"google_project_nam":14,"googlecloudloggeroutput":14,"got":16,"gpu":[1,8,10,11,12,15],"gpu_count":10,"gpu_energi":10,"gpu_id":[11,15],"gpu_model":10,"gpu_pow":10,"gpu_utilization_perc":10,"gpus":[7,11,12],"grain":15,"graph":[2,8],"great":8,"greater":4,"greener":11,"greenhous":9,"grep":[7,11],"grid":[7,9,16],"group":[0,12],"grow":9,"gtx":10,"h":[8,10],"habit":4,"hand":16,"handler":[11,14],"happen":[7,16],"hard":4,"hardwar":[5,11,12,15],"header":15,"help":[4,7,11],"hesit":7,"heurist":7,"hierarch":[12,15],"hierarchi":5,"high":[7,12],"higher":[11,12],"highest":7,"hirki":12,"histor":10,"home":[13,15],"hood":15,"host":[0,6,10,11,15,16],"hostnam":0,"hour":[7,8,9,11],"hous":7,"household":16,"howev":[7,15],"html":[7,12],"htop":13,"http":[5,15],"http_proxi":15,"https":[0,7,11,12,13],"https_proxi":15,"hubblo":12,"huge":8,"human":9,"hydroelectr":7,"hyperparamet":2,"hyphen":15,"i120":13,"i7":[7,10],"id":[1,10,11],"id_ed25519":0,"identifi":[11,12],"idl":12,"iea":[4,7],"illustr":16,"imag":[3,9],"imdb":15,"imdb_emiss":15,"impact":[5,7,9,11],"implement":[10,12,15],"import":[1,3,9,12,14,15],"improv":[4,7],"inch":16,"includ":[7,11,12,15],"include_dram":12,"incred":9,"independ":12,"index":[5,11],"indic":[11,15],"individu":12,"industri":9,"ineffici":12,"infer":15,"info":[11,12,14],"inform":[0,4,7,12,15,16],"infra":4,"infrastructur":[4,7,10,11,15,16],"ini":15,"init":7,"initi":[4,15],"input":[5,10],"input_shap":3,"instal":[2,5,7,13],"install_codecarbon":0,"instanc":[11,15],"instant":7,"instanti":[3,7,15],"instead":[12,16],"instruct":[0,12],"integ":11,"integr":[5,12],"intel":[0,7,10,13],"intellig":[9,12],"intens":[1,4,5,8,11,15],"interact":3,"interconnect":12,"interfac":[1,7,10,12],"interfer":15,"intern":15,"internet":5,"interv":[7,10,11],"introduc":12,"investig":12,"io":[0,11,12],"iso":[10,11,15],"isol":11,"issu":[4,7,12],"issuecom":12,"j":12,"j2":0,"job":2,"joul":7,"journalctl":0,"js":15,"json":11,"jupyt":15,"just":[3,7,15],"k":12,"keep":[4,7,15],"kera":3,"kernel":[7,12],"key":[0,2,5,11],"kg":[7,10],"kgco\u2082":7,"khan":12,"kilogram":[7,9],"kilomet":7,"kilowatt":[7,9,11],"king":13,"km":10,"km\u00b2":10,"know":[7,11],"knowledg":7,"known":7,"kwh":[4,7,8,10,11,12],"l":11,"lack":14,"languag":8,"laptop":7,"larg":[7,8,9],"last":[7,12,15],"latest":6,"latitud":10,"launchpadlib":13,"layer":3,"lcd":16,"learn":[3,8,9],"least":7,"left":[2,16],"legaci":[12,16],"let":4,"letter":[10,11,15],"level":[7,9,11,12,14,15,16],"leverag":[9,14],"librari":[7,15],"life":[4,16],"light":[7,8],"like":[7,9,12,15],"limit":[0,1,7,12],"line":[3,7,8,12],"linear":7,"link":2,"linux":[5,7,11,12],"list":[6,7,11,15],"litr":11,"ll":2,"llc":12,"load":[7,12,13,15],"load_data":3,"load_dataset":15,"local":[4,7,13,14,15],"localhost":[10,15],"localis":8,"locat":[8,11],"log":[0,8,11,15,16],"log_level":[0,11,15],"log_nam":14,"logfir":[5,11],"logger":[5,11,16],"logger_preambl":11,"loggeroutput":[11,14],"logging_demo":14,"logging_logg":[11,14],"logic":7,"login":[0,1],"longer":6,"longitud":10,"loss":[3,12],"loss_fn":3,"lost":12,"low":[7,11,12],"lower":12,"lshw":[7,11],"lssf":13,"m":[0,10,12],"m1":7,"m2":7,"mac":7,"machin":[0,1,7,9,10,11,15],"made":4,"main":[0,7],"maintain":6,"major":10,"make":[2,4,7],"manag":[5,6],"mandatori":11,"mani":[4,11],"manner":15,"manual":[0,11,15],"manufactur":7,"map":[7,11,12],"massiv":12,"match":[7,11,12],"matrixprod":13,"matter":9,"max":[7,11],"max_energy_range_uj":12,"maximum":12,"may":[11,12,14],"mb":7,"mean":10,"measur":[0,5,7,8,9,11,15],"measure_power_sec":[0,1,7,11,15],"medium":7,"memori":[7,11,12],"mention":7,"messag":[11,14],"metadata":16,"meter":12,"method":[3,7,13],"methodolog":5,"metric":[2,3,5,10,13],"mhz":7,"micro":7,"microjoul":12,"microsoft":[4,8],"might":8,"mile":16,"mind":4,"minim":15,"minimum":7,"minut":0,"miss":[4,7,12],"mix":[4,7,16],"mixtur":7,"mkdir":[0,13],"ml":[2,6,7],"mlco2":13,"mmio":12,"mnist":[2,3],"mode":[0,1,5,7,10,12],"model":[3,5,7,9,12,15],"model_emiss":15,"modern":[7,12],"modifi":[7,15],"modul":[5,7],"monitor":[0,1,7,10,12,15],"month":[4,9],"motherboard":[7,12],"motiv":5,"msr":12,"much":4,"multi":0,"multipl":[11,12],"multipli":4,"must":15,"mwh":7,"my_logg":14,"n":[10,12],"name":[6,7,10,11,12,14,15],"nativ":7,"natur":7,"nb":8,"ncarbon":3,"ndetail":3,"nearbi":7,"necessari":7,"need":[1,2,3,7,10,14,15,16],"neither":[4,7],"net":[7,16],"network":[0,14],"never":[3,12],"new":[11,13],"newer":12,"next":12,"ng":[12,13],"nice":1,"niemi":12,"nlp":8,"node":15,"node_export":12,"non":[12,15],"none":[7,11],"nopasswd":7,"normal":[7,15],"notabl":4,"note":[7,11,12,15],"notebook":[3,13,15],"noth":10,"now":[0,2,7,13],"npm":15,"npus":12,"ns":7,"nuclear":7,"number":[7,10,11,16],"nurminen":12,"nvidia":[6,7,10,12],"nvme":[12,13],"o":12,"object":[2,5,9,11],"observ":10,"occur":3,"offlin":5,"offlineemissionstrack":[10,15],"offlineemissiontrack":14,"offset":4,"often":4,"old":[7,11],"older":[11,12],"on_cloud":10,"on_csv_writ":11,"onc":[2,10],"one":[4,7,10,11,14,16],"onli":[3,4,7,11,12,15],"onlin":5,"open":[4,7],"openapi":1,"opt":0,"optim":3,"option":[1,4,7,11,12,14,15,16],"order":[9,11,14],"org":12,"organis":16,"organiz":1,"organization_id":0,"os":[10,13,15],"others":4,"otherwis":14,"ou":12,"ourworld":4,"output":[5,14,15],"output_dir":[10,11,15],"output_fil":11,"output_handl":11,"overhead":[7,15],"overlap":12,"overrid":[7,11,15],"overwrit":15,"owner":0,"ownership":0,"p":13,"p40":8,"packag":[0,2,4,6,7,9,10,11,12,14,16],"page":[2,5],"panda":6,"panel":2,"parallel":14,"param":15,"paramet":[5,7,10,15],"part":[7,9],"particular":16,"pass":[7,15],"passeng":7,"password":7,"paste":3,"path":[7,11,13,16],"pattern":9,"pcie":[11,12],"per":[7,9,10,11],"perf":13,"perform":[9,12],"period":10,"peripher":12,"permiss":[0,7,12],"person":2,"petroleum":7,"physic":7,"pi":7,"piec":[7,15],"pip":[0,2,6,16],"pipx":13,"place":10,"placehold":2,"plastic":7,"plate":7,"platform":[4,5,10,11],"play":[4,9],"pleas":[4,6,14,15,16],"plug":12,"point":[8,12,15,16],"polici":8,"popul":11,"popular":8,"port":16,"possibl":7,"potenti":[9,12],"power":[0,2,5,9,10,11,12,14,16],"power_const":11,"powercap":[0,7,12,13],"powermetr":7,"powertop":12,"pp":12,"ppa":13,"precis":10,"prefer":[11,12],"prefer_psi":12,"prefix":11,"present":[8,12],"pretrain":8,"prevent":15,"previous":[0,7],"price":4,"print":[3,15],"priorit":12,"prioriti":[4,5],"privaci":10,"privat":[4,10,14,15],"probabl":11,"process":[7,9,10,11,14,15,16],"processor":[7,9,12],"produc":[4,9,16],"product":7,"program":[3,9,15],"project":[1,3,4,10,11,14,16],"project_id":0,"project_nam":[3,10,11,15],"prometheus":[5,11,12],"prometheus_cli":6,"prometheus_password":10,"prometheus_url":11,"prometheus_usernam":10,"prompt":15,"proport":7,"propos":7,"protect":[8,10],"provid":[2,7,10,11,12,14,15,16],"provinc":[10,11],"proxi":5,"psu":12,"psutil":[6,7],"psys":[11,12],"public":[2,4,7,15,16],"publish":4,"pue":11,"purpos":9,"push":10,"pushgateway":10,"py":[2,6,7,10,13,14,15],"pypi":5,"pyproject":6,"python":[0,6,13,15],"python3":[0,13],"python_vers":10,"quantifi":[4,7],"quartil":8,"question":5,"questionari":6,"quickstart":5,"quot":15,"r":[0,7,10,13],"ram":[10,11,12,15],"ram_energi":10,"ram_pow":10,"ram_total_s":10,"ram_used_gb":10,"ram_utilization_perc":10,"rang":[10,12],"rapidfuzz":6,"rapl":[0,5,11,13],"rapl_include_dram":11,"rapl_prefer_psi":11,"rapsberri":7,"rare":12,"raspberri":7,"rate":12,"rather":7,"ratio":7,"re":[6,15],"read":[0,7,12,15],"real":[5,13],"realli":7,"reason":[7,9],"reboot":12,"recent":9,"recogn":[3,4,7,9],"recommend":[3,4,6,12,15,16],"record":15,"recur":4,"redirect":15,"reduc":[4,7,10],"refer":[5,6,12,14,15],"region":[4,5,7,10,11,15],"regist":12,"releas":4,"relev":8,"reli":15,"reliabl":[11,12],"relu":3,"remain":[1,15],"remark":9,"remov":16,"render":2,"renew":7,"replac":2,"repo":4,"report":[7,11,12,14,15],"repositori":[3,5,13],"repres":[8,12],"reproduc":2,"request":[6,15],"requir":[10,11,15,16],"research":[2,4],"reserv":12,"resource_track":7,"respect":[10,15],"restart":0,"restrict":15,"result":[8,10,13,15],"return":[3,15],"rich":6,"right":[7,8,12,16],"ring":12,"rocm":12,"room":7,"root":[0,7],"row":11,"rule":10,"run":[0,2,3,4,6,7,10,11,12,13,16],"run_id":11,"runtim":16,"s":[0,2,5,7,9,10,11,15,16],"sampl":2,"save":[1,2,11,14,15],"save_to_api":[1,11,15],"save_to_fil":[11,15],"save_to_logfir":[10,11],"save_to_logg":[11,14],"save_to_prometheus":[10,11],"scale":[7,8],"scaphandr":12,"scenario":13,"schedul":[3,7,15],"scheme":4,"scientist":2,"scp":13,"script":15,"sculpt":7,"sdk":14,"seamless":6,"search":[2,5,10],"sec":12,"second":[0,7,10,11],"section":[0,3,15],"sector":9,"secur":12,"see":[2,3,7,10,11,12,13,14,15,16],"select":12,"self":10,"semiconductor":7,"send":[0,10,11,14,15],"sent":10,"separ":[11,12],"sequenti":3,"seri":16,"server":[1,5,7,10,11,12,13],"servic":[5,10],"set":[0,1,2,10,11,12,14,15],"setlevel":14,"sever":[12,16],"sh":[13,15],"share":16,"shell":15,"short":[7,11],"shot":4,"show":[8,12,16],"shown":16,"side":[8,16],"sidebar":2,"signific":[7,9],"silicon":7,"simplest":3,"sinc":[7,11,12],"singl":[4,7,15],"size":7,"skylak":12,"sleep":15,"slot":[7,11],"small":[7,8,15],"smi":12,"socket":12,"solar":7,"solut":7,"soon":[1,15],"sophist":9,"sourc":[4,8,12],"sp0":10,"spars":12,"sparsecategoricalcrossentropi":3,"spec":12,"special":15,"specif":[5,7,9,14,15],"specifi":[1,10,11,14],"split":15,"ssd":13,"ssds":12,"ssh":[0,13],"standard":[4,7,9,11],"start":[2,3,7,10,14,15],"start_task":15,"state":[9,10,11],"stdout":2,"stick":7,"still":[3,7,12,14,16],"stop":[3,7,10,14,15],"stop_task":15,"strategi":5,"stream":14,"stress":[12,13],"string":11,"structur":15,"studi":8,"stuff":7,"subclass":14,"subdomain":12,"subject":7,"subscript":4,"subset":12,"subsystem":[7,12,13],"success":4,"sudo":[0,7,11,12,13],"sudoer":7,"suffix":10,"sum":[10,12],"summari":15,"superus":12,"supplement":12,"suppli":[7,12],"support":[7,11,12,14,15],"suppos":12,"sure":2,"surround":15,"sustain":4,"switch":[7,16],"synchron":7,"syntax":15,"sys":[0,7,12,13],"sysf":0,"sysfsutil":0,"syst":12,"system":[0,2,7,10,11,12,14,15],"systemat":11,"systemctl":0,"systemd":0,"systemd_servic":0,"t":[3,7,12,13,15],"tab":2,"tabl":[7,8],"take":7,"takeaway":5,"taken":2,"target":[0,10],"task":[0,9,15],"tdp":[7,11,13],"tdps":7,"team":1,"tee":0,"televis":7,"tell":1,"templat":0,"tensorflow":3,"termin":[1,6],"test":[12,15],"text":7,"tf":3,"thank":[1,12],"themselv":12,"therefor":4,"thermal":7,"think":3,"thousand":7,"thus":9,"ti":10,"time":[2,5,7,10,15,16],"timeseri":1,"timestamp":10,"tini":8,"tm":[7,10],"token":[11,15],"toml":6,"ton":7,"tool":[2,7,8,15,16],"toolkit":7,"top":16,"total":[7,10,11,12,16],"trace":0,"track":[2,3,7,9,10,11,12,14,15],"track_emiss":[1,3,5,15],"tracker":[3,7,10,11,14,15],"tracking_mod":[10,11,15],"tradit":12,"train":[1,2,3,8,9,15],"train_model":[1,3,15],"training_loop":15,"tran":12,"transf":8,"transit":7,"tri":[3,4,7,11,15],"trigger":[10,14],"tripl":12,"true":[1,3,10,11,12,14,15],"tv":16,"two":[1,3,7,12,15],"txt":15,"typer":6,"typic":14,"u":0,"ubiquit":9,"ubuntu":[0,7,13],"ui":2,"unbuff":7,"unchang":15,"unclear":12,"uncor":12,"underlying":[7,9],"understand":[7,16],"unexpect":12,"unfortun":4,"unit":[0,7,11],"unless":12,"unread":12,"unregist":7,"unreli":[11,12],"updat":[0,11,12,13],"upload":1,"url":11,"us":[8,10,11],"usa":10,"usabl":[7,14],"usag":[5,11],"usb":12,"use":[1,4,5,7,8,9,11,12,13,14,15,16],"user":[0,7,11,12,15,16],"useradd":0,"usernam":7,"usr":7,"usual":10,"util":10,"uuid":15,"uv":13,"v100":8,"v100s":8,"v2":[7,11,12],"v3":[7,11,13],"v4":16,"valid":14,"valu":[7,10,11,12,15],"var":0,"variabl":[0,11,15],"variat":7,"various":[7,9,12,14,16],"vast":9,"ve":2,"vehicl":7,"vendor":12,"venv":0,"verbos":[0,11],"veri":[7,12],"version":[10,11,12,13,15],"via":[4,9,12],"victor":15,"view":[2,4],"virtual":0,"vision":8,"visual":[2,5],"visudo":7,"vit":8,"viz":16,"voil\u00e0":2,"vol":12,"w":[7,10,11,12,13],"wait":0,"wall":12,"want":[7,11,12,15],"wantedbi":0,"warm":9,"warn":[0,11,15],"watch":16,"water":11,"watt":[7,11,12],"way":[3,15],"web":[1,15],"webhook":10,"websit":2,"week":[9,16],"weight":7,"welcom":7,"well":4,"wh":7,"whole":12,"wikipedia":15,"will":[1,2,3,6,7,10,11,12,15,16],"wind":7,"window":[7,10],"within":[6,12,15],"without":[7,12,15],"wonder":15,"work":[0,4,6,9,15,16],"workaround":12,"workingdirectori":0,"world":[4,5,7,13],"wrap":[12,15],"wraparound":12,"wren":4,"write":15,"written":[11,15],"wrong":12,"wue":11,"x":[7,10,11,12,13],"x86":7,"x_test":3,"x_train":3,"xeon":13,"xxx":13,"y":[10,12,13],"y_test":3,"y_train":3,"year":[5,7,9],"yet":15,"yield":15,"yml":0,"york":11,"your_api_key":0,"your_command":15,"your_experiment_id":0,"your_org_id":0,"your_project_id":0,"yourdomain":0,"yourservernam":0,"z":12,"zone":11},"titles":["Advanced Installation","CodeCarbon API","Comet Integration","Examples","Frequently Asked Questions","CodeCarbon","Installing CodeCarbon","Methodology","Model Comparisons","Motivation","Output","Parameters","RAPL Metrics","Test of CodeCarbon on Scaleway hardware","Collecting emissions to a logger","Quickstart","Visualize"],"titleterms":{"15w":12,"1950x":12,"265h":12,"28w":12,"7600u":12,"7th":12,"Each":10,"From":6,"How":[7,10],"What":0,"access":15,"across":7,"advanc":0,"ai":8,"amd":12,"ani":15,"ansibl":0,"api":[1,10],"architectur":12,"ask":4,"authent":14,"avail":12,"behavior":12,"calcul":7,"car":7,"carbon":[7,16],"citizen":7,"cli":0,"cloud":[8,14,16],"code":7,"codecarbon":[0,1,5,6,7,10,12,13,15],"collect":14,"comet":2,"command":15,"comparison":[8,16],"conda":6,"configur":15,"consumpt":8,"context":[3,15],"core":12,"count":12,"countri":16,"cpu":7,"creat":14,"csv":10,"data":10,"decor":[3,15],"depend":6,"deploy":0,"desktop":12,"detail":16,"die":12,"directori":0,"doe":0,"domain":12,"doubl":12,"electr":[8,16],"emiss":[7,14],"emissiontrack":14,"energi":7,"environ":6,"equival":[7,16],"estim":7,"exampl":[3,12,14],"experi":10,"explicit":[3,15],"field":10,"formula":7,"frequent":4,"gen":12,"get":5,"global":16,"googl":14,"gpu":7,"hardwar":[7,13],"hierarchi":12,"http":10,"i7":12,"impact":8,"indic":5,"input":11,"instal":[0,6,16],"instanc":8,"integr":2,"intel":12,"intens":[7,16],"internet":15,"introduct":5,"kabi":12,"key":12,"lake":12,"laptop":12,"line":15,"linux":0,"local":10,"log":[5,10,14],"logfir":10,"logger":[10,14],"manag":[3,15],"measur":12,"methodolog":7,"metric":[7,12],"mode":[11,15],"model":8,"motiv":9,"multi":12,"object":[3,15],"offlin":[11,15,16],"offlineemissionstrack":11,"onlin":[15,16],"output":[10,11],"paramet":11,"per":16,"platform":12,"playbook":0,"power":7,"prerequisit":0,"prioriti":[7,15],"product":16,"prometheus":10,"proxi":15,"pypi":6,"python":14,"question":4,"quick":0,"quickstart":15,"r":12,"ram":7,"rapl":[7,12],"real":12,"refer":[7,8],"region":[8,16],"repositori":6,"run":15,"ryzen":12,"s":12,"scaleway":13,"server":15,"servic":0,"sourc":7,"specif":[11,12],"start":[0,5],"strategi":12,"structur":0,"summari":16,"tabl":5,"takeaway":12,"tdp":12,"test":[10,13],"thread":12,"threadripp":12,"time":8,"tm":12,"track_emiss":11,"tv":7,"ultra":12,"us":7,"usag":[7,16],"use":[0,3,6,10],"visual":16,"week":7,"work":7,"world":12,"year":8}}) \ No newline at end of file +Search.setIndex({"alltitles": {"(Non-Python users) Standalone installer": [[6, "non-python-users-standalone-installer"]], "@track_emissions": [[11, "track-emissions"]], "Access internet through proxy server": [[15, "access-internet-through-proxy-server"]], "Advanced Installation": [[0, null]], "Authentication": [[14, "authentication"]], "Available RAPL Domains": [[12, "available-rapl-domains"]], "CPU": [[7, "cpu"]], "CPU hardware": [[7, "cpu-hardware"]], "CPU metrics priority": [[7, "cpu-metrics-priority"]], "CSV": [[10, "csv"]], "Calculation Formula": [[7, "calculation-formula"]], "Car Usage": [[7, "car-usage"]], "Carbon Intensity": [[7, "carbon-intensity"]], "Carbon Intensity Across Energy Sources": [[7, "id2"]], "Cloud Regions": [[16, "cloud-regions"]], "CodeCarbon": [[5, null]], "CodeCarbon API": [[1, null], [1, "id1"], [10, "codecarbon-api"]], "CodeCarbon\u2019s RAPL Strategy": [[12, "codecarbon-s-rapl-strategy"]], "Collecting emissions to a logger": [[14, null]], "Comet Integration": [[2, null]], "Command line": [[15, "command-line"]], "Comparisons": [[8, "comparisons"]], "Configuration": [[15, "configuration"]], "Configuration priority": [[15, "configuration-priority"]], "Context manager": [[15, "context-manager"], [15, "id2"]], "Create a logger": [[14, "create-a-logger"]], "Create an EmissionTracker": [[14, "create-an-emissiontracker"]], "Data Fields Logged for Each Experiment": [[10, "id4"]], "Decorator": [[15, "decorator"], [15, "id3"]], "Dependencies": [[6, "dependencies"]], "Deploy CodeCarbon CLI as a Service using Ansible": [[0, "deploy-codecarbon-cli-as-a-service-using-ansible"]], "Desktop: AMD Ryzen Threadripper 1950X (16-Core, 32 threads, Multi-die)": [[12, "desktop-amd-ryzen-threadripper-1950x-16-core-32-threads-multi-die"]], "Directory Structure": [[0, "directory-structure"]], "Electricity consumption of AI cloud instance": [[8, "id1"]], "Electricity production carbon intensity per country": [[16, "electricity-production-carbon-intensity-per-country"]], "Estimation of Equivalent Usage Emissions": [[7, "estimation-of-equivalent-usage-emissions"]], "Example": [[14, "example"]], "Examples": [[3, null]], "Explicit Object": [[15, "explicit-object"], [15, "id1"]], "Frequently Asked Questions": [[4, null]], "From PyPi repository": [[6, "from-pypi-repository"]], "GPU": [[7, "gpu"]], "Getting Started": [[5, null]], "Google Cloud Logging": [[14, "google-cloud-logging"]], "HTTP Output": [[10, "http-output"]], "How CodeCarbon Works": [[7, "how-codecarbon-works"]], "How to test in local": [[10, "how-to-test-in-local"]], "How to use it": [[10, "how-to-use-it"]], "Impact of time of year and region": [[8, "impact-of-time-of-year-and-region"]], "Indices and tables": [[5, "indices-and-tables"]], "Input Parameters": [[11, "input-parameters"], [11, "id6"]], "Input Parameters to @track_emissions": [[11, "id9"]], "Input Parameters to OfflineEmissionsTracker": [[11, "id8"]], "Install CodeCarbon as a Linux service": [[0, "install-codecarbon-as-a-linux-service"]], "Installation": [[16, "installation"]], "Installing CodeCarbon": [[6, null]], "Introduction": [[5, null]], "Key Takeaways for RAPL Measurements": [[12, "key-takeaways-for-rapl-measurements"]], "Laptop: Intel(R) Core(TM) Ultra 7 265H (TDP 28W)": [[12, "laptop-intel-r-core-tm-ultra-7-265h-tdp-28w"]], "Laptop: Intel(R) Core(TM) i7-7600U (TDP 15W, 7th Gen Kaby Lake)": [[12, "laptop-intel-r-core-tm-i7-7600u-tdp-15w-7th-gen-kaby-lake"]], "Logfire": [[10, "logfire"]], "Logger Output": [[10, "logger-output"]], "Logging": [[5, null]], "Methodology": [[7, null]], "Model Comparisons": [[8, null]], "Motivation": [[9, null]], "Offline": [[16, "offline"]], "Offline Mode": [[15, "offline-mode"]], "Online": [[16, "online"]], "Online Mode": [[15, "online-mode"]], "Output": [[10, null]], "Output Parameters": [[11, "id7"]], "Output parameters": [[11, "output-parameters"]], "Parameters": [[11, null]], "Platform-Specific Behavior": [[12, "platform-specific-behavior"]], "Power Usage": [[7, "power-usage"]], "Prerequisites": [[0, "prerequisites"]], "Prometheus": [[10, "prometheus"]], "Python logger": [[14, "python-logger"]], "Quick Start": [[0, "quick-start"]], "Quickstart": [[15, null]], "RAM": [[7, "ram"]], "RAPL Domain Architecture": [[12, "rapl-domain-architecture"]], "RAPL Domain Hierarchy and Double-Counting": [[12, "rapl-domain-hierarchy-and-double-counting"]], "RAPL Measurements: Real-World Examples": [[12, "rapl-measurements-real-world-examples"]], "RAPL Metrics": [[7, "rapl-metrics"], [12, null]], "References": [[7, "references"], [8, "references"]], "Regional Comparisons": [[16, "regional-comparisons"]], "Running Any Command with CodeCarbon": [[15, "running-any-command-with-codecarbon"]], "Source Code": [[7, "source-code"]], "Specific parameters for offline mode": [[11, "specific-parameters-for-offline-mode"]], "Summary and Equivalents": [[16, "summary-and-equivalents"]], "TV Usage": [[7, "tv-usage"]], "Test of CodeCarbon on Scaleway hardware": [[13, null]], "US Citizen Weekly Emissions": [[7, "us-citizen-weekly-emissions"]], "Usage": [[16, "usage"]], "Using CodeCarbon with logfire": [[10, "using-codecarbon-with-logfire"]], "Using CodeCarbon with prometheus": [[10, "using-codecarbon-with-prometheus"]], "Using Conda environments": [[6, "using-conda-environments"]], "Using the Context Manager": [[3, "using-the-context-manager"]], "Using the Decorator": [[3, "using-the-decorator"]], "Using the Explicit Object": [[3, "using-the-explicit-object"]], "Visualize": [[16, null]], "What the Playbook Does": [[0, "what-the-playbook-does"]], "detailed": [[16, "detailed"]], "from global\u2026": [[16, "from-global"]], "to more and more\u2026": [[16, "to-more-and-more"]]}, "docnames": ["advanced_installation", "api", "comet", "examples", "faq", "index", "installation", "methodology", "model_examples", "motivation", "output", "parameters", "rapl", "test_on_scaleway", "to_logger", "usage", "visualize"], "envversion": {"sphinx": 64, "sphinx.domains.c": 3, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 9, "sphinx.domains.index": 1, "sphinx.domains.javascript": 3, "sphinx.domains.math": 2, "sphinx.domains.python": 4, "sphinx.domains.rst": 2, "sphinx.domains.std": 2}, "filenames": ["advanced_installation.rst", "api.rst", "comet.rst", "examples.rst", "faq.rst", "index.rst", "installation.rst", "methodology.rst", "model_examples.rst", "motivation.rst", "output.rst", "parameters.rst", "rapl.rst", "test_on_scaleway.rst", "to_logger.rst", "usage.rst", "visualize.rst"], "indexentries": {}, "objects": {}, "objnames": {}, "objtypes": {}, "terms": {"": [0, 2, 5, 7, 9, 10, 11, 15, 16], "0": [0, 3, 7, 8, 10, 12, 13, 15, 16], "0000": 15, "00w": 12, "02": 8, "02w": 12, "03": 8, "0317": 15, "04": 8, "0440": 0, "04w": 12, "05": 12, "07w": 12, "084": 7, "1": [7, 8, 10, 11, 12, 15], "10": [0, 3, 7, 10, 12, 15], "100": 12, "1000": 3, "100w": 12, "1065g7": 10, "1080": 10, "10th": 12, "10w": 7, "11": [7, 8, 10], "1145": 12, "116": 12, "12": [7, 12, 13], "121": 8, "123": 10, "1240": 13, "125": 12, "128": [3, 7], "128gb": 7, "13": [7, 8], "131w": 12, "137": 12, "138": 7, "14": [7, 12], "14w": 12, "15": [7, 11, 12], "159": 13, "16": 7, "169": 8, "17": 7, "171": 12, "172": 12, "180": 12, "181": 12, "1892": 12, "19": 8, "19044": 10, "192": 8, "1tb": 7, "2": [2, 3, 7, 8, 10, 11, 12, 13], "20": [7, 12], "2000": 7, "201": 8, "2017": 12, "2018": 12, "2020": 12, "2023": 7, "2025": 12, "207": 13, "20w": 7, "21": [7, 8, 12], "214": 13, "216": 8, "21w": 12, "22": 12, "22w": 12, "234": 12, "235b1da5": 15, "237": 8, "23w": 12, "24": 12, "2400": 7, "25": 7, "255": 3, "256": [7, 8], "26": [7, 12], "2620": 13, "27w": 12, "28": 3, "280": 12, "280w": 12, "29": [7, 12], "2w": 12, "3": [2, 6, 7, 8, 10, 11, 12, 15], "30": [0, 1, 12, 15], "30ghz": 10, "3177754": 12, "31w": 12, "32": [7, 16], "32gb": 7, "33": 7, "3333": 16, "35": 7, "35w": 12, "36": [8, 12], "37": [7, 8, 12], "37w": 12, "38": [7, 12], "3w": 7, "3x": 12, "4": [1, 7, 8, 15], "40": 12, "40ghz": 13, "40w": [7, 12], "44": 12, "44w": 12, "457": 7, "46w": 12, "475": [4, 7], "47w": 12, "48": 7, "4f": 3, "4gib": 7, "4w": 12, "5": [0, 7, 11, 12], "50": [7, 12], "51": 13, "52": 7, "54w": 12, "59": 7, "5w": [7, 12], "6": [7, 8, 12], "60": 13, "61": 12, "62": 12, "64": [7, 13], "64gb": 7, "66w": 12, "68": 12, "69w": 12, "6b": 8, "6w": 12, "7": [7, 8], "70": 7, "731": 7, "73w": 12, "743": 7, "76": 12, "7600u": 7, "7777": 15, "77778e": 7, "8": [6, 7, 8, 10, 11, 12], "80": 7, "8008": 15, "8024p": 13, "8050": 16, "812": 8, "816": 7, "82": 12, "85": 13, "854453231": 12, "85w": 12, "86": 12, "8694": 12, "88": 12, "88w": 12, "893681599d2c": 15, "8gb": 7, "8w": 12, "8x128gb": 7, "9": [7, 12], "90": [7, 8], "9090": 10, "93": 8, "960": 13, "97w": 12, "995": 7, "A": [7, 11, 14, 15, 16], "And": [1, 2], "As": [7, 9, 12], "But": [3, 4, 7], "By": [10, 12], "For": [4, 7, 9, 10, 11, 12, 13, 15], "IT": 4, "If": [3, 4, 6, 7, 10, 11, 12, 15, 16], "In": [1, 2, 7, 8, 9, 11, 14, 15], "It": [0, 1, 4, 7, 10, 14, 15, 16], "NOT": 12, "No": 12, "OR": 12, "On": [7, 8, 12], "One": 10, "Or": [1, 15], "The": [0, 1, 3, 6, 7, 8, 10, 11, 12, 14, 15, 16], "Then": [1, 7], "There": [4, 7, 12], "These": [7, 11], "To": [0, 2, 6, 7, 13], "With": 9, "_": 15, "__main__": [1, 3], "__name__": [1, 3], "_channel": 14, "_logger": 14, "_scheduler_monitor_pow": 7, "a100": 8, "aaaa": 15, "abl": [2, 10], "about": [4, 7, 15], "abov": [0, 6, 7, 12], "absenc": 15, "access": [0, 5, 7, 12], "account": [0, 1, 2, 7], "accur": [4, 7, 12], "accuraci": [3, 7, 12], "achiev": 9, "acm": 12, "across": [8, 9, 10, 12, 16], "action": 12, "activ": [3, 6, 7, 16], "actual": [4, 7, 12], "adam": 3, "add": [2, 3, 4, 7, 11, 12, 13, 14], "addhandl": 14, "addit": [7, 11, 15, 16], "administr": 7, "advanc": [5, 9], "affect": [11, 12], "after": [0, 3, 14], "against": 11, "agenc": [7, 8], "agent": 12, "ai": 9, "alert": 10, "algorithm": 7, "all": [4, 7, 10, 12, 15], "allow": [10, 11, 14, 15], "allow_multiple_run": 11, "alon": 12, "along": [2, 6, 15], "alongsid": 2, "alphabet": [10, 15], "also": [9, 14, 15, 16], "although": 4, "alwai": [0, 3], "amazon": 4, "amd": [7, 13], "american": 16, "amount": [7, 9, 16], "an": [0, 1, 2, 3, 4, 7, 10, 15, 16], "analysi": 12, "analyz": 4, "ani": [4, 7], "annual": 7, "anoth": [7, 8, 16], "ansibl": 5, "ansible_ssh_private_key_fil": 0, "ansible_us": 0, "anymor": 7, "api": [0, 2, 5, 11, 15, 16], "api_call_interv": [0, 1, 11, 15], "api_endpoint": [0, 11], "api_kei": [0, 2, 11], "app": [15, 16], "appear": [10, 12], "append": 11, "appl": 7, "appli": 7, "applic": 15, "approach": [7, 9, 12], "approx": 7, "approxim": 7, "apr": 12, "apt": [0, 13], "ar": [0, 3, 4, 6, 7, 8, 9, 10, 11, 12, 14], "architectur": 5, "argument": [11, 15, 16], "arm": 7, "arrow": 6, "art": 9, "artifact": [2, 11], "artifici": 9, "asia": 10, "ask": [5, 10], "associ": 7, "assum": 7, "assumpt": 7, "astral": 13, "attribut": 15, "auth": 10, "autom": 0, "automat": [2, 3, 7, 12], "automaticli": 11, "avail": [3, 4, 5, 7, 10, 11, 13, 14, 15, 16], "averag": [0, 4, 7, 8, 10, 12, 16], "avoid": 12, "aw": 10, "awar": [7, 15], "azur": [8, 10], "b112x": 13, "back": [2, 7, 12, 13], "background": 3, "backward": 16, "bar": 16, "barchart": 16, "base": [0, 7, 8, 10, 12, 14, 15], "baselin": 12, "baseoutput": 10, "bash": 15, "batteri": 12, "becaus": [4, 7, 12, 13, 15], "becom": 9, "been": 7, "befor": [1, 12], "begin": [3, 15], "behavior": 5, "being": [11, 16], "below": [0, 3, 8, 12, 16], "benchmark": [15, 16], "bert": 8, "bert_infer": 15, "best": [3, 4, 12], "better": [7, 16], "between": [11, 12], "bin": [0, 7, 13], "biomass": 7, "black": 8, "block": [3, 7, 15], "blog": [7, 12], "blue": 8, "bookworm": 13, "boolean": 11, "boot": 12, "both": [7, 9, 12, 15], "brazilsouth": 10, "brief": 13, "broader": 9, "bubbl": 16, "bui": 7, "build": [14, 15], "build_model": 15, "built": [10, 16], "bypass": 6, "c": [6, 7, 11, 15], "cach": 12, "calcul": 4, "california": 11, "call": [3, 7, 10, 11, 15], "can": [1, 2, 3, 4, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16], "canada": 11, "capac": 7, "capita": 7, "car": 9, "carbon": [2, 4, 5, 8, 9, 15], "carbonboard": 16, "case": [4, 8, 10, 15, 16], "caus": 12, "cd": 13, "cell": 15, "center": 11, "central": [1, 14], "ceram": 7, "certain": 1, "chang": [0, 12], "chapter": 0, "charact": 15, "characterist": 12, "chart": 16, "check": 0, "checkout": 13, "chess": 9, "chih": [7, 12], "chip": [7, 12], "chipset": [11, 12], "chmod": [0, 12, 13], "choic": 4, "choos": [4, 11, 12, 13], "chose": 16, "chown": 0, "citi": [10, 11], "class": [0, 7, 10, 12, 13, 14], "clevercloud": 1, "cli": [5, 6, 15, 16], "click": [2, 6, 16], "client": [6, 14], "clone": 13, "close": 12, "cloud": [4, 7, 10, 11], "cloud_provid": [10, 11], "cloud_region": [10, 11], "co2": [7, 15], "co2eq": [3, 15], "co2sign": 11, "coal": 7, "code": [1, 2, 3, 4, 10, 11, 13, 15], "codecarbon": [2, 3, 4, 8, 11, 14, 16], "codecarbon_": [10, 15], "codecarbon_cli_as_a_servic": 0, "codecarbon_gpu_id": 15, "codecarbon_log_level": 15, "colin": 13, "collect": [5, 10], "collector": 14, "com": [0, 4, 11, 12, 13], "combust": 9, "come": [15, 16], "comet": 5, "comet_ml": 2, "comma": 11, "command": [6, 7, 13, 16], "common": 12, "commun": 4, "compar": [2, 7, 8, 16], "compare_cpu_load_and_rapl": 13, "comparison": [5, 7], "compat": 16, "compil": 3, "complet": [11, 12, 15], "compon": 12, "compos": [10, 15], "comprehens": 12, "comput": [3, 4, 7, 8, 9, 10, 12, 15], "concern": 16, "conda": 5, "condit": [7, 10], "conf": 0, "config": [0, 1, 15], "configpars": 15, "configur": [0, 5, 7, 10], "connect": [13, 14, 16], "consequ": 9, "consid": 7, "consider": [8, 12], "consist": [11, 12], "consol": 13, "constant": 7, "consum": [7, 9, 11, 12, 16], "consumpt": [7, 11, 12, 16], "consumption_percentag": 11, "contact": 7, "contain": [7, 12, 16], "context": 5, "continu": 3, "contribut": 7, "control": 12, "convert": 7, "copi": [2, 3], "core": [7, 10], "correct": 12, "correctli": 12, "correspond": [7, 15], "could": [1, 7, 8, 11, 12, 15], "count": [4, 5, 7], "counter": [7, 12], "countri": [4, 7, 10, 11, 15], "country_2letter_iso_cod": 11, "country_iso_cod": [10, 11, 15], "country_nam": 10, "cover": 4, "co\u2082": [7, 9, 10], "co\u2082eq": [7, 9, 10], "cpu": [5, 10, 11, 12, 13, 15], "cpu_count": 10, "cpu_energi": 10, "cpu_load_profil": 13, "cpu_model": 10, "cpu_pow": 10, "cpu_utilization_perc": 10, "cpuinfo": 6, "crash": 3, "creat": [0, 1, 2, 5, 6, 12, 15], "credenti": 0, "critic": [11, 12, 14], "csv": [5, 11, 13, 15, 16], "ctrl": 15, "cuda_visible_devic": 11, "curl": [6, 13], "current": [7, 9, 10, 11, 12, 15, 16], "curtail": 9, "custom": 10, "cve": 12, "cycl": 4, "dai": 7, "daili": [7, 16], "dash": 16, "dashboard": [0, 1, 7, 16], "data": [1, 2, 3, 4, 7, 9, 11, 12, 13, 14, 15], "databas": 10, "datacent": 4, "dataset": [2, 3, 15], "ddr": 12, "ddr4": 7, "debian": [0, 13], "debug": [11, 14, 15], "decor": [5, 11], "decreas": 7, "dedic": [0, 11, 14], "dedupl": 12, "deep": [3, 8], "def": [1, 3, 15], "default": [1, 2, 4, 7, 10, 11, 12, 14, 15, 16], "defin": 7, "definit": 2, "delet": 13, "delta_0": 12, "demonstr": 14, "dens": [3, 8], "depend": [5, 9, 12, 15, 16], "deploi": [5, 9, 10], "deposit": 7, "deprec": 16, "deriv": [7, 10], "describ": [0, 8, 11], "descript": [0, 10, 11], "design": 7, "desir": 12, "desktop": 7, "despit": [7, 12], "detail": [2, 11, 12, 15], "detect": [7, 12, 15], "develop": [8, 9, 10, 15], "devic": [10, 12], "di": [7, 12], "did": 4, "die": 7, "differ": [4, 7, 8, 9, 12, 16], "digit": 3, "dimm": [7, 11], "dioxid": [7, 9], "direct": [4, 7], "directori": [7, 10, 11, 12, 15], "disabl": 12, "discharg": 12, "discontinu": 7, "discret": 12, "discuss": [7, 12], "disk": 15, "displai": [3, 8, 10, 12, 15, 16], "distinct": 14, "distribut": 12, "dive": 16, "divid": [7, 10, 16], "do": [1, 4, 7, 11, 12, 13, 15], "docker": [10, 15], "document": [12, 14, 15], "doe": [4, 12], "doesn": 7, "doi": 12, "domain": [5, 11], "don": [3, 7, 12], "done": [0, 4, 10, 15], "doubl": [5, 15], "download": 6, "dram": [11, 12], "draw": 7, "drive": [7, 9, 12], "driven": [7, 16], "dropout": 3, "dt": 10, "due": 12, "duplic": 12, "durat": 10, "dure": [3, 7, 9, 10, 12, 15], "e": [3, 7, 10, 12], "e3": 13, "e5": 13, "each": [7, 12, 15, 16], "easili": 2, "east": 10, "east1": 10, "echo": [0, 15], "eco": 16, "ecolog": 7, "effect": 11, "effici": [7, 9], "either": 11, "electr": [4, 7, 9, 11, 15], "electricitymap": 11, "electricitymaps_api_token": [11, 15], "els": 2, "em": 13, "emiss": [1, 2, 3, 4, 5, 8, 9, 10, 11, 15, 16], "emissions_endpoint": 15, "emissions_r": 10, "emissionstrack": [2, 3, 14, 15], "emissiontrack": 10, "emit": [7, 8, 9], "enabl": [0, 9, 12, 15], "encapsul": 11, "end": [3, 7, 11, 15], "endpoint": [11, 15], "energi": [4, 8, 9, 10, 12, 16], "energy_consum": 10, "energy_uj": [0, 7, 12], "enhanc": 10, "enorm": 9, "ensur": [3, 7], "ensurepath": 13, "entail": 9, "enter": 7, "enterpris": 4, "entir": [11, 12, 15], "entireti": 4, "entri": 15, "environ": [0, 2, 5, 7, 10, 15], "environment": [7, 8, 9], "eof": 0, "epoch": 3, "epyc": 13, "eq": [4, 7], "equival": [5, 8, 9, 10], "eras": 11, "error": [3, 11], "estim": [4, 5, 8, 9, 11], "etc": [0, 12, 14], "etch": 7, "european": 7, "eval": 12, "evalu": 10, "even": [3, 4], "ever": [7, 16], "everi": [0, 2, 7, 11], "everyth": [2, 12, 15], "exact": 7, "exampl": [2, 5, 7, 9, 10, 11, 13, 15, 16], "excel": 12, "except": [3, 7, 12], "exclud": 12, "exclus": 12, "execstart": 0, "execut": [6, 15, 16], "executionpolici": 6, "exemplari": 16, "exist": [4, 7, 11, 15, 16], "expect": 12, "experi": [1, 2, 9, 11, 12, 15, 16], "experiment_id": [0, 1, 11, 15], "explain": 2, "explan": 12, "explicit": 5, "export": [13, 15], "expos": [10, 11, 12], "express": [7, 9, 10], "extra": 16, "f": 3, "face": 9, "fact": 9, "factor": [4, 7, 11], "fall": [7, 12], "fallback": 7, "fals": [0, 11, 12, 15], "fan": 12, "fast": 7, "featur": [7, 9, 12], "fetch": 15, "fief": 6, "figur": 12, "file": [0, 1, 2, 7, 10, 11, 12, 14, 15, 16], "filehandl": 14, "filepath": 16, "filter": [12, 14], "final": [3, 15], "final_emiss": 3, "final_emissions_data": 3, "find": 4, "fine": 15, "finish": 3, "fintetun": 8, "first": [0, 7, 8, 10, 14, 15], "fit": 3, "flatten": 3, "float": [3, 14], "flush": [11, 15], "fn": 11, "focu": 4, "folder": 15, "follow": [0, 3, 4, 6, 7, 8, 10, 11, 13, 15, 16], "footprint": [2, 4, 7, 9], "forbid": 14, "forc": 11, "force_cpu_pow": 11, "force_ram_pow": [7, 11], "format": 10, "former": 11, "formerli": 11, "fossil": [7, 9], "found": [2, 7, 15], "fourth": 8, "fra": 15, "frac": 7, "fraction": 7, "framework": 15, "free": [1, 2], "french": 7, "frequent": [5, 7], "friendli": 16, "from": [0, 1, 2, 3, 4, 5, 7, 8, 10, 11, 12, 13, 14, 15], "from_logit": 3, "fuel": [7, 9], "full": [7, 12, 13], "function": [3, 4, 11, 15], "further": 7, "futur": [11, 12], "g": [0, 3, 7, 10, 12, 15], "ga": 7, "gadget": 7, "galleri": 2, "game": [9, 12], "gase": 9, "gb": [7, 10, 13], "gco2": [4, 7], "gcp": 10, "geforc": 10, "gener": [7, 9, 12, 15, 16], "geograph": 10, "geotherm": 7, "get": [0, 1, 2, 3, 7, 11, 13, 15, 16], "getlogg": 14, "git": 13, "github": [3, 7, 12, 13], "give": [0, 7], "given": 10, "global": [4, 7, 9, 11, 15], "global_energy_mix": 11, "globalpetrolpric": 4, "go": [0, 2, 9, 10], "goe": [1, 15], "gold": [4, 7], "good": [4, 7, 10], "googl": [4, 11], "google_project_nam": 14, "googlecloudloggeroutput": 14, "got": 16, "gpu": [1, 8, 10, 11, 12, 15], "gpu_count": 10, "gpu_energi": 10, "gpu_id": [11, 15], "gpu_model": 10, "gpu_pow": 10, "gpu_utilization_perc": 10, "grain": 15, "graph": [2, 8], "great": 8, "greater": 4, "greener": 11, "greenhous": 9, "grep": [7, 11], "grid": [7, 9, 16], "group": [0, 12], "grow": 9, "gtx": 10, "h": [8, 10], "ha": [3, 4, 7, 8, 9, 10, 15, 16], "habit": 4, "hand": 16, "handler": [11, 14], "happen": [7, 16], "hard": 4, "hardwar": [5, 11, 12, 15], "have": [1, 2, 4, 7, 8, 9, 10, 11, 12, 15], "header": 15, "help": [4, 7, 11], "here": [1, 4, 6, 7, 8, 11, 14, 15], "hesit": 7, "heurist": 7, "hierarch": [12, 15], "hierarchi": 5, "high": [7, 12], "higher": [11, 12], "highest": 7, "hirki": 12, "histor": 10, "home": [13, 15], "hood": 15, "host": [0, 6, 10, 11, 15, 16], "hostnam": 0, "hour": [7, 8, 9, 11], "hous": 7, "household": 16, "how": [0, 4, 11, 15], "howev": [7, 15], "html": [7, 12], "htop": 13, "http": [0, 5, 6, 7, 11, 12, 13, 15], "http_proxi": 15, "https_proxi": 15, "hubblo": 12, "huge": 8, "human": 9, "hydroelectr": 7, "hyperparamet": 2, "hyphen": 15, "i": [0, 1, 3, 4, 6, 7, 9, 10, 11, 12, 13, 14, 15, 16], "i120": 13, "i7": [7, 10], "id": [1, 10, 11], "id_ed25519": 0, "identifi": [11, 12], "idl": 12, "iea": [4, 7], "iex": 6, "illustr": 16, "imag": [3, 9], "imdb": 15, "imdb_emiss": 15, "impact": [5, 7, 9, 11], "implement": [10, 12, 15], "import": [1, 3, 9, 12, 14, 15], "improv": [4, 7], "inch": 16, "includ": [7, 11, 12, 15], "include_dram": 12, "incred": 9, "independ": 12, "index": [5, 11], "indic": [11, 15], "individu": 12, "industri": 9, "ineffici": 12, "infer": 15, "info": [11, 12, 14], "inform": [0, 4, 7, 12, 15, 16], "infra": 4, "infrastructur": [4, 7, 10, 11, 15, 16], "ini": 15, "init": 7, "initi": [4, 15], "input": [5, 10], "input_shap": 3, "instal": [2, 5, 7, 13], "install_codecarbon": 0, "instanc": [6, 11, 15], "instant": 7, "instanti": [3, 7, 15], "instead": [12, 16], "instruct": [0, 12], "integ": 11, "integr": [5, 12], "intel": [0, 7, 10, 13], "intellig": [9, 12], "intens": [1, 4, 5, 8, 11, 15], "interact": 3, "interconnect": 12, "interfac": [1, 7, 10, 12], "interfer": 15, "intern": 15, "internet": 5, "interv": [7, 10, 11], "introduc": 12, "investig": 12, "io": [0, 6, 11, 12], "irm": 6, "iso": [10, 11, 15], "isol": 11, "issu": [4, 7, 12], "issuecom": 12, "its": [4, 7, 8, 10, 14, 16], "itself": [6, 7], "j": [12, 15], "j2": 0, "job": 2, "joul": 7, "journalctl": 0, "json": 11, "jupyt": 15, "just": [3, 7, 15], "k": 12, "keep": [4, 7, 15], "kei": [0, 2, 5, 11], "kera": 3, "kernel": [7, 12], "kg": [7, 10], "kgco\u2082": 7, "khan": 12, "kilogram": [7, 9], "kilomet": 7, "kilowatt": [7, 9, 11], "king": 13, "km": 10, "km\u00b2": 10, "know": [7, 11], "knowledg": 7, "known": 7, "kwh": [4, 7, 8, 10, 11, 12], "l": 11, "lack": 14, "languag": 8, "laptop": 7, "larg": [7, 8, 9], "last": [7, 12, 15], "latest": 6, "latitud": 10, "launchpadlib": 13, "layer": 3, "lcd": 16, "learn": [3, 8, 9], "least": 7, "left": [2, 16], "legaci": [12, 16], "let": 4, "letter": [10, 11, 15], "level": [7, 9, 11, 12, 14, 15, 16], "leverag": [9, 14], "librari": [7, 15], "life": [4, 16], "light": [7, 8], "like": [6, 7, 9, 12, 15], "limit": [0, 1, 7, 12], "line": [3, 6, 7, 8, 12], "linear": 7, "linearli": 7, "link": 2, "linux": [5, 7, 11, 12], "list": [6, 7, 11, 15], "litr": 11, "ll": 2, "llc": 12, "load": [7, 12, 13, 15], "load_data": 3, "load_dataset": 15, "local": [4, 7, 13, 14, 15], "localhost": [10, 15], "localis": 8, "locat": [8, 11], "log": [0, 8, 11, 15, 16], "log_level": [0, 11, 15], "log_nam": 14, "logfir": [5, 11], "logger": [5, 11, 16], "logger_preambl": 11, "loggeroutput": [11, 14], "logging_demo": 14, "logging_logg": [11, 14], "logic": 7, "login": [0, 1], "longer": 6, "longitud": 10, "loss": [3, 12], "loss_fn": 3, "lost": 12, "low": [7, 11, 12], "lower": 12, "lshw": [7, 11], "lssf": [6, 13], "m": [0, 10, 12], "m1": 7, "m2": 7, "mac": 7, "machin": [0, 1, 6, 7, 9, 10, 11, 15], "made": 4, "mai": [11, 12, 14], "main": [0, 7], "maintain": 6, "major": 10, "make": [2, 4, 7], "manag": [5, 6], "mandatori": 11, "mani": [4, 11], "manner": 15, "manual": [0, 11, 15], "manufactur": 7, "map": [7, 11, 12], "massiv": 12, "match": [7, 11, 12], "matrixprod": 13, "matter": 9, "max": [7, 11], "max_energy_range_uj": 12, "maximum": 12, "mb": 7, "me": [7, 12], "mean": 10, "measur": [0, 5, 7, 8, 9, 11, 15], "measure_power_sec": [0, 1, 7, 11, 15], "medium": 7, "memori": [7, 11, 12], "mention": 7, "messag": [11, 14], "metadata": 16, "meter": 12, "method": [3, 7, 13], "methodologi": 5, "metric": [2, 3, 5, 10, 13], "mhz": 7, "micro": 7, "microjoul": 12, "microsoft": [4, 8], "might": 8, "mile": 16, "mind": 4, "minim": 15, "minimum": 7, "minut": 0, "miss": [4, 7, 12], "mix": [4, 7, 16], "mixtur": 7, "mkdir": [0, 13], "ml": [2, 6, 7], "mlco2": 13, "mmio": 12, "mnist": [2, 3], "mode": [0, 1, 5, 7, 10, 12], "model": [3, 5, 7, 9, 12, 15], "model_emiss": 15, "modern": [7, 12], "modifi": [7, 15], "modul": [5, 7], "monitor": [0, 1, 7, 10, 12, 15], "month": 9, "monthli": 4, "more": [1, 2, 7, 9, 11, 12, 15], "most": [8, 12, 16], "motherboard": [7, 12], "motiv": 5, "msr": 12, "much": 4, "multi": 0, "multipl": [11, 12], "multipli": 4, "must": 15, "mwh": 7, "my": 4, "my_logg": 14, "n": [7, 10, 12], "name": [6, 7, 10, 11, 12, 14, 15], "nativ": 7, "natur": 7, "nb": 8, "ncarbon": 3, "ndetail": 3, "nearbi": 7, "necessari": 7, "need": [1, 2, 3, 7, 10, 14, 15, 16], "neither": [4, 7], "net": [7, 16], "network": [0, 14], "never": [3, 12], "new": [11, 13], "newer": 12, "next": 12, "ng": [12, 13], "nice": 1, "niemi": 12, "nlp": 8, "node": 15, "node_export": 12, "non": [5, 12, 15], "none": [7, 11], "nopasswd": 7, "nor": 7, "normal": [7, 15], "notabl": 4, "note": [7, 11, 12, 15], "notebook": [3, 13, 15], "noth": 10, "now": [0, 2, 7, 13], "npm": 15, "npu": 12, "nuclear": 7, "number": [7, 10, 11, 16], "nurminen": 12, "nvidia": [6, 7, 10, 12], "nvme": [12, 13], "o": [10, 12, 13, 15], "object": [2, 5, 9, 11], "observ": 10, "occur": 3, "offlin": 5, "offlineemissionstrack": [10, 15], "offlineemissiontrack": 14, "offset": 4, "often": 4, "old": [7, 11], "older": [11, 12], "on_cloud": 10, "on_csv_writ": 11, "onc": [2, 10], "one": [4, 7, 10, 14, 16], "ones": 11, "onli": [3, 4, 7, 11, 12, 15], "onlin": 5, "open": [4, 7], "openapi": 1, "opt": 0, "optim": 3, "option": [1, 4, 7, 11, 12, 14, 15, 16], "order": [9, 11, 14], "org": 12, "organ": 1, "organis": 16, "organization_id": 0, "other": [0, 3, 4, 7, 9, 12, 14], "otherwis": 14, "ou": 12, "our": [4, 7], "ourworld": 4, "out": [4, 12], "output": [5, 14, 15], "output_dir": [10, 11, 15], "output_fil": 11, "output_handl": 11, "over": [11, 12], "overhead": [7, 15], "overlap": 12, "overrid": [7, 11, 15], "overwrit": 15, "own": [1, 8], "owner": 0, "ownership": 0, "p": 13, "p40": 8, "packag": [0, 2, 4, 6, 7, 9, 10, 11, 12, 14, 16], "page": [2, 5], "panda": 6, "panel": 2, "parallel": 14, "param": 15, "paramet": [5, 7, 10, 15], "part": [7, 9], "particular": 16, "pass": [7, 15], "passeng": 7, "password": 7, "past": 3, "path": [7, 11, 13, 16], "pattern": 9, "pcie": [11, 12], "per": [7, 9, 10, 11], "perf": 13, "perform": [9, 12], "period": 10, "peripher": 12, "permiss": [0, 7, 12], "person": 2, "petroleum": 7, "physic": 7, "pi": 7, "piec": [7, 15], "pip": [0, 2, 6, 16], "pipx": 13, "place": 10, "placehold": 2, "plai": [4, 9], "plastic": 7, "plate": 7, "platform": [4, 5, 10, 11], "pleas": [4, 6, 14, 15, 16], "plug": 12, "point": [8, 12, 15, 16], "polici": 8, "popul": 11, "popular": 8, "port": 16, "possibl": 7, "potenti": [9, 12], "power": [0, 2, 5, 9, 10, 11, 12, 14, 16], "power_const": 11, "powercap": [0, 7, 12, 13], "powermetr": 7, "powershel": 6, "powertop": 12, "pp": 12, "ppa": 13, "precis": 10, "prefer": [11, 12], "prefer_psi": 12, "prefix": 11, "present": [8, 12], "pretrain": 8, "prevent": 15, "previou": [0, 7], "price": 4, "print": [3, 15], "priorit": 12, "prioriti": [4, 5], "privaci": 10, "privat": [4, 10, 14, 15], "probabl": 11, "process": [7, 9, 10, 11, 14, 15, 16], "processor": [7, 9, 12], "produc": [4, 9, 16], "product": 7, "program": [3, 9, 15], "project": [1, 3, 4, 10, 11, 14, 16], "project_id": 0, "project_nam": [3, 10, 11, 15], "prometheu": [5, 11, 12], "prometheus_cli": 6, "prometheus_password": 10, "prometheus_url": 11, "prometheus_usernam": 10, "prompt": 15, "proport": 7, "propos": 7, "protect": [8, 10], "provid": [2, 6, 7, 10, 11, 12, 14, 15, 16], "provinc": [10, 11], "proxi": 5, "ps1": 6, "psu": 12, "psutil": [6, 7], "psy": [11, 12], "public": [2, 4, 15, 16], "publicli": 7, "publish": 4, "pue": 11, "purpos": 9, "push": 10, "pushgatewai": 10, "py": [2, 6, 7, 10, 13, 14, 15], "pypi": 5, "pyproject": 6, "python": [0, 5, 13, 15], "python3": [0, 13], "python_vers": 10, "quantifi": [4, 7], "quartil": 8, "question": 5, "questionari": 6, "quickstart": 5, "quot": 15, "r": [0, 7, 10, 13], "ram": [10, 11, 12, 15], "ram_energi": 10, "ram_pow": 10, "ram_total_s": 10, "ram_used_gb": 10, "ram_utilization_perc": 10, "rang": [10, 12], "rapidfuzz": 6, "rapl": [0, 5, 11, 13], "rapl_include_dram": 11, "rapl_prefer_psi": 11, "rapsberri": 7, "rare": 12, "raspberri": 7, "rate": 12, "rather": 7, "ratio": 7, "re": [6, 15], "read": [0, 7, 12, 15], "real": [5, 13], "realli": 7, "reason": [7, 9], "reboot": 12, "recent": 9, "recogn": [3, 4, 7, 9], "recommend": [3, 4, 6, 12, 15, 16], "record": 15, "recur": 4, "redirect": 15, "reduc": [4, 7, 10], "refer": [5, 6, 12, 14, 15], "region": [4, 5, 7, 10, 11, 15], "regist": 12, "releas": 4, "relev": 8, "reli": 15, "reliabl": [11, 12], "relu": 3, "remain": [1, 15], "remark": 9, "remov": 16, "render": 2, "renew": 7, "replac": 2, "repo": 4, "report": [7, 11, 12, 14, 15], "repositori": [3, 5, 13], "repres": [8, 12], "reproduc": 2, "request": [6, 15], "requir": [10, 11, 15, 16], "research": [2, 4], "reserv": 12, "resource_track": 7, "respect": [10, 15], "restart": 0, "restrict": 15, "result": [8, 10, 13, 15], "return": [3, 15], "rich": 6, "right": [7, 8, 12, 16], "ring": 12, "rocm": 12, "room": 7, "root": [0, 7], "row": 11, "rule": 10, "run": [0, 2, 3, 4, 6, 7, 10, 11, 12, 13, 16], "run_id": 11, "runtim": 16, "same": [7, 11, 12, 15], "sampl": 2, "save": [1, 2, 11, 14, 15], "save_to_api": [1, 11, 15], "save_to_fil": [11, 15], "save_to_logfir": [10, 11], "save_to_logg": [11, 14], "save_to_prometheu": [10, 11], "scale": [7, 8], "scaphandr": 12, "scenario": 13, "schedul": [3, 7, 15], "scheme": 4, "scientist": 2, "scp": 13, "script": [6, 15], "sculpt": 7, "sdk": 14, "seamlessli": 6, "search": [2, 5, 10], "sec": 12, "second": [0, 7, 10, 11], "section": [0, 3, 15], "sector": 9, "secur": 12, "see": [2, 3, 7, 10, 11, 12, 13, 14, 15, 16], "select": 12, "self": 10, "semiconductor": 7, "send": [0, 10, 11, 14, 15], "sent": 10, "separ": [11, 12], "sequenti": 3, "seri": 16, "server": [1, 5, 7, 10, 11, 12, 13], "servic": [5, 10], "set": [0, 1, 2, 10, 11, 12, 14, 15], "setlevel": 14, "sever": [12, 16], "sh": [6, 13, 15], "share": 16, "shell": 15, "short": [7, 11], "shot": 4, "should": [4, 7, 11], "show": [8, 12, 16], "shown": 16, "side": [8, 16], "sidebar": 2, "signific": [7, 9], "significantli": 7, "silicon": 7, "simplest": 3, "sinc": [7, 11, 12], "singl": [4, 7, 15], "size": 7, "skylak": 12, "sleep": 15, "slot": [7, 11], "small": [7, 8, 15], "smi": 12, "so": [1, 3, 4, 7, 10, 11, 12, 15], "socket": 12, "solar": 7, "solut": 7, "some": [7, 12, 14, 15], "soon": [1, 15], "sophist": 9, "sourc": [4, 8, 12], "sp0": 10, "spars": 12, "sparsecategoricalcrossentropi": 3, "spec": 12, "special": 15, "specif": [5, 7, 9, 14, 15], "specifi": [1, 10, 11, 14], "split": 15, "ssd": [12, 13], "ssh": [0, 13], "standalon": 5, "standard": [4, 7, 9, 11], "start": [2, 3, 7, 10, 14, 15], "start_task": 15, "state": [9, 10, 11], "stdout": 2, "stick": 7, "still": [3, 6, 7, 12, 14, 16], "stop": [3, 7, 10, 14, 15], "stop_task": 15, "strategi": 5, "stream": 14, "stress": [12, 13], "string": 11, "structur": 15, "studi": 8, "stuff": 7, "subclass": 14, "subdomain": 12, "subject": 7, "subscript": 4, "subset": 12, "subsystem": [7, 12, 13], "success": 4, "sudo": [0, 7, 11, 12, 13], "sudoer": 7, "suffix": 10, "sum": [10, 12], "summari": 15, "superus": 12, "supplement": 12, "suppli": [7, 12], "support": [7, 11, 12, 14, 15], "suppos": 12, "sure": 2, "surround": 15, "sustain": 4, "switch": [7, 16], "sy": [0, 7, 12, 13], "synchron": 7, "syntax": 15, "sysf": 0, "sysfsutil": 0, "syst": 12, "system": [0, 2, 7, 10, 11, 12, 14, 15], "systemat": 11, "systemctl": 0, "systemd": 0, "systemd_servic": 0, "t": [3, 7, 12, 13, 15], "tab": 2, "tabl": [7, 8], "take": 7, "takeawai": 5, "taken": 2, "target": [0, 10], "task": [0, 9, 15], "tdp": [7, 11, 13], "team": 1, "tee": 0, "televis": 7, "tell": 1, "templat": 0, "tensorflow": 3, "termin": [1, 6], "test": [12, 15], "text": 7, "tf": 3, "than": [7, 11, 12, 14], "thank": [1, 12], "thei": [7, 12], "them": [3, 4, 7, 12, 16], "themselv": 12, "therefor": 4, "thermal": 7, "thi": [0, 1, 3, 4, 7, 8, 9, 10, 11, 12, 14, 15, 16], "think": 3, "those": [7, 16], "thousand": 7, "through": [5, 7, 12], "thu": 9, "ti": 10, "time": [2, 5, 7, 10, 15, 16], "timeseri": 1, "timestamp": 10, "tini": 8, "tm": [7, 10], "token": [11, 15], "toml": 6, "ton": 7, "tool": [2, 7, 8, 15, 16], "toolkit": 7, "top": 16, "total": [7, 10, 11, 12, 16], "trace": 0, "track": [2, 3, 7, 9, 10, 11, 12, 14, 15], "track_emiss": [1, 3, 5, 15], "tracker": [3, 7, 10, 11, 14, 15], "tracking_mod": [10, 11, 15], "tradit": 12, "train": [1, 2, 3, 8, 9, 15], "train_model": [1, 3, 15], "training_loop": 15, "tran": 12, "transf": 8, "transit": 7, "trigger": [10, 14], "tripl": 12, "true": [1, 3, 10, 11, 12, 14, 15], "try": [3, 4, 7, 11, 15], "tv": 16, "two": [1, 3, 7, 12, 15], "txt": 15, "typer": 6, "typic": 14, "u": [0, 8, 10, 11], "ubiquit": 9, "ubuntu": [0, 7, 13], "ui": 2, "unbuff": 7, "unchang": 15, "unclear": 12, "uncor": 12, "under": [1, 7, 12, 15], "underli": [7, 9], "understand": [7, 16], "unexpectedli": 12, "unfortun": 4, "unit": [0, 7, 11], "unless": 12, "unread": 12, "unregist": 7, "unreli": [11, 12], "up": [0, 7, 10, 11, 15], "updat": [0, 11, 12, 13], "upload": 1, "url": 11, "us": [1, 4, 5, 7, 8, 9, 11, 12, 13, 14, 15, 16], "usa": 10, "usabl": [7, 14], "usag": [5, 11], "usb": 12, "user": [0, 5, 7, 11, 12, 15, 16], "useradd": 0, "usernam": 7, "usr": 7, "usual": 10, "util": 10, "uuid": 15, "uv": 13, "v100": 8, "v2": [7, 11, 12], "v3": [7, 11, 13], "v4": 16, "valid": 14, "valu": [7, 10, 11, 12, 15], "var": 0, "variabl": [0, 11, 15], "variat": 7, "variou": [7, 9, 12, 14, 16], "vast": 9, "ve": 2, "vehicl": 7, "vendor": 12, "venv": 0, "verbos": [0, 11], "veri": [7, 12], "version": [10, 11, 12, 13, 15], "via": [4, 9, 12], "victor": 15, "view": [2, 4], "virtual": 0, "vision": 8, "visual": [2, 5], "visudo": 7, "vit": 8, "viz": 16, "voil\u00e0": 2, "vol": 12, "w": [7, 10, 11, 12, 13], "wa": 7, "wai": [3, 15], "wait": 0, "wall": 12, "want": [7, 11, 12, 15], "wantedbi": 0, "warm": 9, "warn": [0, 11, 15], "watch": 16, "water": 11, "watt": [7, 11, 12], "we": [3, 4, 6, 7, 9, 12, 13, 15], "web": [1, 15], "webhook": 10, "websit": 2, "week": [7, 9], "weekli": 16, "weight": 7, "welcom": 7, "well": 4, "wh": 7, "what": [4, 7, 12], "when": [2, 4, 7, 10, 11, 12, 15], "where": [7, 10, 11, 15], "which": [6, 7, 9, 11, 15], "while": [6, 12, 15], "who": 16, "whole": 12, "wikipedia": 15, "wind": 7, "window": [6, 7, 10], "within": [6, 12, 15], "without": [7, 12, 15], "wonder": 15, "work": [0, 4, 6, 9, 15, 16], "workaround": 12, "workingdirectori": 0, "world": [4, 5, 7, 13], "would": [6, 7, 8, 9, 12], "wrap": [12, 15], "wraparound": 12, "wren": 4, "write": 15, "written": [11, 15], "wrong": 12, "wue": 11, "x": [7, 10, 11, 12, 13], "x86": 7, "x_test": 3, "x_train": 3, "xeon": 13, "xxx": 13, "y": [10, 12, 13], "y_test": 3, "y_train": 3, "year": [5, 7, 9], "yet": 15, "yield": 15, "yml": 0, "york": 11, "you": [0, 1, 2, 3, 4, 6, 7, 10, 11, 12, 13, 15, 16], "your": [0, 1, 2, 3, 4, 6, 7, 10, 11, 12, 15, 16], "your_api_kei": 0, "your_command": 15, "your_experiment_id": 0, "your_org_id": 0, "your_project_id": 0, "yourdomain": 0, "yourself": 7, "yourservernam": 0, "z": 12, "zone": 11}, "titles": ["Advanced Installation", "CodeCarbon API", "Comet Integration", "Examples", "Frequently Asked Questions", "CodeCarbon", "Installing CodeCarbon", "Methodology", "Model Comparisons", "Motivation", "Output", "Parameters", "RAPL Metrics", "Test of CodeCarbon on Scaleway hardware", "Collecting emissions to a logger", "Quickstart", "Visualize"], "titleterms": {"": 12, "15w": 12, "16": 12, "1950x": 12, "265h": 12, "28w": 12, "32": 12, "7": 12, "7600u": 12, "7th": 12, "access": 15, "across": 7, "advanc": 0, "ai": 8, "amd": 12, "an": 14, "ani": 15, "ansibl": 0, "api": [1, 10], "architectur": 12, "ask": 4, "authent": 14, "avail": 12, "behavior": 12, "calcul": 7, "car": 7, "carbon": [7, 16], "citizen": 7, "cli": 0, "cloud": [8, 14, 16], "code": 7, "codecarbon": [0, 1, 5, 6, 7, 10, 12, 13, 15], "collect": 14, "comet": 2, "command": 15, "comparison": [8, 16], "conda": 6, "configur": 15, "consumpt": 8, "context": [3, 15], "core": 12, "count": 12, "countri": 16, "cpu": 7, "creat": 14, "csv": 10, "data": 10, "decor": [3, 15], "depend": 6, "deploi": 0, "desktop": 12, "detail": 16, "die": 12, "directori": 0, "doe": 0, "domain": 12, "doubl": 12, "each": 10, "electr": [8, 16], "emiss": [7, 14], "emissiontrack": 14, "energi": 7, "environ": 6, "equival": [7, 16], "estim": 7, "exampl": [3, 12, 14], "experi": 10, "explicit": [3, 15], "field": 10, "formula": 7, "frequent": 4, "from": [6, 16], "gen": 12, "get": 5, "global": 16, "googl": 14, "gpu": 7, "hardwar": [7, 13], "hierarchi": 12, "how": [7, 10], "http": 10, "i7": 12, "impact": 8, "indic": 5, "input": 11, "instal": [0, 6, 16], "instanc": 8, "integr": 2, "intel": 12, "intens": [7, 16], "internet": 15, "introduct": 5, "kabi": 12, "kei": 12, "lake": 12, "laptop": 12, "line": 15, "linux": 0, "local": 10, "log": [5, 10, 14], "logfir": 10, "logger": [10, 14], "manag": [3, 15], "measur": 12, "methodologi": 7, "metric": [7, 12], "mode": [11, 15], "model": 8, "more": 16, "motiv": 9, "multi": 12, "non": 6, "object": [3, 15], "offlin": [11, 15, 16], "offlineemissionstrack": 11, "onlin": [15, 16], "output": [10, 11], "paramet": 11, "per": 16, "platform": 12, "playbook": 0, "power": 7, "prerequisit": 0, "prioriti": [7, 15], "product": 16, "prometheu": 10, "proxi": 15, "pypi": 6, "python": [6, 14], "question": 4, "quick": 0, "quickstart": 15, "r": 12, "ram": 7, "rapl": [7, 12], "real": 12, "refer": [7, 8], "region": [8, 16], "repositori": 6, "run": 15, "ryzen": 12, "scalewai": 13, "server": 15, "servic": 0, "sourc": 7, "specif": [11, 12], "standalon": 6, "start": [0, 5], "strategi": 12, "structur": 0, "summari": 16, "tabl": 5, "takeawai": 12, "tdp": 12, "test": [10, 13], "thread": 12, "threadripp": 12, "through": 15, "time": 8, "tm": 12, "track_emiss": 11, "tv": 7, "u": 7, "ultra": 12, "us": [0, 3, 6, 10], "usag": [7, 16], "user": 6, "visual": 16, "weekli": 7, "what": 0, "work": 7, "world": 12, "year": 8}}) \ No newline at end of file diff --git a/docs/test_on_scaleway.html b/docs/test_on_scaleway.html index 46892c82c..4b9eb0f52 100644 --- a/docs/test_on_scaleway.html +++ b/docs/test_on_scaleway.html @@ -14,8 +14,8 @@ - - + + diff --git a/docs/to_logger.html b/docs/to_logger.html index a5427138c..a49e49923 100644 --- a/docs/to_logger.html +++ b/docs/to_logger.html @@ -14,8 +14,8 @@ - - + + diff --git a/docs/usage.html b/docs/usage.html index 07681ed4a..1ed7d300a 100644 --- a/docs/usage.html +++ b/docs/usage.html @@ -14,8 +14,8 @@ - - + + @@ -121,7 +121,7 @@

    Online ModeEmissionsTracker object or the track_emissions decorator can be used, which has the offline parameter set to False by default.

    -

    Command line

    +

    Command line

    Create a minimal configuration file (just follow the prompts) :

    codecarbon config
    diff --git a/docs/visualize.html b/docs/visualize.html index 8111c4df1..d831a908d 100644 --- a/docs/visualize.html +++ b/docs/visualize.html @@ -14,8 +14,8 @@ - - + +