text: Search.setIndex({docnames:["contributing_carbon_region","contributing_new_metric","index","source/experiment_impact_tracker","source/experiment_impact_tracker.cpu","source/experiment_impact_tracker.disk","source/experiment_impact_tracker.emissions","source/experiment_impact_tracker.gpu","source/experiment_impact_tracker.py_environment","source/modules"],envversion:{"sphinx.domains.c":1,"sphinx.domains.changeset":1,"sphinx.domains.citation":1,"sphinx.domains.cpp":1,"sphinx.domains.javascript":1,"sphinx.domains.math":2,"sphinx.domains.python":1,"sphinx.domains.rst":1,"sphinx.domains.std":1,"sphinx.ext.todo":2,sphinx:56},filenames:["contributing_carbon_region.rst","contributing_new_metric.rst","index.rst","source/experiment_impact_tracker.rst","source/experiment_impact_tracker.cpu.rst","source/experiment_impact_tracker.disk.rst","source/experiment_impact_tracker.emissions.rst","source/experiment_impact_tracker.gpu.rst","source/experiment_impact_tracker.py_environment.rst","source/modules.rst"],objects:{"":{experiment_impact_tracker:[3,0,0,"-"]},"experiment_impact_tracker.compute_tracker":{ImpactTracker:[3,1,1,""],gather_initial_info:[3,3,1,""],launch_power_monitor:[3,3,1,""],read_latest_stats:[3,3,1,""]},"experiment_impact_tracker.compute_tracker.ImpactTracker":{get_latest_info_and_check_for_errors:[3,2,1,""],launch_impact_monitor:[3,2,1,""]},"experiment_impact_tracker.constants":{load_regions_with_bounding_boxes:[3,3,1,""],read_terrible_json:[3,3,1,""]},"experiment_impact_tracker.cpu":{common:[4,0,0,"-"],exceptions:[4,0,0,"-"],intel:[4,0,0,"-"],rapl:[4,0,0,"-"]},"experiment_impact_tracker.cpu.common":{assert_cpus_by_attributes:[4,3,1,""],get_cpu_count_adjusted_load_avg:[4,3,1,""],get_cpu_freq:[4,3,1,""],get_hz_actual:[4,3,1,""],get_my_cpu_info:[4,3,1,""]},"experiment_impact_tracker.cpu.exceptions":{CPUAttributeAssertionError:[4,4,1,""]},"experiment_impact_tracker.cpu.intel":{get_and_cache_cpu_max_tdp_from_intel:[4,3,1,""],get_rapl_power:[4,3,1,""]},"experiment_impact_tracker.cpu.rapl":{RAPLDifference:[4,1,1,""],RAPLDomain:[4,1,1,""],RAPLMonitor:[4,1,1,""],RAPLSample:[4,1,1,""]},"experiment_impact_tracker.cpu.rapl.RAPLDifference":{average_power:[4,2,1,""]},"experiment_impact_tracker.cpu.rapl.RAPLDomain":{construct:[4,2,1,""],is_subdomain:[4,2,1,""],parent_id:[4,2,1,""]},"experiment_impact_tracker.cpu.rapl.RAPLMonitor":{sample:[4,2,1,""]},"experiment_impact_tracker.cpu.rapl.RAPLSample":{energy:[4,2,1,""],take_sample:[4,2,1,""]},"experiment_impact_tracker.create_graph_appendix":{create_graphs:[3,3,1,""],create_scatterplot_from_df:[3,3,1,""],dateparse:[3,3,1,""],handle_cpu_count_adjusted_average_load:[3,3,1,""]},"experiment_impact_tracker.data_utils":{load_data_into_frame:[3,3,1,""],load_initial_info:[3,3,1,""],log_final_info:[3,3,1,""],safe_file_path:[3,3,1,""],write_csv_data_to_file:[3,3,1,""],write_json_data_to_file:[3,3,1,""],zip_data_and_info:[3,3,1,""],zip_files:[3,3,1,""]},"experiment_impact_tracker.disk":{common:[5,0,0,"-"]},"experiment_impact_tracker.disk.common":{measure_disk_speed_at_dir:[5,3,1,""],writetofile:[5,3,1,""]},"experiment_impact_tracker.emissions":{common:[6,0,0,"-"],us_ca_parser:[6,0,0,"-"]},"experiment_impact_tracker.emissions.common":{get_realtime_carbon:[6,3,1,""],get_realtime_carbon_source:[6,3,1,""],is_capable_realtime_carbon_intensity:[6,3,1,""]},"experiment_impact_tracker.emissions.us_ca_parser":{fetch_supply:[6,3,1,""],get_realtime_carbon_source:[6,3,1,""],get_ttl_hash:[6,3,1,""]},"experiment_impact_tracker.get_region_metrics":{get_current_location:[3,3,1,""],get_current_region_info:[3,3,1,""],get_region_by_coords:[3,3,1,""],get_sorted_region_infos:[3,3,1,""],get_zone_information_by_coords:[3,3,1,""],get_zone_name_by_id:[3,3,1,""]},"experiment_impact_tracker.gpu":{exceptions:[7,0,0,"-"],nvidia:[7,0,0,"-"]},"experiment_impact_tracker.gpu.exceptions":{GPUAttributeAssertionError:[7,4,1,""]},"experiment_impact_tracker.gpu.nvidia":{assert_gpus_by_attributes:[7,3,1,""],get_gpu_info:[7,3,1,""],get_nvidia_gpu_power:[7,3,1,""]},"experiment_impact_tracker.py_environment":{common:[8,0,0,"-"]},"experiment_impact_tracker.py_environment.common":{get_python_packages_and_versions:[8,3,1,""]},"experiment_impact_tracker.stats":{get_average_treatment_effect:[3,3,1,""],run_permutation_test:[3,3,1,""],run_test:[3,3,1,""]},"experiment_impact_tracker.utils":{gather_additional_info:[3,3,1,""],get_flop_count_tensorflow:[3,3,1,""],get_timestamp:[3,3,1,""],launch_power_monitorprocessify_func:[3,3,1,""],processify:[3,3,1,""]},experiment_impact_tracker:{compute_tracker:[3,0,0,"-"],constants:[3,0,0,"-"],cpu:[4,0,0,"-"],create_graph_appendix:[3,0,0,"-"],data_info_and_router:[3,0,0,"-"],data_utils:[3,0,0,"-"],disk:[5,0,0,"-"],emissions:[6,0,0,"-"],get_region_metrics:[3,0,0,"-"],gpu:[7,0,0,"-"],py_environment:[8,0,0,"-"],stats:[3,0,0,"-"],utils:[3,0,0,"-"],version:[3,0,0,"-"]}},objnames:{"0":["py","module","Python module"],"1":["py","class","Python class"],"2":["py","method","Python method"],"3":["py","function","Python function"],"4":["py","exception","Python exception"]},objtypes:{"0":"py:module","1":"py:class","2":"py:method","3":"py:function","4":"py:exception"},terms:{"60ghz":4,"class":[3,4],"default":[3,4],"final":0,"float":3,"function":[1,3],"import":0,"int":[3,4],"new":2,"null":3,"return":[1,3,4,6],"true":3,"try":4,The:3,Then:[0,1],_sourc:0,abc:0,about:4,abs:3,add:[0,1],all:[1,4],all_data:3,alpha:3,archiv:3,arcnam:3,arg:[3,4,5,6],argument:3,arxiv:3,assert:[4,7],assert_cpus_by_attribut:4,assert_gpus_by_attribut:7,attribut:[4,7],attributes_set:[4,7],avail:4,averag:0,average_pow:4,avoid:[4,7],back:4,base:[3,4,7],bf8feba89a0dfc547d6468227e69207f4c5f6bdb:0,blob:[0,1,5],bool:3,bound:3,box:3,brand:4,breakend:[0,1],bug:4,bureau:0,call:[0,1],can:0,carbon:2,carbonintens:0,certain:[4,7],chang:1,cite:3,classmethod:4,cluster:[4,7],co2eq_paramet:0,code:3,com:[0,1,3,5],come:4,common:[0,3,9],compar:3,compat:1,compatbil:1,compress:3,comput:3,compute_track:[1,9],confid:3,constant:9,construct:4,contain:3,content:[2,9],contribut:2,coord:3,coordin:0,correspond:3,cpu:[3,9],cpuattributeassertionerror:4,creat:[0,1,3],create_graph:3,create_graph_appendix:9,create_scatterplot_from_df:3,current:[4,7],data1:3,data2:3,data:[0,1,3],data_info_and_rout:[1,9],data_util:9,datepars:3,decor:3,descript:[1,3],dict:[3,4,7],dictionari:[1,3],differ:[3,4],disk:[3,9],diskspe:5,doe:3,domain:4,dst:3,each:3,effect:4,element:3,emiss:[0,3,9],enclos:0,encount:[4,7],energi:[0,4],error:4,estim:4,etc:7,everi:[1,3],exact:7,exampl:[0,4],except:[3,9],execut:3,experi:[0,1],experiment_impact_track:[0,1],fals:3,featur:0,fetch_suppli:6,fig_i:3,fig_x:3,file:3,file_path:3,filenam:[3,5],filepath:3,filter:[4,7],first:0,fossilfuelratio:0,freq:4,from:[0,3,4,5],func:3,futur:1,gather:4,gather_additional_info:3,gather_initial_info:3,geforc:7,geojson:0,geometri:[0,3],get:[0,1,4],get_and_cache_cpu_max_tdp_from_intel:4,get_average_treatment_effect:3,get_cpu_count_adjusted_load_avg:4,get_cpu_freq:4,get_current_loc:3,get_current_region_info:3,get_flop_count_tensorflow:3,get_gpu_info:7,get_hz_actu:4,get_latest_info_and_check_for_error:3,get_my_cpu_info:4,get_nvidia_gpu_pow:7,get_python_packages_and_vers:8,get_rapl_pow:4,get_realtime_carbon:6,get_realtime_carbon_sourc:6,get_region_by_coord:3,get_region_metr:9,get_sorted_region_info:3,get_timestamp:3,get_ttl_hash:6,get_zone_information_by_coord:3,get_zone_name_by_id:3,ghz:4,github:[0,1,5],give:3,given:3,goe:4,gov:0,gpu:[3,9],gpuattributeassertionerror:7,graph:3,gtx:7,handle_cpu_count_adjusted_average_load:3,hardwar:4,has:3,have:0,help:[4,7],here:[0,1],heterogen:[4,7],highli:4,how:2,http:[0,1,3,5],hypothesi:3,hz_advertis:4,impact:[0,1],impacttrack:3,imposs:4,includ:7,index:2,info:[3,4],inform:[0,4],initial_info:3,input_path:3,intel:[3,9],intens:0,introduc:1,is_capable_realtime_carbon_intens:6,is_subdomain:4,iter:[1,3],job:[4,7],join:3,json:[0,3],k40m:7,kei:[4,7],kwarg:[3,4,5,6,7],l131:1,launch_impact_monitor:3,launch_power_monitor:3,launch_power_monitorprocessify_func:3,let:0,level:[3,4],line:[0,3],list:[3,4],load:3,load_data_into_fram:3,load_initial_info:3,load_regions_with_bounding_box:3,log:[1,4],log_dir:[3,5],log_final_info:3,logdir:3,logger:[3,4,7],loop:1,machin:4,mai:1,main:1,malform:3,map:0,master:[0,1,5],match:7,max_level:3,measure_disk_speed_at_dir:5,memori:4,metric:2,metric_nam:1,metric_valu:1,mismatch:[4,7],modul:[2,9],modular:1,more:3,mostli:5,multipolygon:0,must:7,name:[0,1,3],narnia:0,narnia_pars:0,ndarrai:3,need:3,none:[3,4,5,7],notimplementederror:4,now:1,numpi:0,nvidia:[3,9],object:[3,4],occur:4,one:[3,4],option:[3,4],org:3,our:[0,1],out:[4,7],output_path:3,overwrit:3,packag:9,page:2,pair:[4,7],parallel:3,paramet:[3,4,7],parent_id:4,parser:0,path:[1,3,4],period:6,pickabl:3,pid_list:[4,7],pleas:3,power:4,pre:3,probabl:4,process:[3,4],processifi:3,product_nam:7,properti:0,pull:4,py_environ:[3,9],question:3,queue:3,rais:[4,7],rapl:[3,9],rapldiffer:4,rapldomain:4,raplmonitor:4,raplsampl:4,rather:[4,7],read:3,read_latest_stat:3,read_terrible_json:3,realtim:0,realtime_region:0,refer:3,region:[2,3,6],reject:3,rel:3,renewableratio:0,reproduc:3,rout:[0,1],router:1,run:[3,4,7],run_permutation_test:3,run_test:3,safe_file_path:3,sai:0,same:6,sampl:[3,4],sanderjo:5,scatterplot:3,search:2,second:6,see:0,seem:4,seen:7,session:3,set:[4,7],shape:3,should:[1,3],site:0,size_in_mb:5,slightli:3,smi:7,some:3,specifi:3,speed:5,src:3,stackoverflow:3,stat:9,str:[3,4],string:[3,7],style:1,submodul:9,subpackag:9,summari:3,sure:3,system:[0,1],take_sampl:4,taken:[3,5],tdp:4,tesla:7,test:3,test_id:3,thi:[0,1,3,4,7],time:6,time_in_sec:3,titan:7,top:4,tracker:[0,1],type:[0,3,4],unexpect:4,unit:[1,4],unlik:4,us_ca_pars:[0,3,9],use:4,used:[3,4],uses:1,using:3,util:9,valu:[3,6],valueerror:4,variabl:3,version:9,want:3,websit:4,well:1,what:[1,3],when:[4,7],where:3,which:[0,1],wish:0,withing:6,work:3,write:3,write_csv_data_to_fil:3,write_json_data_to_fil:3,writetofil:5,xeon:4,you:[1,4,7],your:1,zip:3,zip_data_and_info:3,zip_fil:3,zip_path:3,zipfil:3,zone:0,zone_id:3,zone_nam:0,zonegeometri:0,zonenam:0},titles:["How to Contribute A New Carbon Region","How to Contribute A New Metric","experiment-impact-tracker docs","experiment_impact_tracker package","experiment_impact_tracker.cpu package","experiment_impact_tracker.disk package","experiment_impact_tracker.emissions package","experiment_impact_tracker.gpu package","experiment_impact_tracker.py_environment package","experiment_impact_tracker"],titleterms:{"new":[0,1],carbon:0,common:[4,5,6,8],compute_track:3,constant:3,content:[3,4,5,6,7,8],contribut:[0,1],cpu:4,create_graph_appendix:3,data_info_and_rout:3,data_util:3,disk:5,doc:2,document:[],emiss:6,except:[4,7],experi:2,experiment_impact_track:[3,4,5,6,7,8,9],get:[],get_region_metr:3,gpu:7,how:[0,1],impact:2,indic:2,intel:4,metric:1,modul:[3,4,5,6,7,8],nvidia:7,packag:[3,4,5,6,7,8],py_environ:8,rapl:4,region:0,sphinx:[],start:[],stat:3,submodul:[3,4,5,6,7,8],subpackag:3,tabl:2,tracker:2,us_ca_pars:6,util:3,version:3,welcom:[]}})