cvic 0.1.0__tar.gz

cvic-0.1.0/.github/workflows/test.yml

@@ -0,0 +1,24 @@
+name: tests
+
+on:
+  push:
+  pull_request:
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: astral-sh/setup-uv@v5
+        with:
+          python-version: "3.12"
+
+      - name: Install (CPU torch)
+        run: |
+          uv venv .venv --python 3.12 --clear
+          uv pip install --python .venv/bin/python torch torchvision --index-url https://download.pytorch.org/whl/cpu
+          uv pip install --python .venv/bin/python -e ".[dev]"
+
+      - name: Run tests
+        run: .venv/bin/pytest tests/ -v -x -k "not test_smoke"

cvic-0.1.0/.gitignore

@@ -0,0 +1,212 @@
+# Tunic run artifacts
+ray_results/
+*.json
+*.pt
+
+# 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__/

cvic-0.1.0/.python-version

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

cvic-0.1.0/PKG-INFO

@@ -0,0 +1,155 @@
+Metadata-Version: 2.4
+Name: cvic
+Version: 0.1.0
+Summary: Local hyperparameter search and cross-validation for image classifiers using Ray Tune + timm
+Project-URL: Homepage, https://github.com/ljbuturovic/cvic
+Project-URL: Repository, https://github.com/ljbuturovic/cvic
+Author: Ljubomir Buturovic
+License: MIT
+Keywords: cross-validation,hyperparameter-tuning,image-classification,optuna,ray-tune,timm
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
+Requires-Python: >=3.12
+Requires-Dist: numpy>=2.4.3
+Requires-Dist: optuna>=4.7.0
+Requires-Dist: pillow>=12.1.1
+Requires-Dist: pyyaml>=6.0
+Requires-Dist: ray[train,tune]>=2.54.0
+Requires-Dist: scikit-learn>=1.8.0
+Requires-Dist: timm>=1.0.25
+Requires-Dist: torch>=2.0.0
+Requires-Dist: torchvision>=0.15.0
+Requires-Dist: tqdm>=4.66.0
+Requires-Dist: webdataset>=1.0.2
+Provides-Extra: dev
+Requires-Dist: pytest>=7.0; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# cvic
+
+[![tests](https://github.com/ljbuturovic/cvic/actions/workflows/test.yml/badge.svg)](https://github.com/ljbuturovic/cvic/actions/workflows/test.yml)
+![License](https://img.shields.io/badge/License-MIT-yellow.svg)
+
+Local, automated hyperparameter search for image classifiers — from dataset to tuned model with one command, distributed across your local GPUs.
+
+cvic uses off-the-shelf models and packages, so you won't get SOTA performance. But it can get surprisingly close, with almost zero effort. Useful as a baseline, or for experimentation with architectures and GPUs.
+
+Built on [Ray Tune](https://docs.ray.io/en/latest/tune/index.html), [Optuna](https://optuna.org/), and [timm](https://github.com/huggingface/pytorch-image-models). Requires Python ≥ 3.12.
+
+It ships two commands:
+
+- **`tunic`** — hold-out hyperparameter tuning (single train/validation split).
+- **`cvic`** — k-fold cross-validation hyperparameter search (for smaller datasets where a single split is noisy).
+
+> This is the local subset of [krunic](https://github.com/ljbuturovic/krunic). The cloud launcher (SkyPilot/AWS) lives in krunic; cvic runs entirely on your own machine.
+
+## Install
+
+```bash
+pipx install cvic
+```
+
+or with uv:
+
+```bash
+uv tool install cvic
+```
+
+## Quick start
+
+**Hold-out tuning:**
+```bash
+tunic --data /path/to/dataset --model resnet50 --n_trials 30 --epochs 30 --output results.json
+```
+
+**Cross-validation tuning:**
+```bash
+cvic --data /path/to/dataset --model resnet50 --n-trials 30 --epochs 30 --folds 5
+```
+
+**Train final model from tuning results:**
+```bash
+tunic --final results.json --data /path/to/dataset --epochs 50 --amp
+```
+
+**Smoke test (synthetic data, no dataset needed):**
+```bash
+tunic --smoke-test
+cvic --smoke-test
+```
+
+## Dataset format
+
+The dataset format is auto-detected:
+
+- **ImageFolder** — standard `split/class/image.ext` layout
+- **WebDataset** — sharded TAR files; detected when `wds/dataset_info.json` exists
+
+## tunic — hold-out 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 |
+| `--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 |
+| `--device` | `auto` | `auto`, `cuda`, `mps`, or `cpu` |
+| `--smoke-test` | | Quick end-to-end test with synthetic data |
+
+## cvic — cross-validation hyperparameter search
+
+```
+cvic --data PATH --model MODEL [options]
+```
+
+| Flag | Default | Description |
+|---|---|---|
+| `--data` | required | Dataset root (ImageFolder or WebDataset) |
+| `--model` | required | Any timm model name |
+| `--n-trials` | | Number of Optuna trials |
+| `--epochs` | | Training epochs per trial |
+| `--folds` | | Number of cross-validation folds |
+| `--repeats` | | Repeated cross-validation runs |
+| `--stratified` | | Use stratified folds |
+| `--tune-metric` | `val_auroc` | Metric for trial selection |
+| `--batch-size` | 32 | Batch size per trial |
+| `--test-data` | | Held-out test set for final evaluation |
+| `--amp` | | Enable automatic mixed precision |
+| `--device` | `auto` | `auto`, `cuda`, `mps`, or `cpu` |
+| `--smoke-test` | | Quick end-to-end test with synthetic data |
+
+Run `cvic --help` / `tunic --help` for the full list of flags.
+
+## 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`.
+
+## License
+
+MIT

cvic-0.1.0/README.md

@@ -0,0 +1,126 @@
+# cvic
+
+[![tests](https://github.com/ljbuturovic/cvic/actions/workflows/test.yml/badge.svg)](https://github.com/ljbuturovic/cvic/actions/workflows/test.yml)
+![License](https://img.shields.io/badge/License-MIT-yellow.svg)
+
+Local, automated hyperparameter search for image classifiers — from dataset to tuned model with one command, distributed across your local GPUs.
+
+cvic uses off-the-shelf models and packages, so you won't get SOTA performance. But it can get surprisingly close, with almost zero effort. Useful as a baseline, or for experimentation with architectures and GPUs.
+
+Built on [Ray Tune](https://docs.ray.io/en/latest/tune/index.html), [Optuna](https://optuna.org/), and [timm](https://github.com/huggingface/pytorch-image-models). Requires Python ≥ 3.12.
+
+It ships two commands:
+
+- **`tunic`** — hold-out hyperparameter tuning (single train/validation split).
+- **`cvic`** — k-fold cross-validation hyperparameter search (for smaller datasets where a single split is noisy).
+
+> This is the local subset of [krunic](https://github.com/ljbuturovic/krunic). The cloud launcher (SkyPilot/AWS) lives in krunic; cvic runs entirely on your own machine.
+
+## Install
+
+```bash
+pipx install cvic
+```
+
+or with uv:
+
+```bash
+uv tool install cvic
+```
+
+## Quick start
+
+**Hold-out tuning:**
+```bash
+tunic --data /path/to/dataset --model resnet50 --n_trials 30 --epochs 30 --output results.json
+```
+
+**Cross-validation tuning:**
+```bash
+cvic --data /path/to/dataset --model resnet50 --n-trials 30 --epochs 30 --folds 5
+```
+
+**Train final model from tuning results:**
+```bash
+tunic --final results.json --data /path/to/dataset --epochs 50 --amp
+```
+
+**Smoke test (synthetic data, no dataset needed):**
+```bash
+tunic --smoke-test
+cvic --smoke-test
+```
+
+## Dataset format
+
+The dataset format is auto-detected:
+
+- **ImageFolder** — standard `split/class/image.ext` layout
+- **WebDataset** — sharded TAR files; detected when `wds/dataset_info.json` exists
+
+## tunic — hold-out 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 |
+| `--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 |
+| `--device` | `auto` | `auto`, `cuda`, `mps`, or `cpu` |
+| `--smoke-test` | | Quick end-to-end test with synthetic data |
+
+## cvic — cross-validation hyperparameter search
+
+```
+cvic --data PATH --model MODEL [options]
+```
+
+| Flag | Default | Description |
+|---|---|---|
+| `--data` | required | Dataset root (ImageFolder or WebDataset) |
+| `--model` | required | Any timm model name |
+| `--n-trials` | | Number of Optuna trials |
+| `--epochs` | | Training epochs per trial |
+| `--folds` | | Number of cross-validation folds |
+| `--repeats` | | Repeated cross-validation runs |
+| `--stratified` | | Use stratified folds |
+| `--tune-metric` | `val_auroc` | Metric for trial selection |
+| `--batch-size` | 32 | Batch size per trial |
+| `--test-data` | | Held-out test set for final evaluation |
+| `--amp` | | Enable automatic mixed precision |
+| `--device` | `auto` | `auto`, `cuda`, `mps`, or `cpu` |
+| `--smoke-test` | | Quick end-to-end test with synthetic data |
+
+Run `cvic --help` / `tunic --help` for the full list of flags.
+
+## 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`.
+
+## License
+
+MIT