exhaust
A Python library to exhaustively enumerate a combinatorial space represented by a function.
The API is modelled after Python's random module and should feel familiar. An additional convenience function maybe() was added to cover a common case.
If you're missing a function and the corresponding space can be enumerated feel free to open an issue. Any functions that generate real-valued distributions cannot be supported.
Example
import exhaust
def generate_character(state: exhaust.State):
eyes = []
for _ in range(state.randint(1, 3)):
eyes.append({
'color': state.choice(['brown', 'blue']),
'glowing': state.maybe()
})
size = 'giant' if len(eyes) == 1 else 'normal'
accessories = []
if len(eyes) == 2:
if state.maybe():
accessories.append('hat')
if state.maybe():
accessories.append('ring')
character = {
'size': size,
'eyes': eyes,
'accessories': accessories
}
return character
# iterates over a space of 132 characters
for character in exhaust.space(generate_character):
print(character)
As you can see, navigating the space works fine within loops as well.
Each time a function from the State object is called (like maybe()), you can think of it as forking the current path into multiple branches, leading to a tree that gets explored. While exploring, the user-defined function is called for each path of the tree.
See the examples/ folder for further examples that can be run on the command line.
See the API Documentation for all available State functions.
Installation
pip install exhaust
Development
Requires pip >= 21.3
Editable install:
pip install -e .
Run tests:
pip install -r requirements-test.txt
pytest
Build docs:
pip install -r requirements-docs.txt
sphinx-build -b html docs dist-docs
Build wheel:
pip install build
python -m build --wheel
Acknowledgments
This package is inspired by KerasTuner's method of defining hyperparameter search spaces.
Metadata
Release files for exhaust 1.1.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| exhaust-1.1.0-py3-none-any.whl | Python 3 | none | any | Details for exhaust-1.1.0-py3-none-any.whl |
Release files / exhaust-1.1.0-py3-none-any.whl
| Download URL | exhaust-1.1.0-py3-none-any.whl |
|---|---|
| Size | 5.0 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
aca1b82be71edcecc1c538ab9f908b78cfbaa5f40520734a7440db0d48017de2
|
|
BLAKE2b-256 checksum How to use checksums |
4a4ced16b3a2e4124755210f9c908b083d3bb69259d5e135bb1d1085528839d1
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.7.0 importlib_metadata/4.8.2 pkginfo/1.8.2 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.10.0
|
Security for exhaust 1.1.0
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.