text: Search.setIndex({docnames:["_source/config","_source/core","_source/data_sources","_source/execute","_source/external","_source/modules","_source/overview","_source/run","_source/template","index"],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.intersphinx":1,"sphinx.ext.todo":2,sphinx:56},filenames:["_source\\config.rst","_source\\core.rst","_source\\data_sources.rst","_source\\execute.rst","_source\\external.rst","_source\\modules.rst","_source\\overview.rst","_source\\run.rst","_source\\template.rst","index.rst"],objects:{"":{config:[0,0,0,"-"],core:[1,0,0,"-"],external:[4,0,0,"-"]},"core.data_collection":{add_constituency_col:[1,1,1,""],append_columns:[1,1,1,""],calculate_daily_return:[1,1,1,""],create_constituency_matrix:[1,1,1,""],create_gics_matrix:[1,1,1,""],generate_company_lookup_dict:[1,1,1,""],generate_gics_sector:[1,1,1,""],generate_index_lookup_dict:[1,1,1,""],generate_study_period:[1,1,1,""],get_all_constituents:[1,1,1,""],get_data_table:[1,1,1,""],get_index_constituents:[1,1,1,""],list_tables:[1,1,1,""],load_full_data:[1,1,1,""],retrieve_index_history:[1,1,1,""]},"core.data_processor":{DataLoader:[1,2,1,""]},"core.data_processor.DataLoader":{generate_train_batch:[1,3,1,""],generate_tree_features:[1,3,1,""],get_test_data:[1,3,1,""],get_train_data:[1,3,1,""]},"core.execute":{get_market_metrics:[1,1,1,""],main:[1,1,1,""],preprocess_data:[1,1,1,""],test_model:[1,1,1,""]},"core.model":{LSTMModel:[1,2,1,""],MixedEnsemble:[1,2,1,""],TreeEnsemble:[1,2,1,""],WeightedEnsemble:[1,2,1,""],get_optimizer:[1,1,1,""]},"core.model.LSTMModel":{build_model:[1,3,1,""],fit:[1,3,1,""],get_params:[1,3,1,""],load_model:[1,3,1,""],predict:[1,3,1,""],train:[1,3,1,""],train_generator:[1,3,1,""]},"core.model.MixedEnsemble":{combinations:[1,3,1,""],data_set_indices:[1,3,1,""],fit:[1,3,1,""],from_classifier_list:[1,3,1,""],get_params:[1,3,1,""],is_mixed_ensemble:[1,3,1,""],model_type:[1,3,1,""],predict:[1,3,1,""],predict_all:[1,3,1,""],val_scores:[1,3,1,""]},"core.model.TreeEnsemble":{build_model:[1,3,1,""],fit:[1,3,1,""],get_params:[1,3,1,""]},"core.model.WeightedEnsemble":{fit:[1,3,1,""],get_params:[1,3,1,""],is_weighted_ensemble:[1,3,1,""],predict:[1,3,1,""],predict_all:[1,3,1,""]},"core.utils":{CSVReader:[1,2,1,""],CSVWriter:[1,2,1,""],ProgressBar:[1,2,1,""],Timer:[1,2,1,""],add_to_json:[1,1,1,""],annualize_metric:[1,1,1,""],apply_batch_directory:[1,1,1,""],calc_excess_returns:[1,1,1,""],calc_sharpe:[1,1,1,""],calc_sortino:[1,1,1,""],check_data_conformity:[1,1,1,""],check_directory_for_file:[1,1,1,""],countdown:[1,1,1,""],deannualize:[1,1,1,""],df_to_html:[1,1,1,""],get_index_name:[1,1,1,""],get_model_parent_type:[1,1,1,""],get_most_recent_file:[1,1,1,""],get_run_number:[1,1,1,""],get_study_period_ranges:[1,1,1,""],load_json_to_df:[1,1,1,""],lookup_multiple:[1,1,1,""],plot_data:[1,1,1,""],plot_results:[1,1,1,""],plot_train_val:[1,1,1,""],pretty_print_table:[1,1,1,""],print_study_period_ranges:[1,1,1,""],to_combinations:[1,1,1,""],to_monthly:[1,1,1,""],write_to_logs:[1,1,1,""]},"core.utils.CSVReader":{field_names:[1,3,1,""],get_last_row:[1,3,1,""],get_last_row_value:[1,3,1,""],path_exists:[1,3,1,""]},"core.utils.CSVWriter":{add_line:[1,3,1,""]},"core.utils.ProgressBar":{print_progress:[1,3,1,""]},"core.utils.Timer":{start:[1,3,1,""],stop:[1,3,1,""]},"external.dm_test":{autocovariance:[4,1,1,""],dm_test:[4,1,1,""]},core:{data_collection:[1,0,0,"-"],data_processor:[1,0,0,"-"],execute:[1,0,0,"-"],model:[1,0,0,"-"],utils:[1,0,0,"-"]},external:{dm_test:[4,0,0,"-"]}},objnames:{"0":["py","module","Python module"],"1":["py","function","Python function"],"2":["py","class","Python class"],"3":["py","method","Python method"]},objtypes:{"0":"py:module","1":"py:function","2":"py:class","3":"py:method"},terms:{"boolean":1,"class":[1,8],"default":1,"export":1,"float":1,"function":[1,4],"import":1,"int":1,"long":9,"new":1,"null":4,"return":[1,4,9],"short":9,"static":1,"true":1,For:4,The:[1,2,4,6,8,9],Use:1,Using:9,_exampl:8,_perform:1,abov:8,accord:1,accur:4,accuraci:[1,4],acquir:2,actual:4,actual_lst:4,add:1,add_constituency_col:1,add_lin:1,add_to_json:1,added:1,addit:1,advanc:9,aggreg:1,ahead:[1,4],aim:9,all:1,all_predict:1,alpha:1,alreadi:1,altern:4,american:1,analysi:[5,6],analyz:1,anh:9,ann:8,annual:1,annualize_metr:1,anoth:8,api:2,append:1,append_column:1,appli:1,apply_batch_directori:1,approach:1,arab:8,arbitrag:9,arbitrari:1,argument:[1,8],arrai:1,asset:9,autocovari:4,avail:1,averag:1,axi:1,backward:1,bag:1,bank:2,bar:1,bar_length:1,base:[1,6],basi:1,basic:9,batch:1,batch_siz:1,being:1,bodi:8,bond:2,bool:1,boost:9,browser:1,build:1,build_model:1,bullet:8,calc_excess_return:1,calc_sharp:1,calc_sortino:1,calcul:1,calculate_daily_return:1,call:1,can:8,candid:1,capit:9,cast_typ:1,ceil:1,cell:8,chair:9,chang:1,charact:1,check:1,check_data_conform:1,check_directory_for_fil:1,christoph:9,cit2002:8,classif:1,classifi:1,classifier_list:1,classifier_typ:1,classifier_type_list:1,classmethod:1,code:[1,9],col:1,col_1:1,col_2:1,col_multi_index:1,collect:1,column:[1,8],column_list:1,combin:1,compani:1,comparison:1,complet:1,compon:1,config:[1,5],configur:1,conform:1,connect:1,consid:1,consist:8,consol:1,constitu:1,constituency_matrix:1,construct:1,contain:[1,8],content:[5,9],convert:1,core:5,correspond:1,cost:1,count:1,countdown:1,creat:1,create_constituency_matrix:1,create_dir:1,create_gics_matrix:1,crit:4,criterion:[1,4],cross:8,csv:1,csvreader:1,csvwriter:1,cumul:1,current:1,custom:1,daili:1,data:[1,9],data_col:1,data_collect:5,data_gen:1,data_i:1,data_length:1,data_orig:1,data_processor:5,data_record:1,data_set_indic:1,data_x:1,databas:1,datafram:1,dataload:1,date:1,date_col:1,datetim:1,deannual:1,decim:1,decis:9,deep:9,deep_learn:1,defin:[8,9],deriv:9,descript:1,determin:1,devis:9,df_to_html:1,dict:1,dict_entri:1,dict_of_dict:1,dictionari:1,differ:4,digit:1,direct:1,directori:1,directory_path:1,displai:1,dm_test:5,document:2,doe:1,doi:9,done:8,download:1,e_1:4,e_2:4,each:1,edit:1,effect:1,ejor:9,element:8,elk:8,emphasi:8,empir:9,end:1,end_dat:1,end_index:1,engin:9,enough:1,ensembl:1,entri:1,enumer:8,epoch:1,equal:1,equal_weight:1,error:4,etc:1,europ:6,european:9,exampl:8,except:8,excess:[1,9],execut:5,exist:1,export_as_png:1,extend:9,extern:[5,8],extract:1,extratreesclassifi:1,fals:1,fancy_grid:1,featur:1,feature_nam:1,feder:2,field_nam:1,file:[1,8],file_nam:1,file_path:1,filenam:1,filepath:1,financi:1,first:4,fischer:9,fit:1,fit_arg:1,flag:1,folder:1,folder_path:1,follow:1,footnot:8,forc:1,force_download:1,forecast:4,forest:[1,9],form:1,format:1,frame:1,free:[1,9],from:[1,2,6],from_classifier_list:1,from_fil:1,from_mix:1,full:1,full_data:1,full_date_rang:1,func_arg:1,gener:1,generate_company_lookup_dict:1,generate_dict:1,generate_gics_sector:1,generate_index_lookup_dict:1,generate_study_period:1,generate_train_batch:1,generate_training_window:1,generate_tree_featur:1,german:2,get:1,get_all_constitu:1,get_data_t:1,get_index_constitu:1,get_index_nam:1,get_last_row:1,get_last_row_valu:1,get_market_metr:1,get_model_parent_typ:1,get_most_recent_fil:1,get_optim:1,get_param:1,get_run_numb:1,get_study_period_rang:1,get_test_data:1,get_train_data:1,get_val_score_onli:1,gic:1,given:1,global:1,going:1,govern:2,gradient:9,greater:4,gvkei:1,gvkeyx:1,gvkeyx_name_dict:1,gvkeyx_name_dict_na:1,half:1,handl:1,harvei:4,have:[1,4,8],header:[1,8],helper:1,histor:1,histori:1,hold:1,holding_period:1,how:8,html:1,http:8,huck:9,hyperlink:8,hypothesi:4,identifi:1,implement:[1,4],includ:1,indent:8,index:[1,9],index_col:1,index_id:1,index_nam:1,indic:1,individu:1,industri:1,info:1,inform:[1,9],inlin:8,input:1,instanc:1,integ:1,intern:8,interpret:8,is_mixed_ensembl:1,is_weighted_ensembl:1,jaquart:9,journal:9,json:1,just:8,kei:1,kera:1,key_to_low:1,kit:9,krauss2017:9,krauss2018:9,krauss:9,kwarg:1,label:[1,8],label_map:1,lag:1,last:1,last_n:1,learn:[1,9],least:8,len_train:1,length:1,less:4,letter:8,level:[1,4],leybourn:4,librari:1,like:8,line:1,list:[1,4],list_of_obj:1,list_tabl:1,liter:8,load:1,load_from_fil:1,load_full_data:1,load_json_to_df:1,load_last:1,load_model:1,loc:1,log:1,logic:1,look:1,lookup:1,lookup_dict:1,lookup_multipl:1,lookup_t:1,loop:1,loui:2,lowercas:1,lstm:[1,9],lstmmodel:1,machin:[1,9],mad:4,mai:8,main:[1,6],make:1,map:1,mape:4,market:[1,9],market_log:1,market_portfolio:1,markup:8,math:1,matrix:1,mean:9,meaning:4,memori:[1,9],merg:1,merge_g:1,messag:1,method:[1,4,9],metric:1,mine:8,miss:8,mix:1,mixedensembl:1,model:5,model_typ:1,modifi:4,modul:[5,8,9],monthli:1,more:4,most:1,mse:4,multi:1,multiindex:1,mute:1,n_period:1,n_recent:1,name:1,namedtupl:4,ndarrai:1,nest:1,network:9,neural:9,newbold:4,nicola:9,none:[1,4],normal:1,north:1,north_america:1,number:[1,4,8],numer:8,numpi:1,object:1,obs:1,observ:1,obtain:[1,2],onli:[1,4],oob:1,oob_scor:1,open:1,open_window:1,oper:[1,9],opportun:9,optim:1,optimizer_nam:1,option:[1,4],org:8,origin:1,otherwis:1,out:1,output:1,output_path:1,over:1,overwrit:1,packag:5,page:[1,9],panda:1,paragraph:8,param:[1,4],paramet:1,parametr:1,parent:1,parent_model_typ:1,pass:1,path:[0,1],path_exist:1,patrick:9,per:1,percent:1,percentag:1,perform:1,performance_bas:1,period:1,period_rang:1,pertain:[4,9],plot:1,plot_data:1,plot_result:1,plot_train_v:1,png:1,point:8,poli:4,portfolio:1,posit:1,power:4,pre:1,pred1_lst:4,pred2_lst:4,predict:[1,4],predict_al:1,predicted_data:1,predictions_indexed_merg:1,prefix:1,prepar:1,preprocess:1,preprocess_data:1,pretty_print_t:1,previou:9,price:9,print:1,print_constitu:1,print_progress:1,print_statu:1,print_study_period_rang:1,process:1,processor:8,progress:1,progressbar:1,project:[0,2],properti:1,propos:4,provid:[0,1],proxi:2,python:[2,8],qualifi:1,queri:1,query_str:1,random:[1,9],randomforestclassifi:1,rang:1,rank:1,rank_bas:1,rate:[1,9],ratio:1,reader:1,recent:1,record:1,reduc:1,refer:[4,8],regard:1,relev:1,repositori:9,repres:1,research:[1,2,9],reserv:2,respect:1,rest:2,retriev:1,retrieve_index_histori:1,retroact:1,return_seri:1,return_validation_data:1,revers:1,reverse_lookup:1,rf_rate_seri:1,risk:[1,9],roman:8,root:0,root_dir:0,row:[1,8],run:[1,5],same:4,sampl:1,save:1,save_dir:1,save_to_fil:1,scheme:1,score:1,search:[1,9],second:[1,4],section:2,semest:9,seminar:9,separ:1,seq_len:1,sequenc:1,sequence_length:1,seri:[1,4],serv:0,servic:[1,2],set:1,shape:1,sharp:1,should:1,show:1,show_import:1,show_n_row:1,side:4,size:1,someth:8,sortino:1,sourc:9,space:8,span:8,specif:9,specifi:[1,4],split:1,split_index:1,sql:1,sql_queri:1,standalon:8,standard:1,start:1,start_dat:1,start_index:1,statist:9,statu:1,step:[1,4],steps_per_epoch:1,stock:1,stock_id:1,stop:1,storag:1,store:1,store_png:1,str:1,strategi:9,string:[1,4],strong:8,structur:1,studi:1,study_period_data:1,study_period_length:1,study_period_rang:1,style:1,subdirectori:1,submodul:5,substitut:8,supervis:9,sure:1,t_cost:1,tabl:1,table_info:1,tablefmt:1,tabular:1,tag:1,target:[1,8],term:[1,9],termin:1,test:[1,4],test_data_end_d:1,test_data_index:1,test_data_index_merg:1,test_data_start_d:1,test_model:1,test_period_length:1,text:[1,8],textual:8,than:4,theori:8,thi:[0,1,2,4,8,9],thoma:9,through:0,time:1,timer:1,titl:[1,9],to_combin:1,to_monthli:1,total:1,trade:9,train:1,train_gener:1,transact:1,transform:1,tree:[1,9],tree_bas:1,treeensembl:1,treeenseml:1,true_data:1,tupl:1,turn:1,two:4,two_sid:4,type:[1,4],union:1,uniqu:1,unique_indic:1,univers:9,unseen:1,usag:1,use:1,used:[1,2],using:1,util:5,val_scor:1,valid:1,validation_data:1,validation_rang:1,validation_split:1,valu:[1,4],variabl:[0,1],verbos:1,via:[1,2],visual:1,warn:1,weight:1,weightedensembl:1,weighting_criterion:1,well:1,wharton:[1,2],what:8,when:4,whether:1,which:1,window:1,winter:9,withing:1,work:9,wrd:1,write:1,write_to_log:1,writer:1,www:8,x_test:1,x_train:1,xml:8,xslt:8,xuan:9,y_test:1,y_test_indexed_merg:1,y_test_merg:1,y_titl:1,y_train:1,year:2,yield:[1,2],you:1},titles:["config module","core package","Data Sources","execute module","external package","Financial","Basic Specification","run module","Basic Specification","Documentation of Financial Time Series Prediction"],titleterms:{analysi:1,basic:[6,8],block:8,citat:8,command:8,config:0,content:[1,4],core:1,data:[2,6,8],data_collect:1,data_processor:1,definit:8,dm_test:4,document:9,execut:[1,3],extern:4,field:8,financi:[5,9],free:2,get:[6,8],index:2,indic:9,instal:[6,8],line:8,list:8,model:1,modul:[0,1,3,4,7],option:8,overview:9,packag:[1,4],predict:9,project:9,quot:8,rate:2,refer:9,requir:[6,8],risk:2,run:7,seri:9,simpl:8,sourc:2,specif:[6,8],start:[6,8],submodul:[1,4],tabl:[8,9],time:9,util:1}})