lenskit.parallel.config#

Functions#

get_parallel_config()

Get the active parallel configuration, making sure parallelism is configured

init_threading([config])

Set up and configure LensKit parallelism. This only needs to be called if

ensure_parallel_init()

Make sure LensKit parallelism is configured, and configure with defaults if

is_free_threaded(*[, require_active])

Query whether this Python supports free-threading.

effective_cpu_count()

Return the effective CPU count using the best available data. Tries the following in order:

Module Contents#

lenskit.parallel.config.get_parallel_config()#

Get the active parallel configuration, making sure parallelism is configured first.

Return type:

lenskit.config.ParallelSettings

lenskit.parallel.config.init_threading(config=None)#

Set up and configure LensKit parallelism. This only needs to be called if you want to control when and how parallelism is set up; components using parallelism will call ensure_init(), which will call this function with its default arguments if it has not been called.

See also

Configuring Parallelism

Parameters:

config (lenskit.config.ParallelSettings | None)

lenskit.parallel.config.ensure_parallel_init()#

Make sure LensKit parallelism is configured, and configure with defaults if it is not.

Components using parallelism or intensive computations should call this function before they begin training.

lenskit.parallel.config.is_free_threaded(*, require_active=False)#

Query whether this Python supports free-threading.

Parameters:

require_active (bool) – Require that the GIL is actually disabled (i.e., no modules have re-enabled the GIL) in order to return True.

Returns:

Whether or not this Python supports free-threading.

Return type:

bool

lenskit.parallel.config.effective_cpu_count()#

Return the effective CPU count using the best available data. Tries the following in order:

  1. os.process_cpu_count()

  2. os.sched_getaffinity()

  3. os.cpu_count()

Return type:

int

Exported Aliases#

lenskit.parallel.config.init_accel_pool()#

Re-exported alias for lenskit._accel.init_accel_pool().

class lenskit.parallel.config.ParallelSettings#

Re-exported alias for lenskit.config.ParallelSettings.

lenskit.parallel.config.lenskit_config()#

Re-exported alias for lenskit.config.lenskit_config().

lenskit.parallel.config.get_logger()#

Re-exported alias for lenskit.logging.get_logger().