parser_management.py

import argparse
import sys


def get_args():

    parser = argparse.ArgumentParser(description='algorithms for Multi-Objective Optimization')

    parser.add_argument('--single_point_methods', type=str, help='Single Point Method', nargs='+', choices=['MOIHT', 'MOSPD', 'MOHyb'])

    parser.add_argument('--refiner', type=str, help='Refiner to use with the Single Methods', choices=['Multi-Start', 'SFSD'])

    parser.add_argument('--prob_type', type=str, help='problems Type', choices=['QP'])

    parser.add_argument('--prob_path', help='problems path (folder or file); note that, for the QP-type problems, you must indicate one of the two involved problems: the one finishing with the string _a or the one finishing with _b', type=str)

    parser.add_argument('--seeds', help='Execution Seeds', nargs='+', type=int, default=[16007])

    parser.add_argument('--max_time', help='Maximum number of elapsed minutes per problem by both the single-point method and the refiner', default=None, type=float)

    parser.add_argument('--max_f_evals', help='Maximum number of function evaluations for both the single-point method and the refiner', default=None, type=int)

    parser.add_argument('--verbose', help='Verbose during the iterations', action='store_true', default=False)

    parser.add_argument('--verbose_interspace', help='Used interspace in the verbose (Requirements: verbose activated)', default=20, type=int)

    parser.add_argument('--plot_pareto_front', help='Plot Pareto front', action='store_true', default=False)

    parser.add_argument('--plot_pareto_solutions', help='Plot Pareto solutions (Requirements: plot_pareto_front activated; n in [2, 3])', action='store_true', default=False)

    parser.add_argument('--general_export', help='Export fronts (including plots), execution times and arguments files', action='store_true', default=False)

    parser.add_argument('--export_pareto_solutions', help='Export pareto solutions, including the plots if n in [2, 3] (Requirements: general_export activated)', action='store_true', default=False)

    parser.add_argument('--plot_dpi', help='DPI of the saved plots (Requirements: general_export activated)', default=100, type=int)

    ####################################################
    ### ONLY FOR Sparsity ###
    ####################################################

    parser.add_argument('--s', help='Sparsity parameter -- Upper Bound for the Solution Cardinality', type=int, nargs='+')

    parser.add_argument('--sparsity_tol', help='Sparsity parameter -- Tolerance on sparsity', type=float, default=1e-7)

    ####################################################
    ### ONLY FOR MOIHT ###
    ####################################################

    parser.add_argument('--MOIHT_L', help='MOIHT parameter -- L-stationarity parameter (if not indicated, it is calculated depending on the problem)', type=float, default=None)

    parser.add_argument('--MOIHT_L_inc_factor', help='MOIHT parameter -- L incremental factor', type=float, default=1.1)

    parser.add_argument('--MOIHT_theta_tol', help='MOIHT parameter -- Theta for Pareto stationarity', default=-1e-7, type=float)

    ####################################################
    ### ONLY FOR MOSPD ###
    ####################################################

    parser.add_argument('--MOSPD_xy_diff', help='MOSPD parameter -- Difference between current x and y', default=1e-3, type=float)

    parser.add_argument('--MOSPD_max_inner_iter_count', help='MOSPD parameter -- Maximum number of iterations in the inner loop', default=20, type=int)

    parser.add_argument('--MOSPD_max_MOSD_iters', help='MOSPD parameter -- Maximum number of MOSD iterations', default=10, type=int)

    parser.add_argument('--MOSPD_tau_0', help='MOSPD parameter -- Initial value for tau', default=1, type=float)

    parser.add_argument('--MOSPD_max_tau_0_inc_factor', help='MOSPD parameter -- Maximum Increment factor for initial value of tau', default=1e5, type=float)

    parser.add_argument('--MOSPD_tau_inc_factor', help='MOSPD parameter -- Increment factor for tau', default=1.5, type=float)

    parser.add_argument('--MOSPD_epsilon_0', help='MOSPD parameter -- Initial value for epsilon', default=-1e-2, type=float)

    parser.add_argument('--MOSPD_min_epsilon_0_dec_factor', help='MOSPD parameter -- Minimum Decrement factor for initial value of epsilon', default=1e-2, type=float)

    parser.add_argument('--MOSPD_epsilon_dec_factor', help='MOSPD parameter -- Decrement factor for epsilon', default=0.9, type=float)

    ####################################################
    ### ONLY FOR MOSD/IFSD ###
    ####################################################

    parser.add_argument('--MOSD_IFSD_theta_tol', help='MOSD/IFSD parameter -- Theta for Pareto stationarity', default=-1e-7, type=float)
    
    parser.add_argument('--IFSD_qth_quantile', help='IFSD parameter -- q-th quantile', default=0.95, type=float)

    ####################################################
    ### ONLY FOR Gurobi ###
    ####################################################

    parser.add_argument('--gurobi_method', help='Gurobi parameter -- Used method', default=1, type=int)

    parser.add_argument('--gurobi_verbose', help='Gurobi parameter -- Verbose during the Gurobi iterations', action='store_true', default=False)

    parser.add_argument('--gurobi_feasibility_tol', help='Gurobi parameter -- Feasibility tolerance', default=1e-7, type=float)

    ####################################################
    ### ONLY FOR ArmijoTypeLineSearch ###
    ####################################################

    parser.add_argument('--ALS_alpha_0', help='ALS parameter -- Initial step size', default=1, type=float)

    parser.add_argument('--ALS_delta', help='ALS parameter -- Coefficient for step size contraction', default=0.5, type=float)

    parser.add_argument('--ALS_beta', help='ALS parameter -- Beta', default=1.0e-4, type=float)

    parser.add_argument('--ALS_min_alpha', help='ALS parameter -- Min alpha', default=1.0e-14, type=float)

    return parser.parse_args(sys.argv[1:])