krunic 0.1.0__tar.gz

krunic-0.1.0/.gitignore

@@ -0,0 +1,207 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[codz]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py.cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# UV
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#uv.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+#poetry.toml
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#   pdm recommends including project-wide configuration in pdm.toml, but excluding .pdm-python.
+#   https://pdm-project.org/en/latest/usage/project/#working-with-version-control
+#pdm.lock
+#pdm.toml
+.pdm-python
+.pdm-build/
+
+# pixi
+#   Similar to Pipfile.lock, it is generally recommended to include pixi.lock in version control.
+#pixi.lock
+#   Pixi creates a virtual environment in the .pixi directory, just like venv module creates one
+#   in the .venv directory. It is recommended not to include this directory in version control.
+.pixi
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.envrc
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/
+
+# Abstra
+# Abstra is an AI-powered process automation framework.
+# Ignore directories containing user credentials, local state, and settings.
+# Learn more at https://abstra.io/docs
+.abstra/
+
+# Visual Studio Code
+#  Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore 
+#  that can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
+#  and can be added to the global gitignore or merged into this file. However, if you prefer, 
+#  you could uncomment the following to ignore the entire vscode folder
+# .vscode/
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc
+
+# Cursor
+#  Cursor is an AI-powered code editor. `.cursorignore` specifies files/directories to
+#  exclude from AI features like autocomplete and code analysis. Recommended for sensitive data
+#  refer to https://docs.cursor.com/context/ignore-files
+.cursorignore
+.cursorindexingignore
+
+# Marimo
+marimo/_static/
+marimo/_lsp/
+__marimo__/

krunic-0.1.0/.python-version

@@ -0,0 +1 @@
+3.12

krunic-0.1.0/PKG-INFO

@@ -0,0 +1,196 @@
+Metadata-Version: 2.4
+Name: krunic
+Version: 0.1.0
+Summary: Hyperparameter search for image classifiers using Ray Tune + SkyPilot
+Requires-Python: >=3.12
+Requires-Dist: argparse>=1.4.0
+Requires-Dist: gdown>=5.2.1
+Requires-Dist: h5py>=3.16.0
+Requires-Dist: matplotlib>=3.10.8
+Requires-Dist: medmnist>=3.0.2
+Requires-Dist: numpy>=2.4.3
+Requires-Dist: optuna>=4.7.0
+Requires-Dist: pillow>=12.1.1
+Requires-Dist: ray[train,tune]>=2.54.0
+Requires-Dist: scikit-learn>=1.8.0
+Requires-Dist: skypilot[aws]>=0.11.2
+Requires-Dist: timm>=1.0.25
+Requires-Dist: torch==2.8.0
+Requires-Dist: webdataset>=1.0.2
+Description-Content-Type: text/markdown
+
+# krunic
+
+Automated hyperparameter search for image classifiers — from dataset to tuned model with one command.
+
+Built on [Ray Tune](https://docs.ray.io/en/latest/tune/index.html), [Optuna](https://optuna.org/), [timm](https://github.com/huggingface/pytorch-image-models), and [SkyPilot](https://skypilot.readthedocs.io/).
+
+## Install
+
+```bash
+pipx install krunic
+```
+
+This installs three commands: `tunic` (local training), `krunic` (cloud launcher), and `tunic-plotter` (results visualizer).
+
+## Quick start
+
+**Local:**
+```bash
+tunic --data /path/to/dataset --model resnet50 --n_trials 30 --epochs 30 --output results.json
+```
+
+**Cloud (AWS):**
+```bash
+krunic \
+  --cluster my-cluster \
+  --workdir ~/github/krunic \
+  --s3-path my-dataset \
+  --model resnet50 \
+  --accelerator T4:4 \
+  --num-nodes 4 \
+  --n-trials 48 \
+  --n-epochs 50 \
+  --prefix run1
+```
+
+**Train final model from tuning results:**
+```bash
+tunic --final results.json --data /path/to/dataset --epochs 50 --amp
+```
+
+**Plot results:**
+```bash
+tunic-plotter results.json
+```
+
+## Results on standard benchmarks
+
+| Dataset | Model | Val AUROC | Test AUROC | Notes |
+|---|---|---|---|---|
+| PCam (patch camelyon) | ResNet18 | 0.96 | 0.97 | SOTA is 0.96 |
+| TinyImageNet | ViT-Small | 0.87 (acc) | — | SOTA ~0.90 |
+| ChestMNIST | ResNet18 | 0.76 | 0.75 | 14-class multi-label |
+| TissueMNIST | ResNet18 | — | 0.94 | |
+
+All runs use generic off-the-shelf models with no domain-specific modifications.
+
+## Search space
+
+| Parameter | Range |
+|---|---|
+| Optimizer | AdamW, SGD |
+| Learning rate | 1e-5 – 1e-1 (log) |
+| Weight decay | 1e-6 – 1e-1 (log) |
+| Label smoothing | 0 – 0.3 |
+| Dropout rate | 0 – 0.5 |
+| RandAugment magnitude | 1 – 15 |
+| RandAugment num ops | 1 – 4 |
+| Mixup alpha | 0 – 0.5 |
+| CutMix alpha | 0 – 1.0 |
+
+Override any part with a YAML file via `--search-space`.
+
+## tunic — local hyperparameter search
+
+```
+tunic --data PATH --model MODEL [options]
+```
+
+| Flag | Default | Description |
+|---|---|---|
+| `--data` | required | Dataset root (ImageFolder or WebDataset) |
+| `--model` | required | Any timm model name |
+| `--n_trials` | 80 | Number of Optuna trials |
+| `--epochs` | 30 | Training epochs per trial (also used for `--final`) |
+| `--tune-metric` | `val_auroc` | Metric for trial selection and pruning |
+| `--training_fraction` | 1.0 | Fraction of training data (val always uses 1.0) |
+| `--batch-size` | 32 | Batch size per trial |
+| `--amp` | — | Enable automatic mixed precision |
+| `--ray-address` | local | Ray cluster address |
+| `--ray-storage` | local | Ray Tune storage path (local or S3 URI) |
+| `--resume` | — | Warm-start from a previous experiment directory |
+| `--final` | — | Skip tuning; train final model from results JSON |
+| `--combine` | — | Train final model on train+val combined |
+| `--final-model` | `tunic_final.pt` | Output path for final model weights |
+| `--final-stats` | — | Output path for final model stats (JSON) |
+| `--device` | `auto` | `auto`, `cuda`, `mps`, or `cpu` |
+| `--smoke-test` | — | Quick end-to-end test with synthetic data |
+
+## krunic — cloud launcher
+
+krunic generates a SkyPilot YAML and launches the job. The dataset is S3-mounted (or copied); results are uploaded to S3 when the job completes.
+
+**Prerequisites:** SkyPilot configured with AWS credentials; dataset in S3.
+
+`--workdir` defaults to the installed package directory (contains `tunic.py` and `requirements.txt`). Override it only if you are developing from a local source checkout and want to test unpublished changes.
+
+```
+krunic --cluster NAME --workdir DIR --s3-path PATH --model MODEL [options]
+```
+
+| Flag | Default | Description |
+|---|---|---|
+| `--cluster` | required | SkyPilot cluster name |
+| `--workdir` | package dir | Local directory synced to the cluster |
+| `--s3-path` | required | Dataset path within the S3 bucket |
+| `--model` | required | Any timm model name |
+| `--accelerator` | `T4:4` | GPU spec (e.g. `T4:4`, `A10G:1`, `A100:8`) |
+| `--num-nodes` | 1 | Number of cluster nodes |
+| `--n-trials` | 30 | Number of Optuna trials |
+| `--n-epochs` | 30 | Training epochs per trial |
+| `--batch-size` | 32 | Batch size per trial |
+| `--training-fraction` | 1.0 | Fraction of training data per trial |
+| `--tune-metric` | `val_auroc` | Metric for trial selection and pruning |
+| `--bucket` | `image.data` | S3 bucket name |
+| `--prefix` | `tunic` | Prefix for output files and S3 paths |
+| `--spot` | — | Use spot instances (with retry-until-up) |
+| `--copy` | — | Copy data from S3 to local disk instead of mounting |
+| `--idle-minutes` | 60 | Auto-stop cluster after N idle minutes |
+| `--no-autostop` | — | Disable auto-stop |
+
+Results are uploaded to `s3://<bucket>/ray-results/<prefix>/<prefix>_results.json`.
+
+## tunic-plotter — visualize results
+
+```bash
+tunic-plotter results.json                  # plots val_auroc and val_acc
+tunic-plotter results.json --metric val_acc # single metric
+tunic-plotter results.json --trial_sort     # keep original trial order, show running best
+```
+
+Saves PNG files alongside the results JSON.
+
+## Dataset format
+
+tunic auto-detects the dataset format:
+
+- **ImageFolder** — standard `split/class/image.ext` layout
+- **WebDataset** — sharded TAR files; detected when `wds/dataset_info.json` exists
+
+## Scaling
+
+Concurrent trials = total GPUs. `--num-nodes 4 --accelerator T4:4` = 16 concurrent trials.
+
+Optuna's TPE needs ~20 trials before it outperforms random search. 32–64 trials is a practical range for most problems.
+
+## Output format
+
+```json
+{
+  "model": "resnet18",
+  "best_val_auroc": 0.963,
+  "best_val_acc": 0.891,
+  "best_params": {
+    "optimizer": "AdamW",
+    "lr": 0.0028,
+    "weight_decay": 3.6e-06,
+    "label_smoothing": 0.058,
+    "drop_rate": 0.183
+  },
+  "n_trials": 48,
+  "completed_trials": 48,
+  "epochs": 50,
+  "all_trials": [...]
+}
+```

krunic-0.1.0/README.md

@@ -0,0 +1,175 @@
+# krunic
+
+Automated hyperparameter search for image classifiers — from dataset to tuned model with one command.
+
+Built on [Ray Tune](https://docs.ray.io/en/latest/tune/index.html), [Optuna](https://optuna.org/), [timm](https://github.com/huggingface/pytorch-image-models), and [SkyPilot](https://skypilot.readthedocs.io/).
+
+## Install
+
+```bash
+pipx install krunic
+```
+
+This installs three commands: `tunic` (local training), `krunic` (cloud launcher), and `tunic-plotter` (results visualizer).
+
+## Quick start
+
+**Local:**
+```bash
+tunic --data /path/to/dataset --model resnet50 --n_trials 30 --epochs 30 --output results.json
+```
+
+**Cloud (AWS):**
+```bash
+krunic \
+  --cluster my-cluster \
+  --workdir ~/github/krunic \
+  --s3-path my-dataset \
+  --model resnet50 \
+  --accelerator T4:4 \
+  --num-nodes 4 \
+  --n-trials 48 \
+  --n-epochs 50 \
+  --prefix run1
+```
+
+**Train final model from tuning results:**
+```bash
+tunic --final results.json --data /path/to/dataset --epochs 50 --amp
+```
+
+**Plot results:**
+```bash
+tunic-plotter results.json
+```
+
+## Results on standard benchmarks
+
+| Dataset | Model | Val AUROC | Test AUROC | Notes |
+|---|---|---|---|---|
+| PCam (patch camelyon) | ResNet18 | 0.96 | 0.97 | SOTA is 0.96 |
+| TinyImageNet | ViT-Small | 0.87 (acc) | — | SOTA ~0.90 |
+| ChestMNIST | ResNet18 | 0.76 | 0.75 | 14-class multi-label |
+| TissueMNIST | ResNet18 | — | 0.94 | |
+
+All runs use generic off-the-shelf models with no domain-specific modifications.
+
+## Search space
+
+| Parameter | Range |
+|---|---|
+| Optimizer | AdamW, SGD |
+| Learning rate | 1e-5 – 1e-1 (log) |
+| Weight decay | 1e-6 – 1e-1 (log) |
+| Label smoothing | 0 – 0.3 |
+| Dropout rate | 0 – 0.5 |
+| RandAugment magnitude | 1 – 15 |
+| RandAugment num ops | 1 – 4 |
+| Mixup alpha | 0 – 0.5 |
+| CutMix alpha | 0 – 1.0 |
+
+Override any part with a YAML file via `--search-space`.
+
+## tunic — local hyperparameter search
+
+```
+tunic --data PATH --model MODEL [options]
+```
+
+| Flag | Default | Description |
+|---|---|---|
+| `--data` | required | Dataset root (ImageFolder or WebDataset) |
+| `--model` | required | Any timm model name |
+| `--n_trials` | 80 | Number of Optuna trials |
+| `--epochs` | 30 | Training epochs per trial (also used for `--final`) |
+| `--tune-metric` | `val_auroc` | Metric for trial selection and pruning |
+| `--training_fraction` | 1.0 | Fraction of training data (val always uses 1.0) |
+| `--batch-size` | 32 | Batch size per trial |
+| `--amp` | — | Enable automatic mixed precision |
+| `--ray-address` | local | Ray cluster address |
+| `--ray-storage` | local | Ray Tune storage path (local or S3 URI) |
+| `--resume` | — | Warm-start from a previous experiment directory |
+| `--final` | — | Skip tuning; train final model from results JSON |
+| `--combine` | — | Train final model on train+val combined |
+| `--final-model` | `tunic_final.pt` | Output path for final model weights |
+| `--final-stats` | — | Output path for final model stats (JSON) |
+| `--device` | `auto` | `auto`, `cuda`, `mps`, or `cpu` |
+| `--smoke-test` | — | Quick end-to-end test with synthetic data |
+
+## krunic — cloud launcher
+
+krunic generates a SkyPilot YAML and launches the job. The dataset is S3-mounted (or copied); results are uploaded to S3 when the job completes.
+
+**Prerequisites:** SkyPilot configured with AWS credentials; dataset in S3.
+
+`--workdir` defaults to the installed package directory (contains `tunic.py` and `requirements.txt`). Override it only if you are developing from a local source checkout and want to test unpublished changes.
+
+```
+krunic --cluster NAME --workdir DIR --s3-path PATH --model MODEL [options]
+```
+
+| Flag | Default | Description |
+|---|---|---|
+| `--cluster` | required | SkyPilot cluster name |
+| `--workdir` | package dir | Local directory synced to the cluster |
+| `--s3-path` | required | Dataset path within the S3 bucket |
+| `--model` | required | Any timm model name |
+| `--accelerator` | `T4:4` | GPU spec (e.g. `T4:4`, `A10G:1`, `A100:8`) |
+| `--num-nodes` | 1 | Number of cluster nodes |
+| `--n-trials` | 30 | Number of Optuna trials |
+| `--n-epochs` | 30 | Training epochs per trial |
+| `--batch-size` | 32 | Batch size per trial |
+| `--training-fraction` | 1.0 | Fraction of training data per trial |
+| `--tune-metric` | `val_auroc` | Metric for trial selection and pruning |
+| `--bucket` | `image.data` | S3 bucket name |
+| `--prefix` | `tunic` | Prefix for output files and S3 paths |
+| `--spot` | — | Use spot instances (with retry-until-up) |
+| `--copy` | — | Copy data from S3 to local disk instead of mounting |
+| `--idle-minutes` | 60 | Auto-stop cluster after N idle minutes |
+| `--no-autostop` | — | Disable auto-stop |
+
+Results are uploaded to `s3://<bucket>/ray-results/<prefix>/<prefix>_results.json`.
+
+## tunic-plotter — visualize results
+
+```bash
+tunic-plotter results.json                  # plots val_auroc and val_acc
+tunic-plotter results.json --metric val_acc # single metric
+tunic-plotter results.json --trial_sort     # keep original trial order, show running best
+```
+
+Saves PNG files alongside the results JSON.
+
+## Dataset format
+
+tunic auto-detects the dataset format:
+
+- **ImageFolder** — standard `split/class/image.ext` layout
+- **WebDataset** — sharded TAR files; detected when `wds/dataset_info.json` exists
+
+## Scaling
+
+Concurrent trials = total GPUs. `--num-nodes 4 --accelerator T4:4` = 16 concurrent trials.
+
+Optuna's TPE needs ~20 trials before it outperforms random search. 32–64 trials is a practical range for most problems.
+
+## Output format
+
+```json
+{
+  "model": "resnet18",
+  "best_val_auroc": 0.963,
+  "best_val_acc": 0.891,
+  "best_params": {
+    "optimizer": "AdamW",
+    "lr": 0.0028,
+    "weight_decay": 3.6e-06,
+    "label_smoothing": 0.058,
+    "drop_rate": 0.183
+  },
+  "n_trials": 48,
+  "completed_trials": 48,
+  "epochs": 50,
+  "all_trials": [...]
+}
+```