Thanks to visit codestin.com
Credit goes to github.com

Skip to content

ENH: start to use OpenBLAS from a wheel #24749

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 2 commits into from
Closed

ENH: start to use OpenBLAS from a wheel #24749

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
46439e5
ENH: use OpenBLAS from a wheel
mattip Sep 19, 2023
ca639f0
CI fixes
mattip Sep 26, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .github/meson_actions/action.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ runs:
pip install -r build_requirements.txt
echo "::endgroup::"
echo "::group::Building NumPy"
# spin build will pick up any scipy-openblas openblas.pc in ./openblas
spin build --clean -- ${MESON_ARGS[@]}
echo "::endgroup::"

Expand Down
22 changes: 11 additions & 11 deletions .github/workflows/linux.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,10 +73,10 @@ jobs:
- uses: actions/setup-python@61a6322f88396a6271a6ee3565807d608ecaddd1 # v4.7.0
with:
python-version: 'pypy3.9-v7.3.12'
- name: Install system dependencies
- name: Setup using scipy-openblas
run: |
sudo apt-get update
sudo apt-get install libopenblas-dev ninja-build
python -m pip install scipy-openblas32 spin
spin config-openblas --with-scipy-openblas=32
- uses: ./.github/meson_actions

debug:
Expand Down Expand Up @@ -124,16 +124,16 @@ jobs:
run: |
pip install -r build_requirements.txt
pip install -r test_requirements.txt
- name: Install gfortran and OpenBLAS (MacPython build)
- name: Install gfortran and setup OpenBLAS (MacPython build)
run: |
set -xe
sudo apt update
sudo apt install gfortran libgfortran5
target=$(python tools/openblas_support.py)
sudo cp -r $target/lib/* /usr/lib
sudo cp $target/include/* /usr/include
pip install scipy-openblas32
spin config-openblas --with-scipy-openblas=32
- name: Build a wheel
run: |
export PKG_CONFIG_PATH=${PWD}/.openblas
python -m build --wheel --no-isolation --skip-dependency-check
pip install dist/numpy*.whl
- name: Run full test suite
Expand Down Expand Up @@ -185,17 +185,17 @@ jobs:
- uses: actions/setup-python@61a6322f88396a6271a6ee3565807d608ecaddd1 # v4.7.0
with:
python-version: '3.11'
- name: Install gfortran and OpenBLAS (MacPython build)
- name: Install gfortran and setup OpenBLAS (MacPython build)
run: |
set -xe
sudo apt update
sudo apt install gfortran libgfortran5
target=$(python tools/openblas_support.py)
sudo cp -r $target/lib/* /usr/lib
sudo cp $target/include/* /usr/include
pip install scipy-openblas32 spin
spin config-openblas --with-scipy-openblas=32
- name: Build a wheel via an sdist
run: |
pip install build
export PKG_CONFIG_PATH=${PWD}/.openblas
python -m build
pip install dist/numpy*.whl
- name: Install test dependencies
Expand Down
8 changes: 2 additions & 6 deletions .github/workflows/linux_blas.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,13 +7,9 @@ name: BLAS tests (Linux)
#
# Jobs and their purpose:
#
# - openblas64_setuppy:
# This job uses the default 64-bit build of OpenBLAS with the
# `numpy.distutils`-based build. It can be removed once we remove
# support for those builds.
# - openblas32_stable_nightly:
# Uses the 32-bit OpenBLAS builds, both the latest stable release and a
# nightly build.
# Uses the 32-bit OpenBLAS builds, both the latest stable release
# and a nightly build.
#
# TODO: coverage here is limited, we should add non-OpenBLAS libraries and
# exercise the BLAS-related build options (see `meson_options.txt`).
Expand Down
4 changes: 2 additions & 2 deletions .github/workflows/linux_compiler_sanitizers.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,8 +35,8 @@ jobs:
- name: Install dependencies
run: |
pip install -r build_requirements.txt
sudo apt-get update
sudo apt-get install -y libopenblas-serial-dev
pip install scipy-openblas32 spin
spin config-openblas --with-scipy-openblas=32
- name: Build
shell: 'script -q -e -c "bash --noprofile --norc -eo pipefail {0}"'
env:
Expand Down
18 changes: 9 additions & 9 deletions .github/workflows/linux_musl.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,20 +48,20 @@ jobs:

ln -s /usr/local/bin/python3.10 /usr/local/bin/python

- name: test musllinux_x86_64
- name: test-musllinux_x86_64
run: |
python -m venv test_env
source test_env/bin/activate

# required for figuring out the system tags in openblas_support
pip install packaging

# install openblas by co-opting the CIBW setup script
RUNNER_OS=Linux sh tools/wheels/cibw_before_build.sh .
pip install scipy-openblas64

pip install -r build_requirements.txt
pip install pytest pytest-xdist hypothesis typing_extensions
pip install -r build_requirements.txt -r test_requirements.txt

# use meson to build and test
spin build
spin build --with-scipy-openblas=64
spin test -j auto

- name: Meson Log
shell: bash
run: |
cat build/meson-logs/meson-log.txt
31 changes: 10 additions & 21 deletions .github/workflows/windows.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,16 +37,9 @@ jobs:
run: |
python -m pip install spin Cython

- name: Install OpenBLAS (MacPython build)
- name: Install pkg-config
run: |
# Download and install pre-built OpenBLAS library with 32-bit
# interfaces. Unpack it in the pkg-config hardcoded path
choco install unzip -y
choco install wget -y
choco install -y --checksum 6004DF17818F5A6DBF19CB335CC92702 pkgconfiglite
wget https://anaconda.org/multibuild-wheels-staging/openblas-libs/v0.3.21/download/openblas-v0.3.21-win_amd64-gcc_10_3_0.zip
unzip -d c:\opt openblas-v0.3.21-win_amd64-gcc_10_3_0.zip
echo "PKG_CONFIG_PATH=c:\opt\64\lib\pkgconfig;" >> $env:GITHUB_ENV

- name: Install Clang-cl
if: matrix.compiler == 'Clang-cl'
Expand All @@ -56,25 +49,21 @@ jobs:
- name: Install NumPy (MSVC)
if: matrix.compiler == 'MSVC'
run: |
spin build -j2 -- --vsenv
python -m pip install scipy-openblas32
spin build --with-scipy-openblas=32 -j2 -- --vsenv

- name: Install NumPy (Clang-cl)
if: matrix.compiler == 'Clang-cl'
run: |
"[binaries]","c = 'clang-cl'","cpp = 'clang-cl'","ar = 'llvm-lib'","c_ld = 'lld-link'","cpp_ld = 'lld-link'" | Out-File $PWD/clang-cl-build.ini -Encoding ascii
spin build -j2 -- --vsenv --native-file=$PWD/clang-cl-build.ini
python -m pip install scipy-openblas32
spin build --with-scipy-openblas=32 -j2 -- --vsenv --native-file=$PWD/clang-cl-build.ini

- name: Copy OpenBLAS DLL, write _distributor_init.py
- name: Meson Log
shell: bash
if: ${{ failure() }}
run: |
# Getting the OpenBLAS DLL to the right place so it loads
$installed_path = "$PWD\build-install\usr\Lib\site-packages"
$numpy_path = "${installed_path}\numpy"
$libs_path = "${installed_path}\numpy.libs"
mkdir ${libs_path}
$ob_path = "C:/opt/64/bin/"
cp $ob_path/*.dll $libs_path
# Write _distributor_init.py to load .libs DLLs.
python -c "from tools import openblas_support; openblas_support.make_init(r'${numpy_path}')"
cat build/meson-logs/meson-log.txt

- name: Install test dependencies
run: |
Expand All @@ -85,7 +74,7 @@ jobs:
run: |
spin test

msvc_32bit_python_openblas:
msvc_32bit_python_no_openblas:
name: MSVC, 32-bit Python, no BLAS
runs-on: windows-2019
if: "github.repository == 'numpy/numpy'"
Expand Down
2 changes: 1 addition & 1 deletion .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -118,7 +118,6 @@ doc/source/**/generated/

# Things specific to this project #
###################################
# The line below should change to numpy/_version.py for NumPy 2.0
benchmarks/results
benchmarks/html
benchmarks/env
Expand All @@ -139,3 +138,4 @@ tools/swig/test/Tensor.py
tools/swig/test/Vector.py
tools/swig/test/Vector_wrap.cxx
tools/swig/test/Array.py
.openblas
62 changes: 60 additions & 2 deletions .spin/cmds.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,9 +37,14 @@
"-v", "--verbose", is_flag=True,
help="Print all build output, even installation"
)
@click.option(
"--with-scipy-openblas", type=click.Choice(["32", "64"]),
default=None,
help="Build with pre-installed scipy-openblas32 or scipy-openblas64 wheel"
)
@click.argument("meson_args", nargs=-1)
@click.pass_context
def build(ctx, meson_args, jobs=None, clean=False, verbose=False, quiet=False):
def build(ctx, meson_args, with_scipy_openblas, jobs=None, clean=False, verbose=False, quiet=False):
"""🔧 Build package with Meson/ninja and install

MESON_ARGS are passed through e.g.:
Expand All @@ -53,6 +58,7 @@ def build(ctx, meson_args, jobs=None, clean=False, verbose=False, quiet=False):

CFLAGS="-O0 -g" spin build
"""
_maybe_setup_openblas(ctx, with_scipy_openblas)
ctx.forward(meson.build)


Expand Down Expand Up @@ -413,7 +419,7 @@ def ipython(ctx, ipython_args):
util.run(["ipython", "--ignore-cwd",
f"--TerminalIPythonApp.exec_lines={preimport}"] +
list(ipython_args))


@click.command(context_settings={"ignore_unknown_options": True})
@click.pass_context
Expand All @@ -425,3 +431,55 @@ def mypy(ctx):
ctx.params['pytest_args'] = [os.path.join('numpy', 'typing')]
ctx.params['markexpr'] = 'full'
ctx.forward(test)

@click.command(context_settings={
'ignore_unknown_options': True
})
@click.option(
"--with-scipy-openblas", type=click.Choice(["32", "64"]),
default=None, required=True,
help="Build with pre-installed scipy-openblas32 or scipy-openblas64 wheel"
)
def config_openblas(with_scipy_openblas):
"""🔧 Create .openblas/openblas.pc file

Also modify _distributor_init.py

Requires a pre-installed scipy-openblas64 or scipy-openblas32
"""
_config_openblas(with_scipy_openblas)

def _config_openblas(blas_variant):
import importlib
basedir = os.getcwd()
openblas_dir = os.path.join(basedir, ".openblas")
pkg_config_fname = os.path.join(openblas_dir, "openblas.pc")
if blas_variant:
module_name = f"scipy_openblas{blas_variant}"
try:
openblas = importlib.import_module(module_name)
except ModuleNotFoundError:
raise RuntimeError(f"'pip install {module_name} first")
openblas.write__distributor_init(os.path.join(basedir, "numpy"))
os.makedirs(openblas_dir, exist_ok=True)
with open(pkg_config_fname, "wt", encoding="utf8") as fid:
fid.write(openblas.get_pkg_config().replace("\\", "/"))

def _maybe_setup_openblas(ctx, blas_variant):
_config_openblas(blas_variant)
import importlib
basedir = os.getcwd()
openblas_dir = os.path.join(basedir, ".openblas")
pkg_config_fname = os.path.join(openblas_dir, "openblas.pc")
if blas_variant == "64":
ctx.params["meson_args"] += (
"-Dblas-symbol-suffix=64_",
"-Duse-ilp64=true",
)
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Here is where spin build adds the meson arguments for 64-bit openblas builds

if os.path.exists(pkg_config_fname):
oldvalue = os.environ.get("PKG_CONFIG_PATH", "")
if oldvalue:
os.environ["PKG_CONFIG_PATH"] = openblas_dir + os.pathsep + oldvalue
else:
os.environ["PKG_CONFIG_PATH"] = openblas_dir
ctx.params.pop("with_scipy_openblas", None)
11 changes: 4 additions & 7 deletions azure-pipelines.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,13 +73,12 @@ stages:
cd /numpy && \
/opt/python/cp39-cp39/bin/python -mvenv venv && \
source venv/bin/activate && \
target=\$(python3 tools/openblas_support.py) && \
cp -r \$target/lib/* /usr/lib && \
cp \$target/include/* /usr/include && \
python3 -m pip install ninja && \
python3 -m pip install ninja scipy-openblas32 spin && \
python3 -m pip install -r test_requirements.txt && \
echo CFLAGS \$CFLAGS && \
python3 -m pip install -v . && \
spin openblas-config --with-scipy-openblas=32 && \
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
spin openblas-config --with-scipy-openblas=32 && \
spin openblas-config --with-scipy-openblas=32 && \
Suggested change
spin openblas-config --with-scipy-openblas=32 && \
spin config-openblas --with-scipy-openblas=32 && \

export PKG_CONFIG_PATH=/numpy/.openblas && \
python3 -m pip install . && \
cd tools && \
python3 -m pytest --pyargs numpy"
displayName: 'Run 32-bit manylinux2014 Docker Build / Tests'
Expand Down Expand Up @@ -107,8 +106,6 @@ stages:
TEST_MODE: fast
BITS: 64
NPY_USE_BLAS_ILP64: '1'
# Broken - it builds but _multiarray_umath doesn't import - needs investigating
DISABLE_BLAS: '1'

steps:
- template: azure-steps-windows.yml
37 changes: 9 additions & 28 deletions azure-steps-windows.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,43 +24,24 @@ steps:
displayName: 'Install utilities'

- powershell: |
$ErrorActionPreference = "Stop"
mkdir C:/opt/openblas/openblas_dll
mkdir C:/opt/32/lib/pkgconfig
mkdir C:/opt/64/lib/pkgconfig
$target=$(python -c "import tools.openblas_support as obs; plat=obs.get_plat(); ilp64=obs.get_ilp64(); target=f'openblas_{plat}.zip'; obs.download_openblas(target, plat, ilp64);print(target)")
unzip -o -d c:/opt/ $target
echo "##vso[task.setvariable variable=PKG_CONFIG_PATH]c:/opt/64/lib/pkgconfig"
copy C:/opt/64/bin/*.dll C:/opt/openblas/openblas_dll
displayName: 'Download / Install OpenBLAS'

- powershell: |
# Note: ensure the `pip install .` command remains the last one here, to
# avoid "green on failure" issues
python -c "from tools import openblas_support; openblas_support.make_init('numpy')"
# Note: ensure the `pip install .` command remains the last one here,
# to avoid "green on failure" issues
If ( Test-Path env:DISABLE_BLAS ) {
python -m pip install . -v -Csetup-args="--vsenv" -Csetup-args="-Dblas=none" -Csetup-args="-Dlapack=none" -Csetup-args="-Dallow-noblas=true"
}
elseif ( Test-Path env:NPY_USE_BLAS_ILP64 ) {
python -m pip install scipy-openblas64 spin
spin config-openblas --with-scipy-openblas=64
$env:PKG_CONFIG_PATH="$pwd/.openblas"
python -m pip install . -v -Csetup-args="--vsenv" -Csetup-args="-Duse-ilp64=true" -Csetup-args="-Dblas-symbol-suffix=64_"
} else {
python -m pip install . -v -Csetup-args="--vsenv"
python -m pip install scipy-openblas32 spin
spin config-openblas --with-scipy-openblas=32
$env:PKG_CONFIG_PATH="$pwd/.openblas"
python -m pip install . -v -Csetup-args="--vsenv"
}
displayName: 'Build NumPy'

- powershell: |
# copy from c:/opt/openblas/openblas_dll to numpy/../numpy.libs to ensure it can
# get loaded when numpy is imported (no RPATH on Windows)
$target = $(python -c "import sysconfig; print(sysconfig.get_path('platlib'))")
mkdir $target/numpy.libs
copy C:/opt/openblas/openblas_dll/*.dll $target/numpy.libs
displayName: 'Copy OpenBLAS DLL to site-packages'

- script: |
python -m pip install threadpoolctl
python tools/openblas_support.py --check_version
displayName: 'Check OpenBLAS version'

- powershell: |
cd tools # avoid root dir to not pick up source tree
# Get a gfortran onto the path for f2py tests
Expand Down
4 changes: 4 additions & 0 deletions doc/source/dev/development_environment.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,6 +66,10 @@ Now, whenever you want to switch to the virtual environment, you can use the
command ``source numpy-dev/bin/activate``, and ``deactivate`` to exit from the
virtual environment and back to your previous shell.

Building from source
--------------------

See building-from-source_

.. _testing-builds:

Expand Down
1 change: 1 addition & 0 deletions pyproject.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -200,6 +200,7 @@ cli = 'vendored-meson/meson/meson.py'
".spin/cmds.py:build",
".spin/cmds.py:test",
".spin/cmds.py:mypy",
".spin/cmds.py:config_openblas",
]
"Environments" = [
"spin.cmds.meson.run", ".spin/cmds.py:ipython",
Expand Down
Loading