nxbench package

Subpackages

• nxbench.data package
  • Subpackages
    • nxbench.data.scripts package
      • Submodules
      • nxbench.data.scripts.scrape_nr module
      • Module contents
  • Submodules
  • nxbench.data.constants module
  • nxbench.data.db module
    • BenchmarkDB
      • BenchmarkDB.__init__()
      • BenchmarkDB.delete_results()
      • BenchmarkDB.get_results()
      • BenchmarkDB.get_unique_values()
      • BenchmarkDB.save_results()
      • BenchmarkDB.truncate()
  • nxbench.data.loader module
    • BenchmarkDataManager
      • BenchmarkDataManager.SUPPORTED_FORMATS
      • BenchmarkDataManager.__init__()
      • BenchmarkDataManager.get_metadata()
      • BenchmarkDataManager.load_network()
      • BenchmarkDataManager.load_network_sync()
  • nxbench.data.repository module
    • NetworkMetadata
      • NetworkMetadata.__init__()
      • NetworkMetadata.category
      • NetworkMetadata.citations
      • NetworkMetadata.collection
      • NetworkMetadata.description
      • NetworkMetadata.directed
      • NetworkMetadata.download_url
      • NetworkMetadata.edge_type
      • NetworkMetadata.name
      • NetworkMetadata.network_statistics
      • NetworkMetadata.source
      • NetworkMetadata.tags
      • NetworkMetadata.vertex_type
      • NetworkMetadata.weighted
    • NetworkRepository
      • NetworkRepository.__init__()
      • NetworkRepository.discover_networks_by_category()
      • NetworkRepository.extract_download_url()
      • NetworkRepository.fetch_with_retry()
      • NetworkRepository.get_category_for_network()
      • NetworkRepository.get_network_metadata()
      • NetworkRepository.list_networks()
      • NetworkRepository.verify_url()
    • NetworkStats
      • NetworkStats.__init__()
      • NetworkStats.assortativity
      • NetworkStats.avg_clustering
      • NetworkStats.avg_degree
      • NetworkStats.avg_triangles
      • NetworkStats.density
      • NetworkStats.max_clique_lb
      • NetworkStats.max_degree
      • NetworkStats.max_kcore
      • NetworkStats.max_triangles
      • NetworkStats.min_degree
      • NetworkStats.n_edges
      • NetworkStats.n_nodes
      • NetworkStats.n_triangles
      • NetworkStats.transitivity
  • nxbench.data.synthesize module
    • generate_graph()
  • nxbench.data.utils module
    • detect_delimiter()
    • fix_matrix_market_file()
    • get_connected_components()
    • lcc()
    • normalize_name()
    • safe_extract()
  • Module contents
• nxbench.validation package
  • Submodules
  • nxbench.validation.base module
    • ValidationError
    • validate_communities()
    • validate_edge_scores()
    • validate_flow()
    • validate_graph_result()
    • validate_node_scores()
    • validate_path_lengths()
    • validate_scalar_result()
    • validate_similarity_scores()
  • nxbench.validation.registry module
    • BenchmarkValidator
      • BenchmarkValidator.__init__()
      • BenchmarkValidator.create_validator()
      • BenchmarkValidator.validate_result()
    • ValidationConfig
      • ValidationConfig.__init__()
      • ValidationConfig.expected_type
      • ValidationConfig.extra_checks
      • ValidationConfig.params
      • ValidationConfig.required
      • ValidationConfig.validator
    • ValidationRegistry
      • ValidationRegistry.DEFAULT_VALIDATORS
      • ValidationRegistry.__init__()
      • ValidationRegistry.get_validator()
      • ValidationRegistry.load_config()
      • ValidationRegistry.register_validator()
  • Module contents
• nxbench.viz package
  • Submodules
  • nxbench.viz.app module
    • make_parallel_categories_figure()
    • make_violin_figure()
    • run_server()
  • nxbench.viz.utils module
    • aggregate_data()
    • load_and_prepare_data()
    • load_data()
    • preprocess_data()
  • Module contents

Submodules

nxbench.cli module

nxbench.cli.main()

nxbench.log module

class nxbench.log.LoggerConfig(name, level='INFO', handlers=<factory>)

Bases: object

Configuration for a single logger.

Parameters:

• name (str)

• level (str)

• handlers (list[LoggingHandlerConfig])

__init__(name, level='INFO', handlers=<factory>)

Parameters:

• name (str)

• level (str)

• handlers (list[LoggingHandlerConfig])

Return type:

None

handlers: list[LoggingHandlerConfig]

level: str = 'INFO'

name: str

class nxbench.log.LoggingConfig(loggers=<factory>)

Bases: object

Configuration for all loggers.

Parameters:

loggers (list[LoggerConfig])

__init__(loggers=<factory>)

Parameters:

loggers (list[LoggerConfig])

Return type:

None

loggers: list[LoggerConfig]

class nxbench.log.LoggingHandlerConfig(handler_type, level='INFO', formatter='%(asctime)s - %(name)s - %(levelname)s - %(message)s', log_file=None, rotate_logs=True, backup_count=7, when='midnight')

Bases: object

Configuration for a single logging handler.

Parameters:

• handler_type (str)

• level (str)

• formatter (str)

• log_file (str | None)

• rotate_logs (bool)

• backup_count (int)

• when (str)

__init__(handler_type, level='INFO', formatter='%(asctime)s - %(name)s - %(levelname)s - %(message)s', log_file=None, rotate_logs=True, backup_count=7, when='midnight')

Parameters:

• handler_type (str)

• level (str)

• formatter (str)

• log_file (str | None)

• rotate_logs (bool)

• backup_count (int)

• when (str)

Return type:

None

backup_count: int = 7

formatter: str = '%(asctime)s - %(name)s - %(levelname)s - %(message)s'

handler_type: str

level: str = 'INFO'

log_file: str | None = None

rotate_logs: bool = True

when: str = 'midnight'

class nxbench.log.NxBenchConfig(active=False, verbosity_level=0, backend_name='nxbench', backend_params=<factory>, logging_config=<factory>)

Bases: Config

Configuration for NetworkX that controls behaviors such as how to use backends and logging.

Parameters:

• active (bool)

• verbosity_level (int)

• backend_name (str)

• backend_params (dict)

• logging_config (LoggingConfig)

__init__(active=False, verbosity_level=0, backend_name='nxbench', backend_params=<factory>, logging_config=<factory>)

Parameters:

• active (bool)

• verbosity_level (int)

• backend_name (str)

• backend_params (dict)

• logging_config (LoggingConfig)

Return type:

None

__post_init__()

Set environment variables based on initialized fields.

active: bool = False

backend_name: str = 'nxbench'

backend_params: dict

logging_config: LoggingConfig

notify_observers(name, value)

Notify all registered observers about a configuration change.

Parameters:

• name (str) – The name of the configuration parameter that changed.

• value (Any) – The new value of the configuration parameter.

Return type:

None

register_observer(callback)

Register an observer callback to be notified on configuration changes.

Parameters:

callback (Callable[[str, any], None]) – A function that accepts two arguments: the name of the configuration parameter that changed and its new value.

Return type:

None

set_verbosity_level(level)

Set the verbosity level (0-2). 2=DEBUG, 1=INFO, 0=NO logging.

Return type:

None

Parameters:

level (int)

verbosity_level: int = 0

nxbench.log.create_handler(handler_cfg)

Create a logging handler based on the handler configuration.

Return type:

Handler | None

Parameters:

handler_cfg (LoggingHandlerConfig)

nxbench.log.disable_logger(logger_name)

Disables the logger by removing all handlers.

Return type:

None

Parameters:

logger_name (str)

nxbench.log.get_default_logger()

Return a default logger instance for simple logging.

Return type:

Logger

nxbench.log.on_config_change(name, value)

Handle configuration changes.

Parameters:

• name (str) – The name of the configuration parameter that changed.

• value (any) – The new value of the configuration parameter.

Return type:

None

nxbench.log.setup_logger(logger_cfg)

Set up a single logger based on LoggerConfig.

Return type:

None

Parameters:

logger_cfg (LoggerConfig)

nxbench.log.setup_logger_from_config(logging_config)

Set up all loggers based on the provided LoggingConfig.

Return type:

None

Parameters:

logging_config (LoggingConfig)

nxbench.log.update_logger(name, action, value=None)

Update a specific logger based on action.

Return type:

None

Parameters:

• name (str)

• action (str)

• value (Any | None)