ENH: Use `threadpoolctl` in `show_runtime` (a new function) #21468

ganesh-k13 · 2022-05-06T14:55:52Z

ENH: Use `threadpoolctl`

Use threadpoolctl at ~~np.show_config~~ np.show_runtime
Refactor SIMD extensions display logic

Sample output

>>> np.show_runtime()
[{'simd_extensions': {'baseline': ['SSE', 'SSE2', 'SSE3'],
                      'found': ['SSSE3',
                                'SSE41',
                                'POPCNT',
                                'SSE42',
                                'AVX',
                                'F16C',
                                'FMA3',
                                'AVX2'],
                      'not_found': ['AVX512F',
                                    'AVX512CD',
                                    'AVX512_KNL',
                                    'AVX512_KNM',
                                    'AVX512_SKX',
                                    'AVX512_CLX',
                                    'AVX512_CNL',
                                    'AVX512_ICL']}},
 {'architecture': 'Zen',
  'filepath': '/usr/lib/x86_64-linux-gnu/openblas-pthread/libopenblasp-r0.3.20.so',
  'internal_api': 'openblas',
  'num_threads': 12,
  'prefix': 'libopenblas',
  'threading_layer': 'pthreads',
  'user_api': 'blas',
  'version': '0.3.20'}]

or

>>> np.show_runtime()
WARNING: `threadpoolctl` not found in system! Install it by `pip install threadpoolctl`. Once installed, try `np.show_runtime` again for more detailed build information
[{'simd_extensions': {'baseline': ['SSE', 'SSE2', 'SSE3'],
                      'found': ['SSSE3',
                                'SSE41',
                                'POPCNT',
                                'SSE42',
                                'AVX',
                                'F16C',
                                'FMA3',
                                'AVX2'],
                      'not_found': ['AVX512F',
                                    'AVX512CD',
                                    'AVX512_KNL',
                                    'AVX512_KNM',
                                    'AVX512_SKX',
                                    'AVX512_CLX',
                                    'AVX512_CNL',
                                    'AVX512_ICL']}}]

resolves: #21340
related: #20939

rgommers · 2022-05-15T07:09:26Z

Thanks for working on this @ganesh-k13!

Note that gh-14492 is also very much related. I think we'd like show_config to display both build-time and runtime info, and clearly state which is which (right now it's build-time only info, but it's a bit confusing).

charris · 2022-05-15T13:55:14Z

@rgommers Out of curiosity, can the build time information be obtained from meson?

ganesh-k13 · 2022-05-15T17:20:47Z

display both build-time and runtime info

Ah ok, thanks for the info @rgommers! Let me see how we can pull up that info today. As @charris suggested, maybe meson can help, but only if it's built using that?

rgommers · 2022-05-16T07:49:41Z

@rgommers Out of curiosity, can the build time information be obtained from meson?

There's always a way:) It has sane configure-time output, which may make sense to store in full:

meson setup build
The Meson build system
Version: 0.61.0
Source dir: /Users/rgommers/code/bldscipy
Build dir: /Users/rgommers/code/bldscipy/build
Build type: native build
Project name: SciPy
Project version: 1.9.0.dev0
C compiler for the host machine: arm64-apple-darwin20.0.0-clang (clang 11.1.0 "clang version 11.1.0")
C linker for the host machine: arm64-apple-darwin20.0.0-clang ld64 530
C++ compiler for the host machine: arm64-apple-darwin20.0.0-clang++ (clang 11.1.0 "clang version 11.1.0")
C++ linker for the host machine: arm64-apple-darwin20.0.0-clang++ ld64 530
Host machine cpu family: aarch64
Host machine cpu: arm64
Compiler for C supports arguments -Wno-unused-but-set-variable: NO
Library m found: YES
['/Users/rgommers/mambaforge/envs/scipy-dev/bin/arm64-apple-darwin20.0.0-gfortran', '-Wno-conversion', '-Wl,-pie', '-Wl,-headerpad_max_install_names', '-Wl,-dead_strip_dylibs', '-Wl,-rpath,/Users/rgommers/mambaforge/envs/scipy-dev/lib', '-L/Users/rgommers/mambaforge/envs/scipy-dev/lib', '/Users/rgommers/code/bldscipy/build/meson-private/sanitycheckf.f90', '-o', '/Users/rgommers/code/bldscipy/build/meson-private/sanitycheckf']
AHH
['/Users/rgommers/code/bldscipy/build/meson-private/sanitycheckf']
 Fortran compilation is working.
0
Fortran compiler for the host machine: /Users/rgommers/mambaforge/envs/scipy-dev/bin/arm64-apple-darwin20.0.0-gfortran (gcc 11.0.1 "GNU Fortran (GCC) 11.0.1 20210403 (experimental)")
Fortran linker for the host machine: /Users/rgommers/mambaforge/envs/scipy-dev/bin/arm64-apple-darwin20.0.0-gfortran ld64 530
Program cython found: YES (/Users/rgommers/mambaforge/envs/scipy-dev/bin/cython)
Program pythran found: YES (/Users/rgommers/mambaforge/envs/scipy-dev/bin/pythran)
Program cp found: YES (/bin/cp)
Program python3 found: YES (/Users/rgommers/mambaforge/envs/scipy-dev/bin/python3.9)
WARNING: Python files installed by Meson might not be found by python interpreter.
 This warning can be avoided by setting "python.platlibdir" option.
WARNING: Python files installed by Meson might not be found by python interpreter.
 This warning can be avoided by setting "python.purelibdir" option.
Found pkg-config: /Users/rgommers/mambaforge/envs/scipy-dev/bin/pkg-config (0.29.2)
Library npymath found: YES
Library npyrandom found: YES
Run-time dependency openblas found: YES 0.3.18
Dependency openblas found: YES 0.3.18 (cached)
Program _build_utils/cythoner.py found: YES (/Users/rgommers/mambaforge/envs/scipy-dev/bin/python3.9 /Users/rgommers/code/bldscipy/scipy/_build_utils/cythoner.py)
Checking for function "open_memstream" : YES
Configuring messagestream_config.h using configuration
Checking for size of "void*" : 8
Run-time dependency threads found: YES
Checking for size of "void*" : 8
Dependency threads found: YES unknown (cached)
Compiler for C supports arguments -Wno-unused-but-set-variable: NO (cached)
Dependency openblas found: YES 0.3.18 (cached)
Compiler for C++ supports arguments -mmacosx-version-min=10.9: YES
Compiler for C supports arguments -Wno-unused-but-set-variable: NO (cached)
Compiler for C++ supports arguments -Wno-format-truncation: NO

It contains Run-time dependency openblas found: YES 0.3.18, so yes that covers BLAS/LAPACK at build time, but some of the other things in there are equally useful for debugging user-reported issues.

mattip · 2022-05-19T17:11:41Z

I would be fine with fixing show_config one step at a time if it is complicated to do all the fixes in one go. Having the threadpoolctl runtime information would already help in many situations.

ganesh-k13 · 2022-05-30T13:42:40Z

Hey @mattip, I see two enhancements based on various discussions,

Show both runtime and build time info.
Figure out a fix for Windows.

Which do you think is apt for this PR, I can work on that.

mattip · 2022-05-30T14:42:41Z

numpy/distutils/misc_util.py

-                directories, include directories, etc.) in the system on which
-                NumPy was built.
+                Print information about various resources in the system
+                on which NumPy was built.


The information presented no longer is the build-time information.

Suggested change

on which NumPy was built.

including available intrinsic support and BLAS/LAPACK library

in use

Done via 77198c9

mattip · 2022-05-30T14:43:52Z

numpy/distutils/misc_util.py

+                'threading_layer': 'pthreads',
+                'user_api': 'blas',
+                'version': '0.3.20'}]
+


Where is the example of the SIMD information?

Didn't want to clutter the docstring, but yeah makes sense to add it as it'll always be displayed

Done via 77198c9

mattip · 2022-05-30T16:22:43Z

I think this change would be more appropriate as a new show_runtime() function. Then we can iterate on this in the future.

ganesh-k13 · 2022-05-30T17:03:09Z

Oh yeah that's a good point, we can make show_runtime() and later show_buildinfo() (or something like that) and then merge with show_config if it's received well. Will do 👍

mattip · 2022-07-25T10:12:54Z

I see you updated the PR description to show the new function output. It looks good to me.

This is failing since it adds a new function to the namespace. It should probably hit the mailing list in parallel with fixing the test to allow the addition. When you post, please add the output.

ganesh-k13 · 2022-08-07T03:58:31Z

Thanks Matti, fixing the tests now.

I've posted to the mailing list today: https://mail.python.org/archives/list/numpy-discussion@python.org/thread/A3Q2WXBRFK3MKHOSEX3RUVRJRKCFGWKX/

mattip · 2022-08-10T13:09:33Z

I don't think this needs to be part of the generated __config__.py file. Maybe a better home would be in numpy/lib/utils.py. The distutils module is due to be deprecated.

ganesh-k13 · 2022-08-18T13:52:08Z

Thanks for the review Matti! I have moved it to lib/utils.py and also added a release note.

mattip

LGTM. Just some documentation tweaks.

mattip · 2022-08-19T04:44:47Z

doc/release/upcoming_changes/21468.new_feature.rst

+A new function ``np.show_runtime`` has been added to display the runtime
+information of the machine in addition to ``np.show_config`` which displays
+the build-related information.
+This function returns a list of dictionaries as follows::


I think everything from here down should be removed. show_runtime should be added to the documentation here

numpy/doc/source/reference/routines.other.rst

Line 47 in 58ee8a8

show_config

. Then the references above could change to numpy.show_runtime, and numpy.show_config (with single back-ticks), and they would be turned into links.

Wow yeah, that's nice! Added via 706c922 and c806a0a

mattip · 2022-08-19T04:45:30Z

numpy/lib/utils.py

+    in use
+    See Also


Blank line needed

Suggested change

in use

See Also

in use

See Also

Added in fe63699

mattip · 2022-08-19T04:46:36Z

numpy/lib/utils.py

+    show_config : Show libraries in the system on which
+                  NumPy was built.
+    Notes


Blank line, reformat

Suggested change

show_config : Show libraries in the system on which

NumPy was built.

Notes

show_config : Show libraries in the system on which NumPy was built.

Notes

Added in fe63699

mattip · 2022-08-19T04:47:07Z

numpy/lib/utils.py

+       `__cpu_baseline__` and `__cpu_dispatch__`
+    Examples


Blank line needed

Suggested change

`__cpu_baseline__` and `__cpu_dispatch__`

Examples

`__cpu_baseline__` and `__cpu_dispatch__`

Examples

Added in fe63699

mattip · 2022-08-19T04:48:09Z

numpy/lib/utils.py

+    2. In case `threadpoolctl` is not installed, a message is
+       displayed with help on how to install it.


Not sure this is really needed

Removed in fe63699

1. Information is derived with the help of `threadpoolctl` library. 2. In case `threadpoolctl` is not installed, a message is displayed with help on how to install it. 3. SIMD related information is derived from `__cpu_features__`, `__cpu_baseline__` and `__cpu_dispatch__`

mattip · 2022-08-19T13:34:10Z

doc/release/upcoming_changes/21468.new_feature.rst

+New function `np.show_runtime`
+------------------------------
+
+A new function `np.show_runtime` has been added to display the runtime
+information of the machine in addition to `np.show_config` which displays
+the build-related information.


Double back-ticks for np.* to format as code. If you want a link, you need to use numpy.* with single back-ticks. We tried telling sphinx that np is an alias for numpy, but couldn't get the links to work.

Suggested change

New function `np.show_runtime`

------------------------------

A new function `np.show_runtime` has been added to display the runtime

information of the machine in addition to `np.show_config` which displays

the build-related information.

New function ``np.show_runtime``

--------------------------------

A new function `numpy.show_runtime` has been added to display the runtime

information of the machine in addition to `numpy.show_config` which displays

the build-related information.

Thanks for the info! Learning Sphinx on the way :). Fixed via 3d2fe4e

mattip · 2022-08-19T13:35:42Z

numpy/lib/utils.py

+    2. SIMD related information is derived from `__cpu_features__`,
+       `__cpu_baseline__` and `__cpu_dispatch__`


Double back-ticks to format as code. Single back-ticks for links. I don't think we have links for those attributes.

Suggested change

2. SIMD related information is derived from `__cpu_features__`,

`__cpu_baseline__` and `__cpu_dispatch__`

2. SIMD related information is derived from ``__cpu_features__``,

``__cpu_baseline__`` and ``__cpu_dispatch__``

Fixed via 3d2fe4e

mattip · 2022-08-19T13:36:54Z

numpy/lib/utils.py

+
+    Notes
+    -----
+    1. Information is derived with the help of `threadpoolctl`


If you want this to be a link, you have to provide the url. Otherwise use double back-ticks.

Thanks yeah it renders now: https://output.circle-artifacts.com/output/job/79c7902f-6c77-4b35-8f43-d55ceaee6ff5/artifacts/0/doc/build/html/reference/generated/numpy.show_runtime.html, all though it will give flake8 errors, I'm not sure why adding new line like this did not work:

numpy/numpy/lib/npyio.py

Lines 1846 to 1847 in 17d730a

.. [1] NumPy User Guide, section `I/O with NumPy

<https://docs.scipy.org/doc/numpy/user/basics.io.genfromtxt.html>`_.

numpy/lib/utils.py

mattip · 2022-08-21T13:29:44Z

Thanks @ganesh-k13 this will be helpful going forward

Xref numpy#21468

github-actions bot added the 01 - Enhancement label May 6, 2022

rgommers changed the title ~~ENH: Use threadpoolctl~~ ENH: Use threadpoolctl in show_config May 15, 2022

mattip reviewed May 30, 2022

View reviewed changes

ganesh-k13 force-pushed the enh_21340_show_config_threadpoolctl branch 2 times, most recently from 02043a2 to 49ed995 Compare July 24, 2022 07:14

ganesh-k13 changed the title ~~ENH: Use threadpoolctl in show_config~~ ENH: Use threadpoolctl in show_runtime (a new function) Jul 24, 2022

ganesh-k13 force-pushed the enh_21340_show_config_threadpoolctl branch from 49ed995 to 77198c9 Compare July 24, 2022 07:16

ganesh-k13 added a commit to ganesh-k13/numpy that referenced this pull request Aug 18, 2022

DOC: Added np.show_runtime (numpy#21468)

4da4044

ganesh-k13 force-pushed the enh_21340_show_config_threadpoolctl branch from 99e25bc to 4da4044 Compare August 18, 2022 13:50

ganesh-k13 added a commit to ganesh-k13/numpy that referenced this pull request Aug 18, 2022

DOC: Added np.show_runtime (numpy#21468)

73e2245

ganesh-k13 force-pushed the enh_21340_show_config_threadpoolctl branch from 4da4044 to 73e2245 Compare August 18, 2022 13:53

mattip reviewed Aug 19, 2022

View reviewed changes

ganesh-k13 added 4 commits August 19, 2022 18:16

TST: Added show_runtime to test_public_api

5a2a84a

DOC: Added np.show_runtime (numpy#21468)

706c922

DOC: Added show_runtime to Utility

c806a0a

ganesh-k13 force-pushed the enh_21340_show_config_threadpoolctl branch from 73e2245 to c806a0a Compare August 19, 2022 12:50

mattip reviewed Aug 19, 2022

View reviewed changes

ganesh-k13 added a commit to ganesh-k13/numpy that referenced this pull request Aug 21, 2022

DOC: Fixed links for np.show_runtime (numpy#21468)

b5d1e93

ganesh-k13 added a commit to ganesh-k13/numpy that referenced this pull request Aug 21, 2022

DOC: Fixed links for np.show_runtime (numpy#21468)

ab63e3f

ganesh-k13 force-pushed the enh_21340_show_config_threadpoolctl branch from b5d1e93 to ab63e3f Compare August 21, 2022 10:54

ganesh-k13 added a commit to ganesh-k13/numpy that referenced this pull request Aug 21, 2022

DOC: Fixed links for np.show_runtime (numpy#21468)

c8ed74e

ganesh-k13 force-pushed the enh_21340_show_config_threadpoolctl branch from ab63e3f to c8ed74e Compare August 21, 2022 11:05

ganesh-k13 commented Aug 21, 2022

View reviewed changes

numpy/lib/utils.py Outdated Show resolved Hide resolved

DOC: Fixed links for np.show_runtime (numpy#21468)

3d2fe4e

ganesh-k13 force-pushed the enh_21340_show_config_threadpoolctl branch from c8ed74e to 3d2fe4e Compare August 21, 2022 12:45

mattip merged commit 185c4f2 into numpy:main Aug 21, 2022

BvB93 added a commit to BvB93/numpy that referenced this pull request Nov 14, 2022

TYP,ENH: Add annotations for np.show_runtime

6df49a3

Xref numpy#21468

	on which NumPy was built.
	including available intrinsic support and BLAS/LAPACK library
	in use

		2. In case `threadpoolctl` is not installed, a message is
		displayed with help on how to install it.

		2. SIMD related information is derived from `__cpu_features__`,
		`__cpu_baseline__` and `__cpu_dispatch__`

	.. [1] NumPy User Guide, section `I/O with NumPy
	<https://docs.scipy.org/doc/numpy/user/basics.io.genfromtxt.html>`_.

ENH: Use threadpoolctl in show_runtime (a new function) #21468

ENH: Use threadpoolctl in show_runtime (a new function) #21468

Conversation

ganesh-k13 commented May 6, 2022 • edited