Skip to main content

GPBoost icon

GPBoost Python Package

License

This is the Python package implementation of the GPBoost library. See https://github.com/fabsig/GPBoost for more information on the modeling background and the software implementation.

Table of Contents

Examples and documentation

Installation

Before you install

Installation from PyPI using precompiled binaries

pip install gpboost -U

Requirements

  • For Windows users, VC runtime is needed if Visual Studio (2015 or newer) is not installed.

  • For Linux users, glibc >= 2.14 is required.

    • If you get an error message version `GLIBC_2.27' not found, you need to install from source.

    • In rare cases, when you get the OSError: libgomp.so.1: cannot open shared object file: No such file or directory error when importing GPBoost, you need to install the OpenMP runtime library separately (use your package manager and search for lib[g|i]omp for doing this).

  • For macOS users:

    • The library file in distribution wheels is built by the Apple Clang compiler. You need to install the OpenMP library. You can install the OpenMP library by the following command: brew install libomp.

    • If you have an arm64 Apple silicon processor (e.g., M1 or M2) and experience problems, try the following steps:

      • uninstall homebrew (in case you have migrated from an older non-arm64 Mac)
      • install homebrew (to make sure that you have an arm64 version of libomp)
      • install OpenMP (brew install libomp)
      • remove existing python environments and install Miniforge (brew install miniforge and conda init "$(basename "${SHELL}")")

Installation from source

Installation from source can be either done from PyPI or GitHub.

Requirements for installation from source

  • Installation from source requires that you have installed CMake.

  • For Linux users, glibc >= 2.14 is required.

    • In rare cases, you may need to install the OpenMP runtime library separately (use your package manager and search for lib[g|i]omp for doing this).
  • For macOS users, you can perform installation either with Apple Clang or gcc.

    • In case you prefer Apple Clang, you should install OpenMP (details for installation can be found in the Installation Guide) first and CMake version 3.16 or higher is required. Only Apple Clang version 8.1 or higher is supported.

    • In case you prefer gcc, you need to install it (details for installation can be found in the Installation Guide) and specify compilers by running export CXX=g++-7 CC=gcc-7 (replace "7" with the version of gcc installed on your machine) first.

  • For Windows users, Visual Studio (or VS Build Tools) is needed.

Installation from source from PyPI

pip install --no-binary :all: gpboost
Build with MinGW-w64 on Windows
pip install gpboost --install-option=--mingw

Installation from source from GitHub

git clone --recursive https://github.com/fabsig/GPBoost.git
cd GPBoost/python-package
# export CXX=g++-7 CC=gcc-7  # macOS users, if you decided to compile with gcc, don't forget to specify compilers (replace "7" with version of gcc installed on your machine)
python -m pip install .
Build with MinGW-w64 on Windows
python setup.py install --mingw

Build CUDA Version

python setup.py install --cudagp

For macOS and Windows users, the CUDA version is not supported.

CUDA library is needed: details for installation can be found in Installation Guide.

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

gpboost-1.7.1.tar.gz (2.3 MB view details)

Uploaded Source

Built Distributions

If you're not sure about the file name format, learn more about wheel file names.

gpboost-1.7.1-py3-none-win_amd64.whl (3.1 MB view details)

Uploaded Python 3Windows x86-64

gpboost-1.7.1-py3-none-manylinux_2_27_x86_64.whl (6.3 MB view details)

Uploaded Python 3manylinux: glibc 2.27+ x86-64

gpboost-1.7.1-py3-none-macosx_12_0_arm64.whl (5.6 MB view details)

Uploaded Python 3macOS 12.0+ ARM64

gpboost-1.7.1-py3-none-macosx_10_9_x86_64.whl (6.2 MB view details)

Uploaded Python 3macOS 10.9+ x86-64

File details

Details for the file gpboost-1.7.1.tar.gz.

File metadata

  • Download URL: gpboost-1.7.1.tar.gz
  • Upload date:
  • Size: 2.3 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.14.6

File hashes

Hashes for gpboost-1.7.1.tar.gz
Algorithm Hash digest
SHA256 4a19dea2aa9dc476d3d8ea148b4e8c90d4166ad29de21ac5b716b7f8af7999e1
MD5 c2813efd204dab55dd28be0b5f06e801
BLAKE2b-256 2b616abba96219aff68825b24f20d704d28873b52c4e65b6412b685868dbc041

See more details on using hashes here.

File details

Details for the file gpboost-1.7.1-py3-none-win_amd64.whl.

File metadata

  • Download URL: gpboost-1.7.1-py3-none-win_amd64.whl
  • Upload date:
  • Size: 3.1 MB
  • Tags: Python 3, Windows x86-64
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.14.6

File hashes

Hashes for gpboost-1.7.1-py3-none-win_amd64.whl
Algorithm Hash digest
SHA256 aaf040b587e5c21f1f58b595c6718f25a1588b0eac25532424dbde2ea0c2c0ca
MD5 3f4d9c09396654e9b319994ab9b1e997
BLAKE2b-256 9f08f489fbfb64de2c7ae566c9156505dbf2ba9eeb281bc07de86dca20150561

See more details on using hashes here.

File details

Details for the file gpboost-1.7.1-py3-none-manylinux_2_27_x86_64.whl.

File metadata

File hashes

Hashes for gpboost-1.7.1-py3-none-manylinux_2_27_x86_64.whl
Algorithm Hash digest
SHA256 f83dffa6d0b07e75468625eee3b1f22d141c4c92e59633391279db599ee5880c
MD5 ff30d3327b961be739a2a84f24056ba7
BLAKE2b-256 4bc98646c6f3ed6deda27484804bb9ce852c3404d9de912e49c5b887cdf328b0

See more details on using hashes here.

File details

Details for the file gpboost-1.7.1-py3-none-macosx_12_0_arm64.whl.

File metadata

File hashes

Hashes for gpboost-1.7.1-py3-none-macosx_12_0_arm64.whl
Algorithm Hash digest
SHA256 8df23e79af6467cde618b93f0510f16c6f1a686df7da5d3d8b115b20a803b5e9
MD5 31933b88e82a4ec610d9cadcb5007598
BLAKE2b-256 519dd470981e12b25125e32a8867ad9d55d54db0bc8d5cf8208f76c7be1ab2e9

See more details on using hashes here.

File details

Details for the file gpboost-1.7.1-py3-none-macosx_10_9_x86_64.whl.

File metadata

File hashes

Hashes for gpboost-1.7.1-py3-none-macosx_10_9_x86_64.whl
Algorithm Hash digest
SHA256 04d9e8292bd779a0a4f110fcbcbe104260ecdc1b96c201d40970caf29acbea4d
MD5 23bf086dac395625314c9f3e33914144
BLAKE2b-256 234af69491c73b7b15e01199513ae147a26a0b2a540052c813af93695f792f77

See more details on using hashes here.

Release history Release notifications | RSS feed

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page