GPmp contrib: the contrib GPmp package
Project description
GPmp-contrib
gpmp-contrib extends gpmp with computer-experiment objects, multi-output
model containers, Matérn model classes, sequential design procedures, set
estimation tools, plots, and relaxed Gaussian-process utilities.
Use gpmp directly for core GP models, covariance functions, numerical backend
operations, and low-level parameter selection. Use gpmp-contrib when a script
needs a ComputerExperiment, a ModelContainer, a sequential strategy, a test
problem, or reGP.
Main components
- Model containers and Matérn classes:
Model_ConstantMean_Maternp_MLModel_ConstantMean_Maternp_REMLModel_ConstantMean_Maternp_REMAPModel_ConstantMean_Maternp_REMAP_logsigma2Model_ConstantMean_Maternp_REMAP_logsigma2_and_logrho_priorModel_Noisy_ConstantMean_Maternp_REML
- Prior access on REMAP classes with priors:
get_prior(...)set_prior(...)
- Sequential strategies:
- fixed candidate sets with
SequentialStrategyGridSearch - SMC particle sets with
SequentialStrategySMC - BSS-style particle sets with
SequentialStrategyBSS
- fixed candidate sets with
- Optimization and set-estimation modules:
- expected improvement in
gpmpcontrib.optim.expectedimprovement - excursion sets in
gpmpcontrib.optim.excursionset - set inversion and Pareto utilities in
gpmpcontrib.optim
- expected improvement in
- reGP utilities in
gpmpcontrib.regp. - Parameter posterior sampling through
ModelContainer.sample_parameters(...).
Package layout
gpmpcontrib/models/: Matérn model container classes.gpmpcontrib/modelcontainer.py: multi-output model container.gpmpcontrib/sequentialprediction.py: observation storage and prediction updates.gpmpcontrib/sequentialstrategy.py: sequential decision strategies.gpmpcontrib/optim/: EI, excursion-set, set-inversion, and Pareto tools.gpmpcontrib/regp/: relaxed Gaussian-process utilities.examples/: scripts using the public objects.docs/: Sphinx documentation.
Requirements
- Python
>=3.9 gpmp >= 0.9.36numpyscipy>=1.12.0matplotlib
Installation
git clone https://github.com/gpmp-dev/gpmp-contrib.git
cd gpmp-contrib
pip install -e .
Minimal example
import gpmpcontrib as gpc
problem = gpc.ComputerExperiment(
1,
[[-1.0], [1.0]],
single_function=lambda x: x**2,
)
The full documentation starts with docs/source/getting_started.rst and then
continues through the user guide. The examples section documents model
construction, noisy observations, expected improvement, excursion sets, set
inversion, and reGP.
Documentation
The documentation is available at https://gpmp-dev.github.io/gpmp-contrib/.
To build it locally, install the documentation dependencies and build the HTML pages:
pip install -r docs/requirements.txt
cd docs
sphinx-build -M html source _build -E
Generate the static example figures with:
cd docs
python make_example_results.py
Authors
See AUTHORS.md.
How to cite
If you use GPmp-contrib in your research, please cite it as follows:
@software{gpmpcontrib2026,
author = {Emmanuel Vazquez},
title = {GPmp-contrib},
year = {2026},
url = {https://github.com/gpmp-dev/gpmp-contrib},
note = {Version 0.9.36},
}
Update the version number when citing another release.
Copyright
Copyright (C) 2022-2026 CentraleSupelec
License
GPmp-contrib is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
GPmp-contrib is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
You should have received a copy of the GNU General Public License along with GPmp-contrib. If not, see http://www.gnu.org/licenses/.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file gpmp_contrib-0.9.36.tar.gz.
File metadata
- Download URL: gpmp_contrib-0.9.36.tar.gz
- Upload date:
- Size: 103.3 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
b554cc42e4a61775eeebbbce632f772c904ccb4c858dcaca9270dafc3fec3ca1
|
|
| MD5 |
53f33a814e619ed79612c97e044c2168
|
|
| BLAKE2b-256 |
3f4c164785fef5d2b39d04cd829c51b285c9a3d350a5352c4ee8baa0873c4262
|
Provenance
The following attestation bundles were made for gpmp_contrib-0.9.36.tar.gz:
Publisher:
publish.yml on gpmp-dev/gpmp-contrib
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
gpmp_contrib-0.9.36.tar.gz -
Subject digest:
b554cc42e4a61775eeebbbce632f772c904ccb4c858dcaca9270dafc3fec3ca1 - Sigstore transparency entry: 1935814506
- Sigstore integration time:
-
Permalink:
gpmp-dev/gpmp-contrib@6befca6396708cb80194be95e3112680822a60b8 -
Branch / Tag:
refs/tags/v0.9.36 - Owner: https://github.com/gpmp-dev
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish.yml@6befca6396708cb80194be95e3112680822a60b8 -
Trigger Event:
push
-
Statement type:
File details
Details for the file gpmp_contrib-0.9.36-py3-none-any.whl.
File metadata
- Download URL: gpmp_contrib-0.9.36-py3-none-any.whl
- Upload date:
- Size: 100.3 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
f00953fb6ce000898b07b1a60da650e5a73541ce494b13ca3ee747c4b0aa7338
|
|
| MD5 |
3f08a6fc01b007ac66e84e3db26734af
|
|
| BLAKE2b-256 |
b762e9d0994f790a56b7591c5a9e431b608447ee4adf647eac8cafdff1321613
|
Provenance
The following attestation bundles were made for gpmp_contrib-0.9.36-py3-none-any.whl:
Publisher:
publish.yml on gpmp-dev/gpmp-contrib
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
gpmp_contrib-0.9.36-py3-none-any.whl -
Subject digest:
f00953fb6ce000898b07b1a60da650e5a73541ce494b13ca3ee747c4b0aa7338 - Sigstore transparency entry: 1935814552
- Sigstore integration time:
-
Permalink:
gpmp-dev/gpmp-contrib@6befca6396708cb80194be95e3112680822a60b8 -
Branch / Tag:
refs/tags/v0.9.36 - Owner: https://github.com/gpmp-dev
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish.yml@6befca6396708cb80194be95e3112680822a60b8 -
Trigger Event:
push
-
Statement type: