PySODEvalToolkit/utils/print_formatter.py at master · lartpang/PySODEvalToolkit · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
# -*- coding: utf-8 -*-

from tabulate import tabulate


def print_formatter(
    results: dict, method_name_length=10, metric_name_length=5, metric_value_length=5
):
    dataset_regions = []
    for dataset_name, dataset_metrics in results.items():
        dataset_head_row = f" Dataset: {dataset_name} "
        dataset_region = [dataset_head_row]
        for method_name, metric_info in dataset_metrics.items():
            showed_method_name = clip_string(
                method_name, max_length=method_name_length, mode="left"
            )
            method_row_head = f"{showed_method_name} "
            method_row_body = []
            for metric_name, metric_value in metric_info.items():
                showed_metric_name = clip_string(
                    metric_name, max_length=metric_name_length, mode="right"
                )
                showed_value_string = clip_string(
                    str(metric_value), max_length=metric_value_length, mode="left"
                )
                method_row_body.append(f"{showed_metric_name}: {showed_value_string}")
            method_row = method_row_head + ", ".join(method_row_body)
            dataset_region.append(method_row)
        dataset_region_string = "\n".join(dataset_region)
        dataset_regions.append(dataset_region_string)
    dividing_line = "\n" + "-" * len(dataset_region[-1]) + "\n"  # 直接使用最后一个数据集区域的最后一行数据的长度作为分割线的长度
    formatted_string = dividing_line.join(dataset_regions)
    return formatted_string


def clip_string(string: str, max_length: int, padding_char: str = " ", mode: str = "left"):
    assert isinstance(max_length, int), f"{max_length} must be `int` type"

    real_length = len(string)
    if real_length <= max_length:
        padding_length = max_length - real_length
        if mode == "left":
            clipped_string = string + f"{padding_char}" * padding_length
        elif mode == "center":
            left_padding_str = f"{padding_char}" * (padding_length // 2)
            right_padding_str = f"{padding_char}" * (padding_length - padding_length // 2)
            clipped_string = left_padding_str + string + right_padding_str
        elif mode == "right":
            clipped_string = f"{padding_char}" * padding_length + string
        else:
            raise NotImplementedError
    else:
        clipped_string = string[:max_length]

    return clipped_string


def formatter_for_tabulate(
    results: dict,
    method_names: tuple,
    dataset_names: tuple,
    dataset_titlefmt: str = "Dataset: {}",
    method_name_length=None,
    metric_value_length=None,
    tablefmt="github",
):
    """
    tabulate format:

    ::

        table = [["spam",42],["eggs",451],["bacon",0]]
        headers = ["item", "qty"]
        print(tabulate(table, headers, tablefmt="github"))

        | item   | qty   |
        |--------|-------|
        | spam   | 42    |
        | eggs   | 451   |
        | bacon  | 0     |

    本函数的作用：
        针对不同的数据集各自构造符合tabulate格式的列表并使用换行符间隔串联起来返回
    """
    all_tables = []
    for dataset_name in dataset_names:
        dataset_metrics = results[dataset_name]
        all_tables.append(dataset_titlefmt.format(dataset_name))

        table = []
        headers = ["methods"]
        for method_name in method_names:
            metric_info = dataset_metrics.get(method_name)
            if metric_info is None:
                continue

            if method_name_length:
                method_name = clip_string(method_name, max_length=method_name_length, mode="left")
            method_row = [method_name]

            for metric_name, metric_value in metric_info.items():
                if metric_value_length:
                    metric_value = clip_string(
                        str(metric_value), max_length=metric_value_length, mode="center"
                    )
                if metric_name not in headers:
                    headers.append(metric_name)
                method_row.append(metric_value)
            table.append(method_row)
        all_tables.append(tabulate(table, headers, tablefmt=tablefmt))

    formatted_string = "\n".join(all_tables)
    return formatted_string