Scenario Comparison

Estimated Time for Completion: 15 minutes; Difficulty Level: Advanced

Taipy offers a way to compare data nodes across scenarios by including a function directly in the configuration of the scenario.

Download the code

Comparing scenarios

Step 1: Declare data nodes on which the comparison functions are applied.

In this example, we want to apply a comparison to the 'output' Data Node. It is indicated in the comparators parameter of the configure_scenario.

scenario_cfg = Config.configure_scenario(id="multiply_scenario",
                                         name="my_scenario",
                                         tasks_configs=[first_task_cfg,
                                                        second_task_cfg],
                                         comparators={output_data_node_cfg.id: compare_function},)

Step 2: Implement the comparison function (compare_function()) used above.

data_node_results is the list of the Output Data Nodes from all scenarios passed in the comparator. We iterate through it to compare scenarios.

def compare_function(*data_node_results):
    compare_result = {}
    current_res_i = 0
    for current_res in data_node_results:
        compare_result[current_res_i] = {}
        next_res_i = 0
        for next_res in data_node_results:
            print(f"comparing result {current_res_i} with result {next_res_i}")
            compare_result[current_res_i][next_res_i] = next_res - current_res
            next_res_i += 1
        current_res_i += 1
    return compare_result

Now, the compare_scenarios can be used within Taipy.

tp.Core().run()

scenario_1 = tp.create_scenario(scenario_cfg)
scenario_2 = tp.create_scenario(scenario_cfg)

scenario_1.submit()
scenario_2.submit()

print(tp.compare_scenarios(scenario_1, scenario_2))

Results:

...
{'my_output': {'compare_function': {0: {0: 0, 1: -4}, 1: {0: 4, 1: 0}}}}

Entire code

from taipy.core.config import Config, Frequency
import taipy as tp


# Normal function used by Taipy
def double(nb):
    return nb * 2

def add(nb):
    return nb + 10


# Configuration of Data Nodes
input_cfg = Config.configure_data_node("my_input", default_data=21)
intermediate_cfg = Config.configure_data_node("intermediate")
output_cfg = Config.configure_data_node("my_output")

# Configuration of tasks
first_task_cfg = Config.configure_task("double",
                                    double,
                                    input_cfg,
                                    intermediate_cfg)

second_task_cfg = Config.configure_task("add",
                                    add,
                                    intermediate_cfg,
                                    output_cfg)



def compare_function(*data_node_results):
    # example of function
    compare_result = {}
    current_res_i = 0
    for current_res in data_node_results:
        compare_result[current_res_i] = {}
        next_res_i = 0
        for next_res in data_node_results:
            print(f"comparing result {current_res_i} with result {next_res_i}")
            compare_result[current_res_i][next_res_i] = next_res - current_res
            next_res_i += 1
        current_res_i += 1
    return compare_result


scenario_cfg = Config.configure_scenario(id="multiply_scenario",
                                         name="my_scenario",
                                         task_configs=[first_task_cfg, second_task_cfg],
                                         comparators={output_cfg.id: compare_function})


if __name__=="__main__":
    tp.Core().run()

    scenario_1 = tp.create_scenario(scenario_cfg)
    scenario_2 = tp.create_scenario(scenario_cfg)

    scenario_1.my_input.write(10)
    scenario_2.my_input.write(8)

    scenario_1.submit()
    scenario_2.submit()

    print(tp.compare_scenarios(scenario_1, scenario_2))