Run metadata

BasicOutputRunMetaData dataclass

Class for defining variables for the run metadata.

Parameters:

Name	Type	Description	Default
tool	str	Name of the tool implementation	required
tool_version	str	Version of the tool implementation	required
config	Path	Path to the config file located in the input directory	required
run_timestamp	int	Time taken for run to complete	required
corpus	Path	Path to corpus used in pheval run	required
tool_specific_configuration_options	Any	Special field that can be overwritten by tool implementations to contain any extra tool specific configurations used in the run	None

Source code in src/pheval/run_metadata.py

@serde
@dataclass
class BasicOutputRunMetaData:
    """Class for defining variables for the run metadata.
    Args:
        tool (str): Name of the tool implementation
        tool_version (str): Version of the tool implementation
        config (Path): Path to the config file located in the input directory
        run_timestamp (int): Time taken for run to complete
        corpus (Path): Path to corpus used in pheval run
        tool_specific_configuration_options (Any): Special field that can be overwritten by tool implementations to
                                                   contain any extra tool specific configurations used in the run
    """

    tool: str
    tool_version: str
    config: Path
    run_timestamp: int
    corpus: Path
    tool_specific_configuration_options: Any = None