Metadata-Version: 2.4
Name: scitex-benchmark
Version: 0.1.5
Summary: Performance benchmarking, runtime monitoring, and profiling helpers — standalone module from the SciTeX ecosystem
Author-email: Yusuke Watanabe <ywatanabe@scitex.ai>
License-Expression: AGPL-3.0-only
Project-URL: Homepage, https://github.com/ywatanabe1989/scitex-benchmark
Project-URL: Repository, https://github.com/ywatanabe1989/scitex-benchmark
Project-URL: Documentation, https://scitex-benchmark.readthedocs.io
Keywords: scitex,benchmark,profiler,monitor,performance,psutil
Classifier: Development Status :: 3 - Alpha
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: Software Development :: Testing
Classifier: Topic :: System :: Monitoring
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: pandas
Requires-Dist: numpy
Requires-Dist: psutil
Provides-Extra: dev
Requires-Dist: pytest; extra == "dev"
Requires-Dist: pytest-cov; extra == "dev"
Requires-Dist: ruff; extra == "dev"
Requires-Dist: scitex-dev>=0.11.7; extra == "dev"
Provides-Extra: docs
Requires-Dist: sphinx>=7.0; extra == "docs"
Requires-Dist: sphinx-rtd-theme>=2.0; extra == "docs"
Requires-Dist: myst-parser>=2.0; extra == "docs"
Requires-Dist: sphinx-copybutton>=0.5; extra == "docs"
Requires-Dist: sphinx-autodoc-typehints>=1.25; extra == "docs"
Provides-Extra: all
Requires-Dist: scitex-benchmark[dev,docs]; extra == "all"
Dynamic: license-file

# scitex-benchmark

<p align="center">
  <a href="https://scitex.ai">
    <img src="docs/scitex-logo-blue-cropped.png" alt="SciTeX" width="400">
  </a>
</p>

<p align="center"><b>Performance benchmarking, runtime monitoring, and profiling helpers.</b></p>

<p align="center">
  <a href="https://scitex-benchmark.readthedocs.io/">Full Documentation</a> · <code>uv pip install scitex-benchmark[all]</code>
</p>

<!-- scitex-badges:start -->
<p align="center">
  <a href="https://pypi.org/project/scitex-benchmark/"><img src="https://img.shields.io/pypi/v/scitex-benchmark.svg" alt="PyPI"></a>
  <a href="https://pypi.org/project/scitex-benchmark/"><img src="https://img.shields.io/pypi/pyversions/scitex-benchmark.svg" alt="Python"></a>
  <a href="https://github.com/ywatanabe1989/scitex-benchmark/actions/workflows/test.yml"><img src="https://github.com/ywatanabe1989/scitex-benchmark/actions/workflows/test.yml/badge.svg" alt="Tests"></a>
  <a href="https://codecov.io/gh/ywatanabe1989/scitex-benchmark"><img src="https://codecov.io/gh/ywatanabe1989/scitex-benchmark/graph/badge.svg" alt="Coverage"></a>
  <a href="https://scitex-benchmark.readthedocs.io/en/latest/"><img src="https://readthedocs.org/projects/scitex-benchmark/badge/?version=latest" alt="Docs"></a>
  <a href="https://www.gnu.org/licenses/agpl-3.0"><img src="https://img.shields.io/badge/license-AGPL_v3-blue.svg" alt="License: AGPL v3"></a>
</p>
<!-- scitex-badges:end -->

---

## Installation

```bash
pip install scitex-benchmark
```

## Architecture

```
src/scitex_benchmark/
├── benchmark.py     # high-level benchmark() runner + statistical comparisons
├── profiler.py      # Profiler context manager (wall-clock + memory)
├── monitor.py       # long-running resource monitor (CPU/RAM/GPU)
└── _skills/         # SciTeX skills metadata
```

## Demo

```mermaid
flowchart LR
    Code[user code] --> P[Profiler ctx]
    Code --> B[benchmark - repeated runs]
    Code --> M[Monitor - long runs]
    P --> Stats[wall-clock + RSS]
    B --> Stats
    M --> Stats
    Stats --> Report[summary - DataFrame / CSV]
```

## Quick Start

```python
import scitex_benchmark as bm

# Quick wall-clock + memory snapshot
with bm.Profiler() as p:
    work()
print(p.summary())
```

## 1 Interfaces

<details open>
<summary><strong>Python API</strong></summary>

<br>

```python
import scitex_benchmark as bm

# Benchmark suite — time/memory across input sizes
suite = bm.BenchmarkSuite("io")
suite.add_benchmark(my_func, gen_input, "name", sizes=["1MB", "10MB"])
results = suite.run()

# Runtime monitor — alerts when CPU/RAM/disk thresholds breached
monitor = bm.RuntimeMonitor(cpu_threshold=80, mem_threshold=90)
with monitor:
    long_running_job()

# Profiler — quick wall-clock + memory snapshot
with bm.Profiler() as p:
    work()
print(p.summary())
```

</details>

## Status

Standalone fork of `scitex.benchmark`. Only dep is `psutil`. The umbrella
package's `scitex.benchmark` import path is preserved via a `sys.modules`-alias
bridge. Convenience builders inside `benchmark.py` import `scitex.io`/`scitex.stats`
*lazily* if you opt in — without those installed they simply error out at
the call site, but the core API works without them.

## Part of SciTeX

`scitex-benchmark` is part of [**SciTeX**](https://scitex.ai). Install via
the umbrella with `pip install scitex[benchmark]` to use as
`scitex.benchmark` (Python) or `scitex benchmark ...` (CLI).

>Four Freedoms for Research
>
>0. The freedom to **run** your research anywhere — your machine, your terms.
>1. The freedom to **study** how every step works — from raw data to final manuscript.
>2. The freedom to **redistribute** your workflows, not just your papers.
>3. The freedom to **modify** any module and share improvements with the community.
>
>AGPL-3.0 — because we believe research infrastructure deserves the same freedoms as the software it runs on.

## License

AGPL-3.0-only (see [LICENSE](./LICENSE)).

---

<p align="center">
  <a href="https://scitex.ai" target="_blank"><img src="docs/scitex-icon-navy-inverted.png" alt="SciTeX" width="40"/></a>
</p>
