CadetCareerProblem – Results Visualizations Methods

display_all_results_graphs(p_dict={}, printing=None)

Saves all charts for the current solution and for the solutions in the solution names list if specified

Source code in afccp/main.py

def display_all_results_graphs(self, p_dict={}, printing=None):
    """
    Saves all charts for the current solution and for the solutions in the solution names list if specified
    """

    if printing is None:
        printing = self.printing

    # Create solution folder if necessary
    self._manage_solution_folder()

    # Determine what kind of results charts we're creating
    if 'solution_names' not in p_dict:  # Regular Solution Charts
        desired_charts = 'desired_charts'
        if printing:
            print("Saving all solution results charts to the corresponding folder...")

    else:  # Solution Comparison Charts
        desired_charts = 'desired_comparison_charts'
        p_dict['results_graph'] = 'Solution Comparison'
        if printing:
            print("Saving all solution comparison charts to the corresponding folder...")

        # Evaluate the solutions to get metrics
        self._evaluate_all_solutions(p_dict['solution_names'])

    # Loop through the subset of AFSC charts that I actually care about
    charts = []
    for obj, version in self.mdl_p[desired_charts]:
        if printing:
            print("<Objective '" + obj + "' version '" + version + "'>")

        # Build the figure
        if obj in self.value_parameters['objectives'] or obj == 'Extra':
            p_dict["objective"] = obj
            p_dict["version"] = version
            p_dict['macro_chart_kind'] = 'AFSC Chart'
            charts.append(self.display_results_graph(p_dict))
        else:
            if printing:
                print("Objective '" + obj + "' passed since it isn't in our set of objectives.")

    # Loop through the subset of "other charts" that I care about
    if self.mdl_p['results_graph'] != "Solution Comparison":  # Only for a solution-specific chart
        for kind, version in self.mdl_p['desired_other_charts']:
            if printing:
                print("<Other Charts '" + kind + "' version '" + version + "'>")

            # Build the figure
            p_dict['objective'] = "Extra"
            p_dict["version"] = version
            p_dict['macro_chart_kind'] = 'Accessions Group'
            charts.append(self.display_results_graph(p_dict))


    return charts

display_cadet_individual_utility_graph(p_dict={}, printing=None)

Builds the cadet utility graph for a particular cadet

Source code in afccp/main.py

def display_cadet_individual_utility_graph(self, p_dict={}, printing=None):
    """
    Builds the cadet utility graph for a particular cadet
    """

    # Print statement
    if printing is None:
        printing = self.printing

    # Adjust instance plot parameters
    self._reset_functional_parameters(p_dict)

    # Build the chart
    afccp.visualizations.charts.CadetUtilityGraph(self)

display_results_graph(p_dict={}, printing=None)

Builds the AFSC Results graphs

Source code in afccp/main.py

def display_results_graph(self, p_dict={}, printing=None):
    """
    Builds the AFSC Results graphs
    """

    # Print statement
    if printing is None:
        printing = self.printing

    # Adjust instance plot parameters
    self._reset_functional_parameters(p_dict)
    self.mdl_p = afccp.data.support.determine_afsc_plot_details(self, results_chart=True)

    # Error handling
    if self.mdl_p['results_graph'] == 'Solution Comparison':
        self._error_checking('Solutions')
        chart_type = 'Comparison'
    else:
        self._error_checking('Solution')
        chart_type = 'Solution'

    # Determine which chart to create
    if self.mdl_p["macro_chart_kind"] == "AFSC Chart":

        # Initialize the AFSC Chart object
        afsc_chart = afccp.visualizations.charts.AFSCsChart(self)

        # Construct the specific chart
        return afsc_chart.build(chart_type=chart_type, printing=printing)

    elif self.mdl_p["macro_chart_kind"] == "Accessions Group":

        # Initialize the AFSC Chart object
        acc_chart = afccp.visualizations.charts.AccessionsGroupChart(self)

        # Construct the specific chart
        return acc_chart.build(chart_type=chart_type, printing=printing)

generate_results_slides(p_dict={}, printing=None)

Method to generate the results slides for a particular problem instance with solution

Source code in afccp/main.py

def generate_results_slides(self, p_dict={}, printing=None):
    """
    Method to generate the results slides for a particular problem instance with solution
    """

    if printing is None:
        printing = self.printing

    if printing:
        print("Generating results slides...")

    # Adjust instance plot parameters
    self._reset_functional_parameters(p_dict)
    self._error_checking('Solution')

    # Call the function to generate the slides
    if afccp.globals.use_pptx:
        afccp.visualizations.slides.generate_results_slides(self)
    else:
        print('PPTX library not installed.')

    if printing:
        print('Done.')

generate_comparison_slides(p_dict={}, printing=None)

Method to generate the results slides for a particular problem instance with solution

Source code in afccp/main.py

def generate_comparison_slides(self, p_dict={}, printing=None):
    """
    Method to generate the results slides for a particular problem instance with solution
    """

    if printing is None:
        printing = self.printing

    if printing:
        print("Generating comparison slides...")

    if 'Comparison Charts' not in os.listdir(self.export_paths['Analysis & Results']):
        raise ValueError("Error. No 'Comparison Charts' folder found in the 'Analysis & Results' folder. You need to"
                         " put all charts you'd like to compile into a slide-deck in this folder.")

    # Adjust instance plot parameters
    self._reset_functional_parameters(p_dict)
    self._error_checking('Solutions')

    # Call the function to generate the slides
    if afccp.globals.use_pptx:
        afccp.visualizations.slides.generate_comparison_slides(self)
    else:
        print('PPTX library not installed.')

    if printing:
        print('Done.')

generate_animation_slides(p_dict={}, printing=None)

Method to generate the animation slides for a particular problem instance and solution iterations

Source code in afccp/main.py

def generate_animation_slides(self, p_dict={}, printing=None):
    """
    Method to generate the animation slides for a particular problem instance and solution iterations
    """

    if printing is None:
        printing = self.printing

    if printing:
        print("Generating animation slides...")

    # Manage the solution iterations
    self._manage_bubbles_parameters(p_dict)

    # Call the function to generate the slides
    if afccp.globals.use_pptx:
        # afccp.visualizations.slides.create_animation_slides(self)
        afccp.visualizations.slides.create_animated_presentation(self, num_intro_slides=5)
    else:
        print('PPTX library not installed.')

    if printing:
        print('Done.')

generate_comparison_slide_components(p_dict={}, printing=None)

Method to do all the steps of generating the specific solution comparison charts I want

Source code in afccp/main.py

def generate_comparison_slide_components(self, p_dict={}, printing=None):
    """
    Method to do all the steps of generating the specific solution comparison charts I want
    """

    if printing is None:
        printing = self.printing

    if "solution_names" not in p_dict:
        raise ValueError("Error. In order to run this comparison method, the argument 'solution_names' must be "
                         "passed within 'p_dict'. This needs to be a list of solution names.")

    if printing:
        print("Generating comparison charts for the solutions:", p_dict['solution_names'])

    # Create the comparison charts folder if necessary
    if 'Comparison Charts' not in os.listdir(self.export_paths['Analysis & Results']):
        os.mkdir(self.export_paths['Analysis & Results'] + 'Comparison Charts')

    # Adjust instance plot parameters
    self._reset_functional_parameters(p_dict)
    self._error_checking('Solutions')

    # Save all solution comparison charts to the "Comparison Charts" folder
    self.display_all_results_graphs(p_dict, printing)

    # Cadet Utility Histogram
    self.display_utility_histogram(p_dict, folder='Comparison Charts')

    # Create pareto frontier plots
    self.show_pareto_chart(folder='Comparison Charts')  # without solutions
    self.show_pareto_chart(p_dict, folder='Comparison Charts',
                           solution_names=p_dict['solution_names'])  # with solutions

    # Compute similarity matrix and then calculate the similarity plot between all the solutions
    self.compute_similarity_matrix(solution_names=p_dict['solution_names'])
    self.similarity_plot(p_dict, folder='Comparison Charts')

    if printing:
        print('Done.')

display_utility_histogram(p_dict={}, printing=None, folder='Results Charts')

This method plots the cadet utility histogram

Source code in afccp/main.py

def display_utility_histogram(self, p_dict={}, printing=None, folder="Results Charts"):
    """
    This method plots the cadet utility histogram
    """

    # Print statement
    if printing is None:
        printing = self.printing
    if printing:
        print("Creating cadet utility histogram...")

    # Adjust instance plot parameters
    self._reset_functional_parameters(p_dict)
    self.mdl_p = afccp.data.support.determine_afsc_plot_details(self, results_chart=True)

    # Evaluate the solutions to get metrics
    if self.mdl_p['solution_names'] is not None:
        self._evaluate_all_solutions(self.mdl_p['solution_names'])

    # Filepath for plot
    filepath = self.export_paths['Analysis & Results'] + folder + "/"

    # Construct the chart
    return afccp.visualizations.charts.cadet_utility_histogram(self, filepath=filepath)

generate_bubbles_chart(p_dict={}, printing=None)

Method to generate the "BubbleChart" figure by calling the BubbleChart class and applying the parameters as specified in the ccp helping functions.

Source code in afccp/main.py

def generate_bubbles_chart(self, p_dict={}, printing=None):
    """
    Method to generate the "BubbleChart" figure by calling the BubbleChart class and applying the parameters
    as specified in the ccp helping functions.
    """

    if printing is None:
        printing = self.printing

    # Manage the solution iterations
    self._manage_bubbles_parameters(p_dict)

    # Print updates
    if printing:
        print('Creating Bubbles Chart...')

    # Call the figure object
    bubble_chart = afccp.visualizations.bubbles.BubbleChart(self, printing=printing)
    bubble_chart.main()

    # Only build the animation slides if we're saving iteration frames
    if self.mdl_p['save_iteration_frames']:

        # Generate the slides to go with this
        self.generate_animation_slides(p_dict, printing)