mlrl.common.cython.info module

@author: Michael Rapp (michael.rapp.ml@gmail.com)

class mlrl.common.cython.info.CppBuildOption(option: str, description: str, value: str)

Bases: object

Represents a build option for configuring a C++ library at compile-time.

Attributes:

option: The name of the build option description: A human-legible description of the build option value: The value that has been set for the build option at compile-time

description: str

option: str

value: str

class mlrl.common.cython.info.CppHardwareResource(resource: str, info: str)

Bases: object

Provides information about a certain hardware resource used by a C++ library.

Attributes:

resource: A human-legible name of the hardware resource info: The information associated with the hardware resource

info: str

resource: str

class mlrl.common.cython.info.CppLibraryInfo

Bases: object

Provides information about a C++ library.

build_options

The build options for configuring the C++ library at compile-time.

hardware_resources

Information about the hardware resources that are used by the C++ library.

library_name

The name of the C++ library.

library_version

The version of the C++ library.

target_architecture

The architecture that is targeted by the C++ library.

mlrl.common.cython.info.get_cpp_library_info() → CppLibraryInfo

Returns information about the C++ library that is wrapped by this Cython package.

Returns:

A CppLibraryInfo that provides information about the C++ library

mlrl.common.cython.info.get_gpu_devices() → List[str]

Returns the names of all supported GPUs available on the machine.

Returns:

A list that contains the names of all supported GPUs

mlrl.common.cython.info.get_num_cpu_cores() → int

Returns the number of CPU cores available on the machine, regardless of whether multi-threading support is enabled or not.

Returns:

The number of CPU cores available on the machine

mlrl.common.cython.info.is_gpu_available() → bool

Returns whether any supported GPUs are available on the machine or not.

Returns:

True, if at least one supported GPU is available, False otherwise

mlrl.common.cython.info.is_gpu_support_enabled() → bool

Returns whether multi-threading support was enabled at compile-time or not.

Returns:

True, if the GPU support is enabled, False otherwise

mlrl.common.cython.info.is_multi_threading_support_enabled() → bool

Returns whether multi-threading support was enabled at compile-time or not.

Returns:

True, if the multi-threading support is enabled, False otherwise