Skip to content

output

The base output class.

It implements the base output processing class, which will handle the model output saving and loading.

Attributes:

Name Type Description
name str, default = 'base_output'

Name of the output class object.

Methods:

Name Description
__init__

The initializatoutputn method of the base output class.
save

The output saving method of the output class. This method is declared to be a static method.
load

The output laoding method of the output class. This method is declared to be a static method.
Source code in tinybig/output/base_output.py 
 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
114
115
116
117
118
class output:
    """
    The base output class.

    It implements the base output processing class,
    which will handle the model output saving and loading.

    Attributes
    ----------
    name: str, default = 'base_output'
        Name of the output class object.

    Methods
    ----------
    __init__
        The initializatoutputn method of the base output class.

    save
        The output saving method of the output class.
        This method is declared to be a static method.

    load
        The output laoding method of the output class.
        This method is declared to be a static method.
    """
    def __init__(self, name='base_output', *args, **kwargs):
        """
        The base output class initializatoutputn method.

        It initializes the base output class object for handling the output saving and loading.

        Parameters
        ----------
        name: str, default = 'base_output'
            Name of the base output class object.
        """
        self.name = name

    @staticmethod
    def from_config(configs: dict):
        if configs is None:
            raise ValueError("configs cannot be None")
        assert 'output_class' in configs
        class_name = configs['output_class']
        parameters = configs['output_parameters'] if 'output_parameters' in configs else {}
        return config.get_obj_from_str(class_name)(**parameters)

    def to_config(self):
        class_name = self.__class__.__name__
        attributes = {attr: getattr(self, attr) for attr in self.__dict__}

        return {
            "output_class": class_name,
            "output_parameters": attributes
        }

    @staticmethod
    def save(result, cache_dir='./result', output_file='output', *args, **kwargs):
        """
        The output saving method.

        It saves the provided outputs to a binary file via pick.dump.

        Parameters
        ----------
        result
            The output results to be saved.
        cache_dir: str, default = './result'
            Directory to save the output result.
        output_file: str, default = 'output'
            Name of file to save the output result.

        Returns
        -------
        None
            This output result saving method doesn't have return values.
        """
        create_directory_if_not_exists(f"{cache_dir}/{output_file}")
        with open(f"{cache_dir}/{output_file}", 'wb') as f:
            pickle.dump(result, f)

    @staticmethod
    def load(cache_dir='./result', output_file='output', *args, **kwargs):
        """
        The output result loading method.

        It loads the output results from a binary file via the pick.load.

        Parameters
        ----------
        cache_dir: str, default = './result'
            Directory of the output result file.
        output_file: str, default = 'output'
            Name of file of the output result.

        Returns
        -------
        None
            The loaded output result.
        """
        with open("{}/{}".format(cache_dir, output_file), 'rb') as f:
            result = pickle.load(f)
        return result

__init__(name='base_output', *args, **kwargs)

The base output class initializatoutputn method.

It initializes the base output class object for handling the output saving and loading.

Parameters:

Name Type Description Default
name

Name of the base output class object.

 'base_output'
Source code in tinybig/output/base_output.py 
41
42
43
44
45
46
47
48
49
50
51
52
def __init__(self, name='base_output', *args, **kwargs):
    """
    The base output class initializatoutputn method.

    It initializes the base output class object for handling the output saving and loading.

    Parameters
    ----------
    name: str, default = 'base_output'
        Name of the base output class object.
    """
    self.name = name

load(cache_dir='./result', output_file='output', *args, **kwargs) staticmethod

The output result loading method.

It loads the output results from a binary file via the pick.load.

Parameters:

Name Type Description Default
cache_dir

Directory of the output result file.

 './result'
output_file

Name of file of the output result.

 'output'

Returns:

Type Description
None

The loaded output result.
Source code in tinybig/output/base_output.py 
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
@staticmethod
def load(cache_dir='./result', output_file='output', *args, **kwargs):
    """
    The output result loading method.

    It loads the output results from a binary file via the pick.load.

    Parameters
    ----------
    cache_dir: str, default = './result'
        Directory of the output result file.
    output_file: str, default = 'output'
        Name of file of the output result.

    Returns
    -------
    None
        The loaded output result.
    """
    with open("{}/{}".format(cache_dir, output_file), 'rb') as f:
        result = pickle.load(f)
    return result

save(result, cache_dir='./result', output_file='output', *args, **kwargs) staticmethod

The output saving method.

It saves the provided outputs to a binary file via pick.dump.

Parameters:

Name Type Description Default
result

The output results to be saved.

 required
cache_dir

Directory to save the output result.

 './result'
output_file

Name of file to save the output result.

 'output'

Returns:

Type Description
None

This output result saving method doesn't have return values.
Source code in tinybig/output/base_output.py 
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
@staticmethod
def save(result, cache_dir='./result', output_file='output', *args, **kwargs):
    """
    The output saving method.

    It saves the provided outputs to a binary file via pick.dump.

    Parameters
    ----------
    result
        The output results to be saved.
    cache_dir: str, default = './result'
        Directory to save the output result.
    output_file: str, default = 'output'
        Name of file to save the output result.

    Returns
    -------
    None
        This output result saving method doesn't have return values.
    """
    create_directory_if_not_exists(f"{cache_dir}/{output_file}")
    with open(f"{cache_dir}/{output_file}", 'wb') as f:
        pickle.dump(result, f)