searchindex.js

Search.setIndex({docnames:["api","api/modules","api/pysisso","background/index","how-to/index","index","license","license_link","reference/index","tutorial/index"],envversion:{"sphinx.domains.c":2,"sphinx.domains.changeset":1,"sphinx.domains.citation":1,"sphinx.domains.cpp":3,"sphinx.domains.index":1,"sphinx.domains.javascript":2,"sphinx.domains.math":2,"sphinx.domains.python":2,"sphinx.domains.rst":2,"sphinx.domains.std":1,"sphinx.ext.intersphinx":1,"sphinx.ext.viewcode":1,sphinx:56},filenames:["api.rst","api/modules.rst","api/pysisso.rst","background/index.rst","how-to/index.rst","index.rst","license.rst","license_link.rst","reference/index.rst","tutorial/index.rst"],objects:{"":{pysisso:[2,0,0,"-"]},"pysisso.inputs":{SISSODat:[2,1,1,""],SISSOIn:[2,1,1,""]},"pysisso.inputs.SISSODat":{SISSO_features_dimensions_ranges:[2,2,1,""],from_dat_file:[2,2,1,""],from_file:[2,2,1,""],input_string:[2,2,1,""],nsample:[2,2,1,""],nsf:[2,2,1,""],ntask:[2,2,1,""],to_file:[2,2,1,""]},"pysisso.inputs.SISSOIn":{AVAILABLE_OPERATIONS:[2,3,1,""],KW_TYPES:[2,3,1,""],from_SISSO_dat:[2,2,1,""],from_file:[2,2,1,""],from_sisso_keywords:[2,2,1,""],input_string:[2,2,1,""],is_classification:[2,2,1,""],is_regression:[2,2,1,""],set_keywords_for_SISSO_dat:[2,2,1,""],to_file:[2,2,1,""]},"pysisso.jobs":{SISSOJob:[2,1,1,""]},"pysisso.jobs.SISSOJob":{INPUT_FILE:[2,3,1,""],TRAINING_DATA_DILE:[2,3,1,""],postprocess:[2,2,1,""],run:[2,2,1,""],setup:[2,2,1,""]},"pysisso.outputs":{DescriptorsDataModels:[2,1,1,""],FeatureSpace:[2,1,1,""],ResidualData:[2,1,1,""],SISSODescriptor:[2,1,1,""],SISSOIteration:[2,1,1,""],SISSOModel:[2,1,1,""],SISSOOut:[2,1,1,""],SISSOParams:[2,1,1,""],SISSOVersion:[2,1,1,""],TopModels:[2,1,1,""],TopModelsCoefficients:[2,1,1,""],scd:[2,4,1,""]},"pysisso.outputs.DescriptorsDataModels":{from_dat_file:[2,2,1,""],from_file:[2,2,1,""]},"pysisso.outputs.SISSODescriptor":{evaluate:[2,2,1,""],from_string:[2,2,1,""]},"pysisso.outputs.SISSOIteration":{from_string:[2,2,1,""]},"pysisso.outputs.SISSOModel":{from_string:[2,2,1,""],predict:[2,2,1,""]},"pysisso.outputs.SISSOOut":{from_file:[2,2,1,""],model:[2,2,1,""],models:[2,2,1,""]},"pysisso.outputs.SISSOParams":{PARAMS:[2,3,1,""],from_string:[2,2,1,""]},"pysisso.outputs.SISSOVersion":{from_string:[2,2,1,""]},"pysisso.sklearn":{SISSORegressor:[8,1,1,""],get_timestamp:[2,4,1,""]},"pysisso.sklearn.SISSORegressor":{OMP:[2,2,1,""],__init__:[8,2,1,""],fit:[2,2,1,""],from_SISSOIn:[2,2,1,""],predict:[2,2,1,""]},"pysisso.utils":{get_version:[2,4,1,""],list_of_ints:[2,4,1,""],list_of_strs:[2,4,1,""],matrix_of_floats:[2,4,1,""],str_to_bool:[2,4,1,""]},"pysisso.validators":{NormalCompletionValidator:[2,1,1,""]},"pysisso.validators.NormalCompletionValidator":{check:[2,2,1,""]},pysisso:{inputs:[2,0,0,"-"],jobs:[2,0,0,"-"],outputs:[2,0,0,"-"],sklearn:[2,0,0,"-"],utils:[2,0,0,"-"],validators:[2,0,0,"-"]}},objnames:{"0":["py","module","Python module"],"1":["py","class","Python class"],"2":["py","method","Python method"],"3":["py","attribute","Python attribute"],"4":["py","function","Python function"]},objtypes:{"0":"py:module","1":"py:class","2":"py:method","3":"py:attribute","4":"py:function"},terms:{"001":[2,8],"048":7,"100":[2,8],"100000":[2,8],"185":7,"6534":7,"971":7,"boolean":2,"case":[2,7],"class":[2,8],"default":2,"final":[2,7],"float":2,"function":[2,7],"int":2,"new":[2,7],"public":7,"return":2,"true":[2,8],"while":2,ARE:7,FOR:7,For:[2,8],Not:2,One:2,SIS:2,SUCH:7,THAT:7,The:[2,5,6,7,8,9],Using:4,WILL:7,__init__:8,about:2,abs:2,academ:6,accept:7,access:[6,7],accord:7,account:7,acknowledg:[2,7],add:2,added:[7,8],addit:2,address:7,affect:7,affili:7,after:[2,7,8],against:7,agenc:7,agre:7,agreement:7,algorithm:2,all:[2,4,7,8],allow:2,allow_unfinish:2,alreadi:9,also:2,altern:9,amelior:7,amend:7,analysi:2,ani:[2,7],annex:7,anoth:7,anticip:7,anyth:7,api:5,appear:7,appli:[2,7],applic:7,appropri:7,argument:[2,8],aris:7,armand:7,arrai:2,arrang:7,assert:7,associ:7,attach:7,author:7,automat:[2,8],avail:2,available_oper:2,axi:2,background:5,bank:7,base:[2,7],baseestim:2,basic:2,be0748:7,becaus:7,becom:7,been:7,befor:2,being:2,belgian:7,belgium:7,belong:7,below:8,beneficari:7,beneficiari:7,benefit:7,best:2,between:[2,3,7],binari:2,bool:[2,8],bound:2,broadli:7,brought:7,build:7,buri:7,call:2,callabl:2,can:[4,8,9],cancel:7,cannot:7,care:4,carri:7,cast:2,cauchi:2,cbrt:2,chang:7,charact:[2,7],character:7,charleroi:7,check:[2,8],chosen:3,claim:7,classif:2,classmethod:2,clean:[2,8],clean_run_dir:[2,8],code:[4,7,8],coeffici:2,column:2,com:[4,5,7,8],combin:2,commerci:[6,7],commun:7,compani:7,compat:[2,8],complet:[2,8],complex:2,compli:7,compliant:2,compos:2,comput:[2,7],conclud:7,conclus:7,condit:7,conduct:7,confidenti:7,confirm:7,conflict:7,connect:7,consequenti:7,consider:7,constitut:7,constru:7,construct:[2,8],contact:6,contain:[2,7,8],content:[1,5],context:7,contract:7,conveni:7,convert:2,copi:7,core:2,correct:7,correspond:2,cos:2,could:2,counterpart:7,countri:7,courier:7,court:7,cpu_tim:2,creat:2,credit:7,crossroad:7,current:[2,8],custodian:[2,8],custodian_job_kwarg:[2,8],custodian_kwarg:[2,8],dai:[2,7],damag:7,darrai:2,dat:2,data:[2,7],datafram:2,date:2,datetim:2,ddd:2,deal:7,deem:7,defin:7,delai:7,delimit:2,delimiter_ax0:2,delimiter_ax1:2,deliv:7,demand:7,depart:7,depend:4,desc_dat:2,desc_dddd_pppp:2,desc_dim:[2,8],descript:2,descriptor:2,descriptor_dimens:2,descriptor_id:2,descriptor_identification_keyword:2,descriptor_str:2,descriptorsdatamodel:2,design:7,detail:[6,8],develop:7,dict:[2,8],dictionari:2,differ:[2,3,7],dimclass:[2,8],dimens:2,dimension_typ:2,dimensionless:2,directori:[2,4,8],discharg:7,disclaim:7,discret:7,displai:7,disput:7,distribut:[2,6,7],document:7,doe:7,done:2,download:7,drop:7,durat:7,duti:7,each:[2,7],effect:7,either:7,element:7,email:7,emb:7,embed:7,embodi:7,empti:2,enabl:7,end:2,enterpris:7,entiti:7,equit:7,err:2,error:2,establish:7,evalu:2,even:7,event:7,everyth:2,evid:7,exampl:[2,7],excerpt:2,exclus:7,execut:[2,7],exemplari:7,exercis:7,exp:2,explain:3,exploit:7,express:7,expressli:7,extent:7,extract:2,failur:7,fair:7,faith:7,fals:[2,8],favor:7,featn:2,featur:2,feature1:2,feature2:2,feature3:2,feature4:2,feature_construction_sure_independence_screening_keyword:2,feature_spac:2,features_dimens:[2,8],featurespac:2,file:2,filenam:2,filepath:2,find:9,first:2,fit:[2,7],fit_intercept:[2,8],fix:2,follow:[4,7],forth:7,found:8,frame:2,free:7,from:[2,4,7,8],from_dat_fil:2,from_fil:2,from_sisso_dat:2,from_sisso_keyword:2,from_sissoin:2,from_str:2,full:7,further:7,gather:4,gener:7,get:[2,4,5],get_timestamp:2,get_vers:2,github:[4,5,8],given:[2,7],good:7,govern:7,goze:7,grant:7,graphic:7,guid:5,hand:7,has:[2,7,8],have:[2,4,7,9],head:7,header:2,header_str:2,helper:2,here:[6,8],herebi:7,herein:7,hereinaft:7,hereof:7,hereto:7,hereund:7,highest:2,how:5,howev:7,http:[4,5,8],identif:7,identifi:2,imbed:7,immedi:7,implement:2,impli:7,improv:7,incident:7,includ:7,incorpor:7,inde:2,indefinit:7,independ:[5,7],index:[2,5],indirect:7,ineffect:7,info:[2,7],inform:[2,5,7,8],infring:7,input:1,input_fil:2,input_str:2,insert:7,instal:[5,7],instrument:7,integ:2,intellectu:7,intercept:2,interfac:[2,3,7],intern:7,interpret:7,invalid:7,is_classif:2,is_regress:2,isconvex:[2,8],iter:2,iteration_numb:2,its:[2,7],itself:[2,7],job:[1,8],json:2,kei:2,keyword:[2,8],kingdom:7,kw_type:2,kwarg:2,l1_den:[2,8],l1_max_it:[2,8],l1_minrms:[2,8],l1_nlambda:[2,8],l1_tole:[2,8],l1_warm_start:[2,8],l1_weight:[2,8],l1l0_size4l0:[2,8],lai:7,last:2,latest:4,law:7,lead:2,learn:[2,8],least:[7,9],left:2,legal:7,less:2,letter:7,level:7,liabil:7,liabl:7,licens:5,license:7,like:2,limit:7,line:2,link:7,list:[2,8],list_of_int:2,list_of_str:2,locat:7,log:2,logo:7,loss:7,lower:2,lower_bound_maxabs_valu:2,made:7,mai:7,main:[0,2,8],maintain:7,mainten:7,make:7,mandatori:[2,7,8],manipul:2,manner:7,manual:7,map:2,match:2,materi:7,matgenix:[2,4,6,7],matgenix_acknowledg:2,matrix:2,matrix_of_float:2,max:2,max_feature_complex:2,maxa:2,maxcomplex:[2,8],maxfval_lb:[2,8],maxfval_ub:[2,8],maximum:7,mean:7,meant:8,media:7,mention:7,merchant:7,method:[2,8],metric:[2,8],might:2,minimum:7,model:2,model_typ:2,modif:7,modifi:7,modul:[0,1,5],monti:2,moral:7,more:[7,8],most:5,msonabl:2,multi:2,must:2,n_dimension_typ:2,n_featur:2,n_rung:2,n_sampl:2,n_scalar_featur:2,n_task:2,n_topmodel:2,name:[2,7,8],nan:2,ndarrai:2,need:[2,4],neither:7,nice:2,nm_output:[2,8],nnnn:2,non:6,none:[2,8],nor:7,normal:2,normalcompletionvalid:2,note:[2,7],notic:7,notwithstand:7,npf_must:[2,8],nproc:2,nsampl:2,nsf:2,ntask:[2,8],number:[2,7],number_of_sampl:2,numpi:2,nvf:[2,8],object:[2,5],oblig:7,obtain:[2,7],offer:7,offic:7,omp:2,one:[2,7],onli:7,open:6,oper:[2,5,7],opset:[2,8],option:[2,8],oral:7,order:7,org:4,organ:4,origin:7,orthogon:2,other:7,otherwis:[2,7],out:[2,7,8],output:1,output_fil:2,own:7,owner:7,packag:[0,1,5,6],page:[4,5],panda:2,param:2,paramet:[2,8],pars:2,part:7,parti:7,partial:7,particular:[2,7,8],particularli:7,pass:2,patent:7,path:2,patient:5,perform:[2,7],period:7,permit:7,person:7,pertain:7,piec:7,pip:[4,9],pleas:5,poetri:4,polici:7,popen:2,possibl:[2,7],post:7,postprocess:2,ppp:2,preclud:7,predict:2,present:[7,8],previou:2,primari:2,princip:7,principl:7,process:2,product:7,profit:6,progress:5,prohibit:7,properti:[2,7],property_typ:2,proprietari:7,protect:7,provid:[2,7],ptype:2,purpos:7,pursuant:7,pursuit:2,pypi:4,pysisso:[0,4,6,7,8,9],python:[4,5,9],rais:2,rang:2,rank:2,rather:7,read:2,reason:7,receipt:7,receiv:7,recogn:7,recurs:2,refer:[5,7],regardless:7,regist:7,regress:2,regressor:[2,8],regressormixin:2,rel:2,relat:[2,7],releas:7,relev:[2,5],remain:7,remaind:7,remedi:7,remov:[2,7],repres:2,represent:2,reproduc:7,request:7,requir:[4,7],res_dddd_pppp:2,rescind:7,reshap:2,residu:2,residualdata:2,respons:7,restart:[2,8],result:2,right:7,rmse:[2,8],root:4,rouyang2017:[5,8],royalti:7,rue:7,run:[2,4,8],run_dir:[2,8],rung:[2,8],said:7,same:7,sampl:2,samplen:2,save:7,scalar:2,scd:2,schedul:7,scikit:[2,8],screen:5,search:5,second:2,section:[4,7,8,9],see:[2,8],select:2,send:7,sent:7,seri:4,servic:7,set:[2,7,8],set_keywords_for_sisso_dat:2,settl:7,setup:2,shall:7,shape:2,should:[2,4],sign:7,sin:2,singl:[2,7],sis_subspace_s:2,sis_subspaces_s:2,sisso:[2,5,8],sisso_dat:2,sisso_dir:[2,8],sisso_ex:2,sisso_features_dimensions_rang:2,sisso_in:2,sisso_model:2,sissodat:2,sissodescriptor:2,sissoin:2,sissoiter:2,sissojob:2,sissomodel:2,sissoout:2,sissoparam:2,sissoregressor:[2,8],sissovers:2,size:2,sklearn:[1,8],small:2,sole:7,some:2,sourc:[2,4,6,7,8],space:2,space_dddd:2,sparsif:2,sparsifi:5,sparsification_method:2,special:7,specif:[7,8],specifi:7,split:2,sqrt:2,srl:7,stabl:4,stamp:2,standard:[2,7],start:[2,5],state:7,stderr_fil:2,stdout_fil:2,step:2,store:2,str:[2,8],str_dimens:2,str_isconvex:2,str_oper:2,str_to_bool:2,string:2,strip:2,sublicens:7,submodul:1,subprocess:2,subs_si:[2,8],subspac:2,substant:7,substr:2,summari:2,suppli:7,support:[2,7],suppos:2,sure:5,take:4,taken:[2,7],target:2,target_properties_keyword:2,task:2,task_weight:[2,8],taskn:2,technic:[5,7],telecopi:7,term:7,termin:7,test:2,text:7,than:[2,7],thei:[2,7],theori:7,thereof:7,thi:[2,3,4,5,7,8,9],third:[2,7],three:2,time:[2,7],timestamp:[2,8],to_fil:2,togeth:[2,7],top:2,topmodel:2,topmodelscoeffici:2,topnnnn_dddd:2,topnnnn_dddd_coeff:2,tort:7,total:2,total_number_properti:2,trade:7,trademark:7,trail:2,train:2,training_data_dil:2,transfer:7,transform:2,tstamp:2,tupl:2,tutori:9,type:2,unari:2,unchang:2,under:7,unfinish:2,union:[2,8],uniqu:[2,8],unit:[2,7],univers:7,unless:7,updat:[2,7],upon:7,upper:2,upper_bound_maxabs_valu:2,usag:[6,7,9],use:[2,7,8],use_custodian:[2,8],used:[2,7,8],user:6,using:[4,7],usual:2,util:1,valid:[1,7],valu:2,valueerror:2,variabl:2,variou:2,vector:2,version:[2,4,9],vf2sf:[2,8],vfsize:[2,8],wai:[2,7],waiv:7,waiver:7,want:[2,4,7],warrant:7,warranti:7,well:7,whatsoev:7,when:[2,7],where:[2,7,8],wherev:7,whether:[2,8],which:[2,7],whitespac:2,whole:7,why:5,width:[2,8],wish:7,within:7,without:[2,7],work:5,worldwid:7,would:7,wrapper:5,write:[2,7],written:7,you:[4,7,9]},titles:["API Reference","pysisso","pysisso package","Background information","How-to guides","Welcome to pysisso\u2019s documentation!","License","LICENSE - ACADEMICS AND NON-PROFIT USERS","Technical reference","Get started"],titleterms:{AND:7,THE:7,USE:7,academ:7,api:[0,8],articl:7,background:3,bodi:7,content:2,copyright:7,definit:7,document:5,except:7,get:9,government:7,guid:4,how:4,indic:5,inform:3,input:2,instal:[4,9],job:2,licens:[6,7],miscellan:7,modul:2,most:8,non:7,object:8,output:2,packag:2,profit:7,provis:7,pysisso:[1,2,5],python:3,refer:[0,8],relev:8,sklearn:2,softwar:7,start:9,submodul:2,tabl:5,technic:8,user:7,util:2,valid:2,welcom:5,why:3,wrapper:3}})