Metadata-Version: 2.4
Name: bootstrapx-lib
Version: 0.1.3
Summary: Production-grade uncertainty estimation for Python.
Author-email: Artem Erokhin <artyerokhin@gmail.com>
License: MIT
Project-URL: Homepage, https://github.com/artyerokhin/bootstrapx
Project-URL: Documentation, https://artyerokhin.github.io/bootstrapx
Project-URL: Repository, https://github.com/artyerokhin/bootstrapx
Project-URL: Issues, https://github.com/artyerokhin/bootstrapx/issues
Keywords: bootstrap,statistics,confidence-interval,resampling,numba
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Science/Research
Classifier: Topic :: Scientific/Engineering :: Mathematics
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Requires-Python: >=3.9
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: numpy>=1.23
Requires-Dist: scipy>=1.10
Requires-Dist: numba>=0.57
Requires-Dist: joblib>=1.3
Provides-Extra: cuda
Requires-Dist: numba>=0.57; extra == "cuda"
Provides-Extra: dev
Requires-Dist: pytest>=7; extra == "dev"
Requires-Dist: hypothesis; extra == "dev"
Requires-Dist: coverage; extra == "dev"
Requires-Dist: mypy; extra == "dev"
Requires-Dist: ruff; extra == "dev"
Provides-Extra: docs
Requires-Dist: mkdocs-material; extra == "docs"
Requires-Dist: mkdocstrings[python]; extra == "docs"
Provides-Extra: bench
Requires-Dist: asv; extra == "bench"
Requires-Dist: virtualenv; extra == "bench"
Dynamic: license-file

# bootstrapx

**Production-grade uncertainty estimation for Python.**

[![CI](https://github.com/artyerokhin/bootstrapx/actions/workflows/ci.yml/badge.svg)](https://github.com/artyerokhin/bootstrapx/actions)
[![PyPI](https://img.shields.io/pypi/v/bootstrapx)](https://pypi.org/project/bootstrapx/)
[![Python](https://img.shields.io/pypi/pyversions/bootstrapx)](https://pypi.org/project/bootstrapx/)
[![License: MIT](https://img.shields.io/badge/License-MIT-green.svg)](LICENSE)
[![Docs](https://img.shields.io/badge/docs-mkdocs-blue)](https://artyerokhin.github.io/bootstrapx)

*14 bootstrap methods · Numba JIT · Optional CUDA GPU · Memory-safe batching*

---

## Why bootstrapx?

`scipy.stats.bootstrap` supports only 3 CI methods and has no time-series support.
The R `boot` package is comprehensive but not accessible from Python.
**bootstrapx** bridges this gap with 14 methods, Numba acceleration, and a clean API.

| Feature | `scipy` | R `boot` | **bootstrapx** |
|---|:---:|:---:|:---:|
| BCa interval | ✅ | ✅ | ✅ |
| Studentized (bootstrap-t) | ❌ | ✅ | ✅ |
| Poisson / Bernoulli weights | ❌ | ❌ | ✅ |
| Time-series (MBB, CBB, Stationary, Sieve, Tapered, Wild) | ❌ | Partial | ✅ |
| Cluster / Stratified | ❌ | Partial | ✅ |
| Numba JIT | ❌ | N/A | ✅ |
| CUDA GPU | ❌ | ❌ | ✅ |
| Generator batching (constant memory) | ❌ | ❌ | ✅ |

---

## Installation

```bash
pip install bootstrapx

# With GPU
pip install "bootstrapx[cuda]"
```

---

## Quick Start

```python
import numpy as np
from bootstrapx import bootstrap

data = np.random.default_rng(42).normal(5, 2, size=200)

result = bootstrap(data, np.mean)
print(result)
# BootstrapResult(method='bca', theta_hat=4.94, se=0.13, CI=[4.70, 5.19])
```

---

## Performance

bootstrapx is significantly faster than `scipy.stats.bootstrap` for large datasets:

| N | Method | Scipy | Bootstrapx | Speedup |
|---|---|---|---|---|
| 5,000 | BCa | 0.80s | 0.27s | **3.0x** |
| 50,000 | Percentile | 7.29s | 2.01s | **3.6x** |
| 100,000 | Percentile | 54.34s | 3.99s | **13.6x** |

*Benchmark on Apple M1, Python 3.12. See [Benchmarks](https://artyerokhin.github.io/bootstrapx/benchmarks/) for details.*

---

## Coverage Accuracy

Monte Carlo simulation ($N=1000$, 500 runs) confirms correct statistical coverage:

| Distribution | BCa Coverage (Nominal 95%) |
|---|---|
| Normal | **94.8%** |
| Skewed (Exponential) | **95.0%** |
| Heavy-Tailed (t-dist) | **94.0%** |

---

## Documentation

📖 **Full docs:** [artyerokhin.github.io/bootstrapx](https://artyerokhin.github.io/bootstrapx)

- [Getting Started](https://artyerokhin.github.io/bootstrapx/getting-started/)
- [Methods Guide](https://artyerokhin.github.io/bootstrapx/methods/) — math behind each method
- [API Reference](https://artyerokhin.github.io/bootstrapx/reference/)
- [Benchmarks](https://artyerokhin.github.io/bootstrapx/benchmarks/)

---

## Contributing

```bash
git clone https://github.com/artyerokhin/bootstrapx.git
cd bootstrapx
pip install -e ".[dev,docs]"
pytest tests/ -v
mkdocs serve
```

---

## License

MIT — see [LICENSE](LICENSE).
