text: Search.setIndex({docnames:["README","adjacency_features","clf_utilities","config","features_utilities","index","osm_utilities","textual_features","writers"],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.viewcode":1,sphinx:56},filenames:["README.rst","adjacency_features.rst","clf_utilities.rst","config.rst","features_utilities.rst","index.rst","osm_utilities.rst","textual_features.rst","writers.rst"],objects:{"":{adjacency_features:[1,0,0,"-"],clf_utilities:[2,0,0,"-"],config:[3,0,0,"-"],features_utilities:[4,0,0,"-"],osm_utilities:[6,0,0,"-"],textual_features:[7,0,0,"-"],writers:[8,0,0,"-"]},"config.config":{DecisionTree_hyperparameters:[3,3,1,""],LogisticRegression_hyperparameters:[3,3,1,""],MLP_hyperparameters:[3,3,1,""],NaiveBayes_hyperparameters:[3,3,1,""],RandomForest_hyperparameters:[3,3,1,""],SVM_hyperparameters:[3,3,1,""],classes_in_neighbors_thr:[3,3,1,""],classes_in_radius_thr:[3,3,1,""],classes_in_street_and_radius_thr:[3,3,1,""],experiments_path:[3,3,1,""],id_col:[3,3,1,""],included_adjacency_features:[3,3,1,""],included_classifiers:[3,3,1,""],included_textual_features:[3,3,1,""],kNN_hyperparameters:[3,3,1,""],k_preds:[3,3,1,""],label_col:[3,3,1,""],lat_col:[3,3,1,""],lon_col:[3,3,1,""],n_folds:[3,3,1,""],name_col:[3,3,1,""],normalized_features:[3,3,1,""],osm_crs:[3,3,1,""],poi_crs:[3,3,1,""],poi_fpath:[3,3,1,""],supported_adjacency_features:[3,3,1,""],supported_classifiers:[3,3,1,""],supported_textual_features:[3,3,1,""],top_k:[3,3,1,""],top_k_fourgrams_pct:[3,3,1,""],top_k_terms_pct:[3,3,1,""],top_k_trigrams_pct:[3,3,1,""]},adjacency_features:{create_poi_index:[1,1,1,""],get_classes_in_neighbors_bln:[1,1,1,""],get_classes_in_neighbors_cnt:[1,1,1,""],get_classes_in_radius_bln:[1,1,1,""],get_classes_in_radius_cnt:[1,1,1,""],get_classes_in_street_and_radius_bln:[1,1,1,""],get_classes_in_street_and_radius_cnt:[1,1,1,""]},clf_utilities:{create_clf_params_product_generator:[2,1,1,""],create_feature_sets_generator:[2,1,1,""],evaluate:[2,1,1,""],get_top_k_predictions:[2,1,1,""],inverse_transform_labels:[2,1,1,""],is_valid:[2,1,1,""],k_accuracy_score:[2,1,1,""],normalize_scores:[2,1,1,""],train_classifier:[2,1,1,""]},config:{config:[3,2,1,""]},features_utilities:{create_args_dict:[4,1,1,""],create_concatenated_features:[4,1,1,""],create_finetuned_features:[4,1,1,""],create_single_feature:[4,1,1,""],create_single_features:[4,1,1,""],create_test_args_dict:[4,1,1,""],create_test_features:[4,1,1,""],encode_labels:[4,1,1,""],get_bbox_coords:[4,1,1,""],get_pois_by_street:[4,1,1,""],get_required_external_files:[4,1,1,""],get_top_k:[4,1,1,""],load_poi_gdf:[4,1,1,""],load_street_gdf:[4,1,1,""],ngrams:[4,1,1,""],normalize_features:[4,1,1,""]},osm_utilities:{download_osm_streets:[6,1,1,""],parse_osm_streets:[6,1,1,""],query_osm_data:[6,1,1,""]},textual_features:{create_textual_index:[7,1,1,""],get_similarity_per_class:[7,1,1,""],get_top_k_fourgrams:[7,1,1,""],get_top_k_terms:[7,1,1,""],get_top_k_trigrams:[7,1,1,""]},writers:{write_classifier_space:[8,1,1,""],write_evaluation_results:[8,1,1,""],write_evaluation_space:[8,1,1,""],write_feature_params_info:[8,1,1,""],write_feature_space:[8,1,1,""],write_finetuning_results:[8,1,1,""],write_predictions:[8,1,1,""]}},objnames:{"0":["py","module","Python module"],"1":["py","function","Python function"],"2":["py","class","Python class"],"3":["py","attribute","Python attribute"]},objtypes:{"0":"py:module","1":"py:function","2":"py:class","3":"py:attribute"},terms:{"boolean":4,"class":3,"final":[1,4],"float":[1,2,4,7],"function":[0,5],"int":[1,3,4,7],"return":[1,2,4,6,7,8],"true":[1,2,7],For:[1,2,7],Has:[1,4],The:[0,1,2,3,4,5,6,7],Then:[4,7],These:1,about:[0,5],account:[0,1,5],accur:[0,5],accuraci:[2,3],adjac:[3,5],adjacency_featur:1,algorithm:[0,5],algorithm_select:[0,5,8],all:[0,1,2,4,5,6,8],along:[0,1,5],among:[1,4,7],annot:[0,5],api:[4,6],appear:[2,7],area:4,arg:4,argument:4,arrai:[1,2,4,7],assess:[0,5],automat:[0,5],avail:[0,5],back:2,base:[0,4,5],bay:3,bbox_coord:6,befor:[0,5],belong:[1,4],best:[0,4,5],best_feature_param:4,best_param:8,bool:2,both:[0,5],bound:[4,6],box:[4,6],build:[0,5],can:[0,5],categori:[0,1,5,7],chang:[0,5],charact:4,check:[2,4],choos:3,chosen:8,classes_in_neighbors_bln:3,classes_in_neighbors_cnt:3,classes_in_neighbors_thr:3,classes_in_radius_bln:3,classes_in_radius_cnt:3,classes_in_radius_thr:3,classes_in_street_and_radius_bln:3,classes_in_street_and_radius_cnt:3,classes_in_street_and_radius_thr:3,classifi:[0,3,5,8],clf_name:[0,2,5,8],clf_util:2,code:[0,3,5],collect:[0,5],column:[1,3,4,7],combin:2,come:[0,5],concaten:4,confid:[0,5],config:[0,5],configur:[0,2,3,4,5,8],consid:[1,2,4,7],consider:3,consist:[0,5],contain:[0,1,2,3,4,5,6,7,8],content:5,convert:6,coord:[4,6],correspod:2,correspond:[2,4,8],creat:[0,1,2,4,5,7,8],create_args_dict:4,create_clf_params_product_gener:2,create_concatenated_featur:4,create_feature_sets_gener:2,create_finetuned_featur:4,create_poi_index:1,create_single_featur:4,create_test_args_dict:4,create_test_featur:4,create_textual_index:7,cross:[0,5],crs:3,csv:[3,6,8],data:[0,5],datafram:6,dataset:[0,5],decis:3,decisiontree_hyperparamet:3,defin:[1,2,3,4,8],deploy:[0,5],dict:[1,2,3,4,8],differ:3,directori:[0,5],disk:[0,5],download:[0,4,5,6],download_osm_street:6,dure:4,each:[0,1,2,4,5,7,8],east:[4,6],element:4,encapsul:[0,5],encod:[2,4],encode_label:4,epsg:3,etc:[0,5],evalu:[0,2,5],execut:[0,5],exp_path:[0,5,6],experi:[2,3],experiment_path:[0,5],experiments_path:3,extern:4,extract:[0,1,4,5],featur:[0,2,3,5,8],feature_sets_path:4,features_extract:[0,4,5],features_info:[4,8],features_path:4,features_util:4,file:[0,3,4,5,6,8],filter:1,find:[0,5],finetun:8,first:[0,5],firstli:7,fit:[0,5],fold:[0,3,5,8],fold_path:[2,4],folder:[0,3,5],follow:[0,5],forest:3,form:[0,5],format:[2,6],found:4,fourgram:[4,7],fpath:[6,8],from:[0,1,3,4,5,6],full:[0,5,8],further:[0,5],gener:[2,4],geodatafram:[1,4,7,8],geometri:[1,4,6],geometry_map:1,geopanda:[1,4,7,8],get_bbox_coord:4,get_classes_in_neighbors_bln:1,get_classes_in_neighbors_cnt:1,get_classes_in_radius_bln:1,get_classes_in_radius_cnt:1,get_classes_in_street_and_radius_bln:1,get_classes_in_street_and_radius_cnt:1,get_pois_by_street:4,get_required_external_fil:4,get_similarity_per_class:7,get_top_k:4,get_top_k_fourgram:7,get_top_k_predict:2,get_top_k_term:7,get_top_k_trigram:7,github:[0,5],given:[0,1,2,4,5,7,8],gram:4,grid:[0,2,5],group:[0,5],hand:[0,5],here:[1,7],how:7,hyperparamet:[0,2,5,8],id_col:3,identifi:1,ids:[1,4],implement:[0,5],includ:[3,4,8],included_adjacency_featur:3,included_classifi:3,included_textual_featur:3,index:[1,4,5,7],indic:4,initi:[0,4,5],insid:[1,6],instal:[0,5],instanti:4,instead:8,integ:[1,4],interest:[0,5],inverse_transform_label:2,is_valid:2,its:4,k_accuracy_scor:2,k_best:2,k_pred:[2,3,8],kei:[1,2,4,8],kept:1,knn_hyperparamet:3,knowledg:[0,5],label:[1,2,3,4,8],label_col:3,label_map:1,labelencod:[2,4],lat_col:3,later:[0,5],latest:[0,5],latitud:3,learn:[0,5],least:1,len:[1,7],length:4,librari:[0,5],like:[2,4],linux:[0,5],list:[0,1,2,3,4,5,7,8],load:[0,4,5],load_poi_gdf:4,load_street_gdf:4,logist:3,logisticregression_hyperparamet:3,lon_col:3,longitud:3,machin:[0,5],mai:4,main:[0,5],make:2,match:4,measur:[2,3],meter:1,metric:2,minmaxscal:4,mlp:3,mlp_hyperparamet:3,mode:4,model:[0,2,5],model_deploy:[0,4,5],model_select:[0,5,8],model_train:[0,4,5],model_training_path:4,modul:[0,5],most:[0,5],n_featur:[1,7],n_fold:3,n_sampl:[1,7],naiv:3,naivebayes_hyperparamet:3,name:[0,2,3,4,5,7,8],name_col:3,ndarrai:[1,2,4,7],nearest:[1,3,4],neighbor:[0,1,3,5],nest:[0,5],next:[0,5],ngram:4,nlabel:[1,7],none:[1,4,6,7,8],norm:4,normal:[2,3,4,8],normalizaton:8,normalize_featur:4,normalize_scor:2,normalized_featur:3,north:[4,6],now:2,number:[1,3,7],numpi:[0,1,2,4,5,7],object:2,one:1,onli:1,optim:[0,5],option:[4,8],order:[0,3,4,5],origin:2,osm:[1,3,4,5],osm_cr:3,osm_util:6,output:[0,5],over:2,overpass:[4,6],page:5,pair:[0,2,5,8],panda:[0,5,6],paramet:[1,2,3,4,6,7,8],parameter:[0,5],params_grid:2,params_nam:8,params_v:8,pars:6,parse_osm_street:6,pass:6,path:[0,1,2,3,4,5,6,7,8],per:8,percentag:[4,7],perform:[0,5],pip:[0,5],pip_requir:[0,5],pipelin:[0,5],poi:[0,1,2,3,4,5,7,8],poi_cr:3,poi_fpath:[0,3,4,5],poi_gdf:[1,4,7,8],poi_index_path:1,point:[0,5],pois_by_street:1,possibl:2,predict:[0,2,3,5,8],prepar:4,preprocess:[2,4],present:8,previou:[0,5],probabl:2,produc:[0,5],project:[0,4,5],properti:[0,5],python:[0,5],queri:[4,6],query_osm_data:6,radiu:1,random:3,randomforest_hyperparamet:3,read:[2,4,6],read_path1:4,read_path2:4,read_path:4,readi:[0,5],refer:[0,3,5,8],regard:[0,5],regress:3,relat:[0,5],repositori:[0,5],repres:[1,7],requir:[0,4,5],required_arg:4,respect:2,respons:6,result:[0,4,5,8],results_dict:8,results_path:[4,8],root:[0,5],row:[1,7],run:[0,5],same:[0,5],save:[0,1,4,5,6,7],scaler:4,scheme:[0,5],scikit:[0,5],score:[0,2,5,7,8],search:[0,1,2,3,4,5,8],select:[0,5],seri:[0,2,5],server:[0,5],set:[0,1,2,4,5,7,8],setup:2,shape:[1,7],should:[0,4,5,8],similar:7,sklearn:[2,4],sourc:[0,1,2,3,4,5,6,7,8],south:[4,6],space:[2,3,8],spatial:1,start:[0,5],step:[0,4,5,8],store:[1,3,4,7],str:[1,2,3,4,6,7,8],street:[1,4,6],street_fpath:4,street_gdf:[1,4],string:2,structur:4,success:2,suggest:[0,5],support:3,supported_adjacency_featur:3,supported_classifi:3,supported_textual_featur:3,svm:3,svm_hyperparamet:3,take:[0,1,3,5],target:4,term:[0,4,5,7],test:[0,2,4,5],test_idx:4,test_poi_gdf:4,textual:[3,5],textual_featur:7,textual_index_path:7,thei:4,them:[4,6,8],thi:[0,1,5],those:1,thr:1,three:8,through:2,toolkit:[0,5],top:[0,2,3,4,5,7,8],top_k:3,top_k_fourgram:3,top_k_fourgrams_pct:3,top_k_term:3,top_k_terms_pct:3,top_k_trigram:3,top_k_trigrams_pct:3,train:[0,1,2,3,4,5,7],train_classifi:2,train_idx:4,transform:2,tree:3,tri:[0,5],trigram:[4,7],tupl:[4,6],two:8,txt:[0,5],type:[1,2,3,4,6,7],unlabel:[0,5],unseen:[0,5],used:[2,3,8],uses:[0,3,5],using:[0,4,5],util:[0,5,8],valid:[0,2,5],valu:[1,2,4,8],version:[0,5],well:[4,6,8],west:[4,6],where:[0,2,5],whether:[2,4,8],which:[0,1,4,5,7,8],whole:[0,5],word:4,workflow:[0,5],write:[4,6,8],write_classifier_spac:8,write_evaluation_result:8,write_evaluation_spac:8,write_feature_params_info:8,write_feature_spac:8,write_finetuning_result:8,write_path:4,write_predict:8,writer:5,x_test:[0,2,4,5],x_train:[0,2,4,5],y_pred:2,y_test:[2,4],y_train:[2,4],yield:[2,4]},titles:["LGM-Classification","Adjacency features","Classifiers utilities","Config","Features utilities","Welcome to LGM-Classification\u2019s documentation!","OSM utilities","Textual features","Writers"],titleterms:{adjac:1,classif:[0,5],classifi:2,config:3,descript:[0,5],document:5,featur:[1,4,7],indic:5,lgm:[0,5],osm:6,procedur:[0,5],setup:[0,5],tabl:5,textual:7,usag:[0,5],util:[2,4,6],welcom:5,writer:8}})