Developer Content

Contents:

• axtreme
  • Repo Structure
  • Development Setup
    • 1. Install uv
    • 2. Install Python
    • 3. Clone the repository
    • 4. Install dependencies
    • 5. (Optional) Install CUDA support
    • 6. (Optional) Activate the virtual environment
    • 7. Install pre-commit hooks
    • 8. Test that the installation works
  • Development Tools
    • ruff Formatter
    • ruff Linter
    • mypy
    • pytest
  • Documentation
  • Meta
  • Contributing
• API Reference
  • axtreme package
    • Subpackages
      • axtreme.acquisition
      • axtreme.data
      • axtreme.distributions
      • axtreme.eval
      • axtreme.plotting
      • axtreme.qoi
      • axtreme.sampling
      • axtreme.simulator
      • axtreme.utils
    • Modules
      • axtreme.evaluation
      • axtreme.experiment
      • axtreme.metrics
      • axtreme.runner
• Technical Details
  • Compatibility with Ax
  • GPBruteforce behaviour w.r.t changes in the underlying model
    • Details
      • ERD smoothness w.r.t model
      • QoI smoothness w.r.t model
  • Design of Experiments (DoE)
    • Overview
    • Purpose and Motivation
      • Why DoE?
      • The Problem DoE Solves
      • Problems Where DoE is Most Beneficial
    • How DoE Works in Axtreme
      • Core Components
      • The DoE Process
      • QoILookAhead Acquisition Function
    • Evaluating DoE Performance
      • Key Performance Indicators
    • Tunable Parameters
      • Critical Parameters
    • Troubleshooting Common Issues
      • Poor DoE Performance
      • Slow Convergence
    • Best Practices
    • Conclusion
• Glossary
  • Key terms
  • Dimension notation
    • Botorch tensor notation
    • gpytorch notation
• Changelog
  • Unreleased
    • Added
    • Changed
    • Solved
    • Dependencies
  • 0.1.1 - 2024-12-27
    • Added:
    • Changed
    • Fixed
    • Dependencies
  • 0.1.0 - 2024-12-10
  • 0.0.1 - 2023-02-21
    • Added
    • Changed
    • Dependencies
    • Fixed
    • Deprecated
    • Removed
• Style Guide
  • References
  • Code Layout
  • Line Breaks
  • String Formatting
  • Naming Conventions
  • Named Arguments
  • Commenting
  • Type hints
  • Docstrings
  • Exceptions
  • Imports
  • Unit-tests
  • And finally: It is a bad idea to use