Skip to content

Utility Functions

omnirec.util.util.set_log_level(level: str)

Sets log level for OmniRec.

Parameters:

Name Type Description Default
level str

Log level to set. Valid options are CRITICAL, FATAL, ERROR,WARNING, INFO, DEBUG, NOTSET. Log level is case-insensitive.

 required

Raises:

Type Description
ValueError

If the provided log level is not valid.
Source code in src\omnirec\util\util.py 
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
def set_log_level(level: str):
    """Sets log level for OmniRec.

    Args:
        level (str): Log level to set. Valid options are CRITICAL, FATAL, ERROR,WARNING, INFO, DEBUG, NOTSET. Log level is case-insensitive.

    Raises:
        ValueError: If the provided log level is not valid.
    """
    level = level.upper()
    if level in logging._nameToLevel:
        _root_logger.setLevel(level)
        _root_logger.debug("LOG LEVEL IS SET TO DEBUG")
    else:
        raise ValueError(f"Unknown log level: {level}")

omnirec.util.util.set_random_state(random_state: int) -> None

Set the global random state for reproducibility.

Parameters:

Name Type Description Default
random_state int

The random state seed.

 required
Source code in src\omnirec\util\util.py 
83
84
85
86
87
88
89
90
def set_random_state(random_state: int) -> None:
    """Set the global random state for reproducibility.

    Args:
        random_state (int): The random state seed.
    """
    global _RANDOM_STATE
    _RANDOM_STATE = random_state

omnirec.util.util.get_random_state() -> int

Get the global random state for reproducibility.

Returns:

Name Type Description
int int

The current random state seed.
Source code in src\omnirec\util\util.py 
93
94
95
96
97
98
99
def get_random_state() -> int:
    """Get the global random state for reproducibility.

    Returns:
        int: The current random state seed.
    """
    return _RANDOM_STATE