Skip to content

Documentation

Jump to bottom
Gus-prog edited this page Mar 30, 2022 · 6 revisions

pyUDLF is structured as follows:

pyUDLF
└──── run_calls
│    │   bin_path
│    │   config_path
│    │   setBinaryPath
│    │   setConfigPath
│    │   getBinaryPath
│    │   getConfigPath
│    │   download_url
│    │   verify_bin
│    │   run_platform
│    │   verify_running
│    │   runWithConfig
│    └─  run
│    
└──── utils
     └─  configGenerator (cria arquivos config)
     │   │    initParameters
     │   │    write_input_files
     │   │    setParameter
     │   │    getParameter
     │   │    new_parameters
     │   │    writeConfig
     │   │    listParameters
     │   │    list_config_full
     │   │    list_config
     │   │    list_parameter_info
     │   │    set_input
     │   │    set_all_ranked_lists_size
     │   │    get_input_files_parameters
     │   │    new_fusion_parameter
     │   └─   list_info_selected_method  
     │
     └─  inputType (classe de entrada)
     │   │    init_parameters
     │   │    init_data
     │   │    set_method_name 
     │   │    set_output_file_format  
     │   │    set_output_matrix_type 
     │   │    set_output_rk_format   
     │   │    set_output_file_path  
     │   │    set_input_matrix_type 
     │   │    set_matrix_to_rk_sorting 
     │   │    set_input_images_path 
     │   │    set_input_rk_format
     │   │    set_input_files 
     │   │    set_ranked_lists_size X
     │   │    set_dataset_size 
     │   │    set_lists_file 
     │   │    set_classes_file 
     │   │    set_output_log_file 
     │   │    set_param   
     │   │    get_param   
     │   │    get_method_name 
     │   │    get_classes_file 
     │   │    get_lists_file 
     │   │    get_dataset_size 
     │   │    get_output_log_file 
     │   │    get_output_file_format 
     │   │    get_output_matrix_type 
     │   │    get_output_rk_format 
     │   │    get_output_file_path 
     │   │    get_input_matrix_type 
     │   │    get_input_rk_format 
     │   │    get_matrix_to_rk_sorting 
     │   │    get_input_images_path 
     │   │    get_input_files 
     │   │    add_new_parameter
     │   │    add_input_files
     │   │    write_config
     │   │    list_parameters_names
     │   │    list_param_full
     │   │    list_param
     │   │    list_param_info
     │   └─   list_method_info
     │
     └─  outputType (classe de saida)
     │   │    get_matrix
     │   │    get_rks
     │   │    get_log
     │   └─   print_log
     │
     └─  readData (leitura de rks, matrizes, config e resultado(log))
     │   │    read_config
     │   │    read_log
     │   │    read_ranked_lists_file_numeric
     │   │    read_ranked_lists_file_string
     │   └─   read_matrix_file
     │
     └─  writeData (escrita de rks ou matrizes)
         └─   write_data

Lower level functioning of PyUDLF:

detalhesulti

In the following topics you can find more detailed documentation of each one:

  • run_calls: Group of execution-oriented functions such as setting and retrieving binary paths and calling the original binary.

  • inputType: Input data class, aimed at config configuration, such as setting and retrieving parameter values.

  • outputType: Output data class, aimed at getting results, as well as getting the log and ranked list or output matrix.

  • configGenerator: Group of functions aimed at config configuration, used by the inputType class. User does not use.

  • readData: Group of functions aimed at reading files.

  • writeData: A group of functions aimed at writing files.

Clone this wiki locally