streamsight.utils

Utility

The utility module provides a set of utility functions that are used in the Streamsight library. These function are general functions that are not class specific and also contains functions that are used in the top level such as preparing the logger and creating the configuration file.

`create_config_yaml`(config_filename)	Create a configuration file for the logger.
`safe_dir`(path)	Check if directory is safe
`add_columns_to_csr_matrix`(matrix[, n])	Add a column of zeros to a csr_matrix.
`add_rows_to_csr_matrix`(matrix[, n])	Add a row of zeros to a csr_matrix.
`arg_to_str`(arg)	Converts a type to its name or returns the string.
`df_to_sparse`(df, item_ix, user_ix[, ...])
`prepare_logger`(log_config_filename)	Prepare the logger.
`to_binary`(X)	Converts a matrix to binary by setting all non-zero values to 1.
`to_tuple`(el)	Whether single element or tuple, always returns as tuple.
`ProgressBar`()	Progress bar as visual.

Logging

The logging module provides functions to control the logging level and suppression of warnings.

Example

import streamsight

# Set log level to INFO and suppress warnings
streamsight.log_level_by_name("INFO")
streamsight.suppress_warnings(suppress=True)

# Log some information
logger = logging.getLogger("streamsight")
logger.info("This is an informational message.")

# Emit a warning (this will be suppressed)
warnings.warn("This warning will not appear.")

`log_level`(level)	Change the logging level for root logger.
`log_level_by_name`(level_name)	Change the logging level using level names like 'DEBUG', 'INFO', etc.
`suppress_warnings`([suppress])	Enable or disable the suppression of warnings.
`suppress_specific_warnings`(category)	Suppress specific warnings by category.