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.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.1-py3-none-win_amd64.whl (3.1 MB view details)

Uploaded Python 3Windows x86-64

gpboost-1.7.1.1-py3-none-manylinux_2_27_x86_64.whl (6.4 MB view details)

Uploaded Python 3manylinux: glibc 2.27+ x86-64

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

Uploaded Python 3macOS 12.0+ ARM64

gpboost-1.7.1.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.1.tar.gz.

File metadata

  • Download URL: gpboost-1.7.1.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.1.tar.gz
Algorithm Hash digest
SHA256 e615aee8470f7ebf690c1c6f25a4eed39f5b89fef05f4c7ad02fb9f2e377fc34
MD5 80ed21f5aee04891053cfc901a93ae82
BLAKE2b-256 2d2a424d5359e613b20dc5398407f74e63055a34c974b68c4d55312b76b1a73c

See more details on using hashes here.

File details

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

File metadata

  • Download URL: gpboost-1.7.1.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.1-py3-none-win_amd64.whl
Algorithm Hash digest
SHA256 8a8aa5c744e265ba3cd9556e4ea5aa252265c8cacf9d40529f6750fbe2f771d1
MD5 7a7ddd03d3c95639c0d369a87241e395
BLAKE2b-256 4ddb9744e66df983f18f676930970cfb6891afb3be92075e3ee71ade7b2aa969

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for gpboost-1.7.1.1-py3-none-manylinux_2_27_x86_64.whl
Algorithm Hash digest
SHA256 4b9ec0966a1546ee442ba0e4c65cc1b056c4aaa06712ee635f2b2d06ddbc6b7d
MD5 3e9f73a9a4be9082374842d4cc76af8b
BLAKE2b-256 00a89152f215c4fe0c1fe4a51ef06244e9aa233094b593aa3082cc082c481445

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for gpboost-1.7.1.1-py3-none-macosx_12_0_arm64.whl
Algorithm Hash digest
SHA256 ae254dde02ccc4dddc35d97dbb26085e971ce3ab6803d4763c6a97d6817ff90b
MD5 69344602b327b0d94559e539d0ebcbee
BLAKE2b-256 c86b7aa07aff5d53a893c6ebf2126cbddbbe9df2ec7426cd4250a4ce0c26646b

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for gpboost-1.7.1.1-py3-none-macosx_10_9_x86_64.whl
Algorithm Hash digest
SHA256 0670842ea4874b7dbb7097864e45a2e2c18812c5991c41e62819457305471b14
MD5 4a6b9ce140785491c9edd662ca743611
BLAKE2b-256 b1aa8af723d8b11575fb6aad7070f6b48e6e7e9cd972b89747214d4ea9e94aae

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