Skip to main content

Maximum Projection and Maximin Latin Hypercube Design creation and optimization

Project description

MaxPro

Rust build

This is a minimal Rust implementation of Latin Hypercube Design (LHD) generation with the Maximum Projection metric. It pursues an initial random search for a relatively-optimal candidate and allows for further optimization of that candidate (or any other supplied) in search of a better solution, although this optimization is not guaranteed to preserve the design as a LHD.

The same tools are provided for the Maximin design metric.

Usage of this code should cite both this package as implementation and the MaxPro paper,

Joseph, V. R., Gul, E., & Ba, S. (2015). Maximum projection designs for computer experiments. Biometrika, 102(2), 371–380.

This implementation was inspired by the comparative lack of lightweight LHD options in Rust as well as no Python implementations of MaxPro. Building this in Rust unlocks performance by default.

The Maximin metric is included for additional functionality and performance benchmarking against reference implementations in Python.

Current capabilities

  • Generate a random latin hypercube
  • Generate many random latin hypercubes, calculate the maximum projection metric, and return the LHD that minimizes the MaxPro criterion: cargo run --release -- --iterations 100000 --samples 50 --ndims 2 --metric max-pro
  • Generate many random latin hypercubes, calculate the maximin metric, and return the LHD that maximizes the minimum distance between points: cargo run --release -- --iterations 100000 --samples 50 --ndims 2 --metric maxi-min
  • Using maturin develop --release --features pyo3-bindings, can import maxpro and generate optimal MaxPro LHDs in Python directly.
  • Perturb a LHD to optimize its metric

Planned work

0.1.1

  • Seedable RNGs
  • Performance benchmarking and validation against the R implementation of MaxPro

0.1.2

  • Ordering the designs for optimal execution order

AI Policy

This project's AI policy is that no AI-written code is included in the core Rust module or in the python bindings. AI-written code may be present in the python/ directory but is restricted to analysis. AI code is not used for benchmarking either correctness or speed.

Gemini code review is used in development and any code suggestions must be human tested.

Style

Rust formatting by cargo fmt. Python formatting by ruff. flake8 used for PEP, line length not enforced in docstrings within reason.

Contributing and feature requests

For both contributing and feature requests, please begin by filing an issue specifying either a bug or a feature request. The issues will then be prioritized for inclusion in the next release against other open issues or planned features. To resolve an issue, open a pull request and link it to the issue.

Benchmarks

MaxPro design and optimization: The Rust implementation usually finds a better metric than the Python one (e.g. 5.95 instead of 7.51) and is ~84x faster; (0.0035s instead of 0.3s for Python on a Macbook Air M2) for 5 samples in 2D across 10,000 iterations. Increasing this to 50 samples in 3D, this implementation's result continues to best the Python result (72.5 vs 91) and is ~1440x faster (0.0178s vs 25.72s)

Maximin design and optimization is benchmarked against PyDOE3 as the reference implementation. The Rust and Python implementations return almost identical results (0.22 in this implementation vs 0.21 in PyDOE3) with this implementation offering a 2.63x speedup for 5 samples in 2D across 10,000 iterations. Increasing this to 50 samples in 3D, this implementation returns a better result than PyDOE3 (0.2204 vs 0.2072) with a 2.9x speedup (0.0286s vs. 0.083s).

Benchmarks are run with python/comparisons.py.

Project details


Download files

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

Source Distribution

maxpro-0.1.0.tar.gz (24.1 kB view details)

Uploaded Source

Built Distribution

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

maxpro-0.1.0-cp312-cp312-macosx_11_0_arm64.whl (259.0 kB view details)

Uploaded CPython 3.12macOS 11.0+ ARM64

File details

Details for the file maxpro-0.1.0.tar.gz.

File metadata

  • Download URL: maxpro-0.1.0.tar.gz
  • Upload date:
  • Size: 24.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: maturin/1.10.1

File hashes

Hashes for maxpro-0.1.0.tar.gz
Algorithm Hash digest
SHA256 0a728c42b72fc946aa777a8abbbbdf5df403b702eefafcd00b09115f8253ea82
MD5 6174e48cf0e1951af4e0ec1da39a8122
BLAKE2b-256 e278264f2686c33c4d2c166fb6989b35616c3440d3ba8079d67ae14c891dadd2

See more details on using hashes here.

File details

Details for the file maxpro-0.1.0-cp312-cp312-macosx_11_0_arm64.whl.

File metadata

File hashes

Hashes for maxpro-0.1.0-cp312-cp312-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 dd03fb20865cdbf7a5aa1153c9f8d7a4a2785aed126ba12c1451d64991e821c0
MD5 4170fefdd51f356add259d7441b9c52f
BLAKE2b-256 4e9b84c75d08ed83706f6a4dc2404a310e263c94308284a4908f8d91c89d0a85

See more details on using hashes here.

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