dataeval-flow 0.1.0__tar.gz → 0.1.2__tar.gz

{dataeval_flow-0.1.0 → dataeval_flow-0.1.2}/.gitignore

@@ -15,6 +15,9 @@ __pycache__/
 *.egg-info/
 dist/
 build/
+# hatch-vcs writes the runtime version file at build/install time;
+# source of truth is git tags. Do not commit.
+src/dataeval_flow/_version.py
 
 # Cache
 .pytest_cache/
@@ -31,6 +34,9 @@ output/
 # Generated notebooks (source of truth is MyST markdown)
 *.ipynb
 
+# Jupyter execution cache (stored in docs-artifacts/<branch> orphan branch instead)
+.jupyter_cache/
+
 # Nox
 .nox/
 .cuda-version

{dataeval_flow-0.1.0 → dataeval_flow-0.1.2}/PKG-INFO

@@ -1,13 +1,12 @@
 Metadata-Version: 2.4
 Name: dataeval-flow
-Version: 0.1.0
+Version: 0.1.2
 Summary: DataEval Workflows container for data evaluation
 Project-URL: Repository, https://gitlab.jatic.net/jatic/aria/dataeval-flow
 License-Expression: MIT
 License-File: LICENSE
 Classifier: Development Status :: 3 - Alpha
 Classifier: Intended Audience :: Science/Research
-Classifier: License :: OSI Approved :: MIT License
 Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
@@ -15,51 +14,42 @@ Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
 Classifier: Topic :: Scientific/Engineering
 Classifier: Typing :: Typed
-Requires-Python: <3.14,>=3.10
-Requires-Dist: dataeval==1.0.4
+Requires-Python: >=3.10
+Requires-Dist: dataeval==1.0.6
 Requires-Dist: datasets>=4.0.0
 Requires-Dist: maite-datasets>=0.0.12
+Requires-Dist: numpy>=1.24.2
 Requires-Dist: pydantic>=2.0
 Requires-Dist: pyyaml>=6.0
 Provides-Extra: all-cpu
 Requires-Dist: onnx>=1.15; extra == 'all-cpu'
 Requires-Dist: onnxruntime>=1.20; extra == 'all-cpu'
 Requires-Dist: opencv-python-headless>=4.8.0; extra == 'all-cpu'
-Requires-Dist: textual>=3.0; extra == 'all-cpu'
+Requires-Dist: textual>=3.0; (python_version < '3.14') and extra == 'all-cpu'
 Requires-Dist: torch>=2.2.0; extra == 'all-cpu'
 Requires-Dist: torchvision>=0.17.0; extra == 'all-cpu'
 Provides-Extra: all-cu118
 Requires-Dist: onnx>=1.15; extra == 'all-cu118'
 Requires-Dist: onnxruntime-gpu>=1.20; extra == 'all-cu118'
 Requires-Dist: opencv-python-headless>=4.8.0; extra == 'all-cu118'
-Requires-Dist: textual>=3.0; extra == 'all-cu118'
+Requires-Dist: textual>=3.0; (python_version < '3.14') and extra == 'all-cu118'
 Requires-Dist: torch>=2.2.0; extra == 'all-cu118'
 Requires-Dist: torchvision>=0.17.0; extra == 'all-cu118'
-Provides-Extra: all-cu124
-Requires-Dist: onnx>=1.15; extra == 'all-cu124'
-Requires-Dist: onnxruntime-gpu>=1.20; extra == 'all-cu124'
-Requires-Dist: opencv-python-headless>=4.8.0; extra == 'all-cu124'
-Requires-Dist: textual>=3.0; extra == 'all-cu124'
-Requires-Dist: torch>=2.2.0; extra == 'all-cu124'
-Requires-Dist: torchvision>=0.17.0; extra == 'all-cu124'
 Provides-Extra: all-cu128
 Requires-Dist: onnx>=1.15; extra == 'all-cu128'
 Requires-Dist: onnxruntime-gpu>=1.23.2; extra == 'all-cu128'
 Requires-Dist: opencv-python-headless>=4.8.0; extra == 'all-cu128'
-Requires-Dist: textual>=3.0; extra == 'all-cu128'
+Requires-Dist: textual>=3.0; (python_version < '3.14') and extra == 'all-cu128'
 Requires-Dist: torch>=2.2.0; extra == 'all-cu128'
 Requires-Dist: torchvision>=0.17.0; extra == 'all-cu128'
 Provides-Extra: app
-Requires-Dist: textual>=3.0; extra == 'app'
+Requires-Dist: textual>=3.0; (python_version < '3.14') and extra == 'app'
 Provides-Extra: cpu
 Requires-Dist: torch>=2.2.0; extra == 'cpu'
 Requires-Dist: torchvision>=0.17.0; extra == 'cpu'
 Provides-Extra: cu118
 Requires-Dist: torch>=2.2.0; extra == 'cu118'
 Requires-Dist: torchvision>=0.17.0; extra == 'cu118'
-Provides-Extra: cu124
-Requires-Dist: torch>=2.2.0; extra == 'cu124'
-Requires-Dist: torchvision>=0.17.0; extra == 'cu124'
 Provides-Extra: cu128
 Requires-Dist: torch>=2.2.0; extra == 'cu128'
 Requires-Dist: torchvision>=0.17.0; extra == 'cu128'
@@ -77,6 +67,19 @@ Description-Content-Type: text/markdown
 
 Workflow orchestration for DataEval with GPU support.
 
+## Target Audience
+
+<!-- start JATIC interop -->
+
+DataEval Flow is intended for data scientists, ML engineers, and T&E engineers
+who want to run automated data-evaluation pipelines — outlier and duplicate
+detection, drift and OOD monitoring, dataset splitting, prioritization, and
+statistical analysis — against their image datasets and models. For users of
+the JATIC product suite, DataEval Flow has native interoperability when using
+MAITE-compliant datasets and models.
+
+<!-- end JATIC interop -->
+
 ## Quick Start
 
 ```bash
@@ -93,6 +96,32 @@ docker run --gpus all \
   dataeval:cu118
 ```
 
+## Pulling pre-built images
+
+Pre-built, cosign-signed images are published to Harbor for every merge to `main` and every release tag. Pull one of these instead of building from source if you don't need to modify the code.
+
+**Rolling channel** — tracks the latest commit on `main`. The tag is overwritten on every merge.
+
+```bash
+docker pull harbor.jatic.net/aria/dataeval:cu118   # cpu / cu118 / cu128
+```
+
+**Pinned release channel** — immutable, version-tagged images cut from `v*` git tags. Use these for reproducible workloads.
+
+```bash
+docker pull harbor.jatic.net/aria/dataeval:0.1.0-cu118
+```
+
+**Verifying the signature** — every published image is signed with [cosign](https://docs.sigstore.dev/cosign/). The public key is committed at [docker/cosign.pub](docker/cosign.pub).
+
+```bash
+cosign verify --key docker/cosign.pub harbor.jatic.net/aria/dataeval:cu118
+```
+
+Then drop the `dataeval:cu118` reference in the Quick Start `docker run` commands above with the fully-qualified `harbor.jatic.net/aria/dataeval:cu118` (or pinned version) and skip step 1.
+
+> **Note on feature branches.** Containers are only built and published from `main` and release tags — no image is produced for MRs or topic branches. If you want to run a feature branch as a container, check it out and follow the Quick Start to build locally; the resulting image will pick up the branch's version via `git describe`.
+
 ## Requirements
 
 | Requirement | Version |
@@ -253,7 +282,7 @@ Configs can be saved as YAML or JSON.
 
 The Docker build may appear frozen during the `uv sync` step:
 
-```
+```text
 => [builder 7/7] RUN uv sync --frozen --no-dev --no-install-project    1139.3s
 ```
 
@@ -272,19 +301,68 @@ The Docker build may appear frozen during the `uv sync` step:
 The `dataeval_flow` package can be used standalone without Docker.
 
 **Installation:**
+
+Three installer toolchains are supported. Choose whichever fits your environment;
+all three install the same dependencies pinned in their respective lockfiles.
+
+`uv` (default toolchain):
+
 ```bash
 git clone https://gitlab.jatic.net/jatic/aria/dataeval-flow.git
 cd dataeval-flow
-uv sync
+uv sync --extra cpu      # or cu118 / cu128 for CUDA variants
 ```
 
+`pip` from PyPI (no source checkout). PyTorch is hosted on a separate
+wheel index, so pass `--extra-index-url` matching the variant you want
+(omit it and you'll get the CUDA-bundled manylinux build of torch from
+PyPI, which is much larger):
+
+```bash
+# CPU-only PyTorch
+pip install "dataeval-flow[cpu]" --extra-index-url https://download.pytorch.org/whl/cpu
+
+# CUDA 11.8 PyTorch
+pip install "dataeval-flow[cu118]" --extra-index-url https://download.pytorch.org/whl/cu118
+
+# CUDA 12.8 PyTorch
+pip install "dataeval-flow[cu128]" --extra-index-url https://download.pytorch.org/whl/cu128
+```
+
+`poetry` (source checkout; uses committed `poetry.lock`):
+
+```bash
+git clone https://gitlab.jatic.net/jatic/aria/dataeval-flow.git
+cd dataeval-flow
+poetry install
+```
+
+`conda` / `mamba` (source checkout; uses committed `environment.yml`):
+
+```bash
+git clone https://gitlab.jatic.net/jatic/aria/dataeval-flow.git
+cd dataeval-flow
+conda env create -f environment.yml
+conda activate dataeval-flow
+pip install -e .         # install the package itself; conda manages deps
+```
+
+Notes:
+
+- PyTorch is installed from PyPI/`download.pytorch.org` in every path
+  (it is no longer maintained on conda-forge).
+- GPU variants (`cu118`, `cu128`) are only wired through `uv` and
+  `pip` today; the Poetry/conda paths install the CPU build of PyTorch.
+
 **CLI Usage:**
+
 ```bash
 python -m dataeval_flow --config /path/to/config --output /path/to/output
 python -m dataeval_flow --data /path/to/data --output /path/to/output
 ```
 
 **Python API Usage:**
+
 ```python
 from pathlib import Path
 from dataeval_flow import load_config, run_tasks
@@ -295,11 +373,51 @@ print(results[0].report())
 ```
 
 **Development:**
+
 ```bash
 uv sync --group dev
 nox
 ```
 
+## Versioning
+
+The package version is **derived from git tags** — there is no hardcoded version anywhere in the source tree. `hatch-vcs` reads `git describe --tags` at build/install time and writes the resolved version to a generated `src/dataeval_flow/_version.py` (gitignored), which `dataeval_flow.__init__` imports at runtime.
+
+**Release flow for container images:**
+
+1. Push a semver tag (e.g. `v0.2.0`) — this is the single source of truth for the release version.
+2. The `push:docker` CI job runs `git describe --tags --always --dirty | sed 's/^v//'` to resolve `${VERSION}`, then passes `--build-arg DATAEVAL_FLOW_VERSION="${VERSION}"` to `docker buildx build` for both the `test` and `prod` stages.
+3. The `prod` stage in [docker/Dockerfile.j2](docker/Dockerfile.j2) redeclares the ARG and:
+   - Bakes the resolved version into `/app/src/dataeval_flow/_version.py` so `dataeval_flow.__version__` matches the wheel version at runtime.
+   - Stamps the OCI `org.opencontainers.image.version` label with the same value.
+4. The image is pushed to Harbor and cosign-signed.
+
+The `ARG DATAEVAL_FLOW_VERSION="…"` default rendered into each committed `docker/Dockerfile.<variant>` by `docker/generate.py` is only used for **local** `docker build` invocations that don't pass `--build-arg`. Release builds always override it, so the committed default is allowed to drift from the latest tag and does not need to be regenerated at release time.
+
 ## License
 
-MIT
+MIT — see [LICENSE](LICENSE).
+
+## Contributing
+
+See [CONTRIBUTING.md](CONTRIBUTING.md) for bug reports and contribution
+guidelines, and [BRANCHING.md](BRANCHING.md) for the branching and release
+strategy.
+
+## Contact
+
+For questions or feedback, reach out to <dataeval-flow@ariacoustics.com>.
+
+## Acknowledgement
+
+### CDAO Funding Acknowledgement
+
+<!-- start acknowledgement -->
+
+This material is based upon work supported by the Chief Digital and Artificial
+Intelligence Office under Contract No. W519TC-23-9-2033. The views and
+conclusions contained herein are those of the author(s) and should not be
+interpreted as necessarily representing the official policies or endorsements,
+either expressed or implied, of the U.S. Government.
+
+<!-- end acknowledgement -->

{dataeval_flow-0.1.0 → dataeval_flow-0.1.2}/README.md

@@ -2,6 +2,19 @@
 
 Workflow orchestration for DataEval with GPU support.
 
+## Target Audience
+
+<!-- start JATIC interop -->
+
+DataEval Flow is intended for data scientists, ML engineers, and T&E engineers
+who want to run automated data-evaluation pipelines — outlier and duplicate
+detection, drift and OOD monitoring, dataset splitting, prioritization, and
+statistical analysis — against their image datasets and models. For users of
+the JATIC product suite, DataEval Flow has native interoperability when using
+MAITE-compliant datasets and models.
+
+<!-- end JATIC interop -->
+
 ## Quick Start
 
 ```bash
@@ -18,6 +31,32 @@ docker run --gpus all \
   dataeval:cu118
 ```
 
+## Pulling pre-built images
+
+Pre-built, cosign-signed images are published to Harbor for every merge to `main` and every release tag. Pull one of these instead of building from source if you don't need to modify the code.
+
+**Rolling channel** — tracks the latest commit on `main`. The tag is overwritten on every merge.
+
+```bash
+docker pull harbor.jatic.net/aria/dataeval:cu118   # cpu / cu118 / cu128
+```
+
+**Pinned release channel** — immutable, version-tagged images cut from `v*` git tags. Use these for reproducible workloads.
+
+```bash
+docker pull harbor.jatic.net/aria/dataeval:0.1.0-cu118
+```
+
+**Verifying the signature** — every published image is signed with [cosign](https://docs.sigstore.dev/cosign/). The public key is committed at [docker/cosign.pub](docker/cosign.pub).
+
+```bash
+cosign verify --key docker/cosign.pub harbor.jatic.net/aria/dataeval:cu118
+```
+
+Then drop the `dataeval:cu118` reference in the Quick Start `docker run` commands above with the fully-qualified `harbor.jatic.net/aria/dataeval:cu118` (or pinned version) and skip step 1.
+
+> **Note on feature branches.** Containers are only built and published from `main` and release tags — no image is produced for MRs or topic branches. If you want to run a feature branch as a container, check it out and follow the Quick Start to build locally; the resulting image will pick up the branch's version via `git describe`.
+
 ## Requirements
 
 | Requirement | Version |
@@ -178,7 +217,7 @@ Configs can be saved as YAML or JSON.
 
 The Docker build may appear frozen during the `uv sync` step:
 
-```
+```text
 => [builder 7/7] RUN uv sync --frozen --no-dev --no-install-project    1139.3s
 ```
 
@@ -197,19 +236,68 @@ The Docker build may appear frozen during the `uv sync` step:
 The `dataeval_flow` package can be used standalone without Docker.
 
 **Installation:**
+
+Three installer toolchains are supported. Choose whichever fits your environment;
+all three install the same dependencies pinned in their respective lockfiles.
+
+`uv` (default toolchain):
+
 ```bash
 git clone https://gitlab.jatic.net/jatic/aria/dataeval-flow.git
 cd dataeval-flow
-uv sync
+uv sync --extra cpu      # or cu118 / cu128 for CUDA variants
 ```
 
+`pip` from PyPI (no source checkout). PyTorch is hosted on a separate
+wheel index, so pass `--extra-index-url` matching the variant you want
+(omit it and you'll get the CUDA-bundled manylinux build of torch from
+PyPI, which is much larger):
+
+```bash
+# CPU-only PyTorch
+pip install "dataeval-flow[cpu]" --extra-index-url https://download.pytorch.org/whl/cpu
+
+# CUDA 11.8 PyTorch
+pip install "dataeval-flow[cu118]" --extra-index-url https://download.pytorch.org/whl/cu118
+
+# CUDA 12.8 PyTorch
+pip install "dataeval-flow[cu128]" --extra-index-url https://download.pytorch.org/whl/cu128
+```
+
+`poetry` (source checkout; uses committed `poetry.lock`):
+
+```bash
+git clone https://gitlab.jatic.net/jatic/aria/dataeval-flow.git
+cd dataeval-flow
+poetry install
+```
+
+`conda` / `mamba` (source checkout; uses committed `environment.yml`):
+
+```bash
+git clone https://gitlab.jatic.net/jatic/aria/dataeval-flow.git
+cd dataeval-flow
+conda env create -f environment.yml
+conda activate dataeval-flow
+pip install -e .         # install the package itself; conda manages deps
+```
+
+Notes:
+
+- PyTorch is installed from PyPI/`download.pytorch.org` in every path
+  (it is no longer maintained on conda-forge).
+- GPU variants (`cu118`, `cu128`) are only wired through `uv` and
+  `pip` today; the Poetry/conda paths install the CPU build of PyTorch.
+
 **CLI Usage:**
+
 ```bash
 python -m dataeval_flow --config /path/to/config --output /path/to/output
 python -m dataeval_flow --data /path/to/data --output /path/to/output
 ```
 
 **Python API Usage:**
+
 ```python
 from pathlib import Path
 from dataeval_flow import load_config, run_tasks
@@ -220,11 +308,51 @@ print(results[0].report())
 ```
 
 **Development:**
+
 ```bash
 uv sync --group dev
 nox
 ```
 
+## Versioning
+
+The package version is **derived from git tags** — there is no hardcoded version anywhere in the source tree. `hatch-vcs` reads `git describe --tags` at build/install time and writes the resolved version to a generated `src/dataeval_flow/_version.py` (gitignored), which `dataeval_flow.__init__` imports at runtime.
+
+**Release flow for container images:**
+
+1. Push a semver tag (e.g. `v0.2.0`) — this is the single source of truth for the release version.
+2. The `push:docker` CI job runs `git describe --tags --always --dirty | sed 's/^v//'` to resolve `${VERSION}`, then passes `--build-arg DATAEVAL_FLOW_VERSION="${VERSION}"` to `docker buildx build` for both the `test` and `prod` stages.
+3. The `prod` stage in [docker/Dockerfile.j2](docker/Dockerfile.j2) redeclares the ARG and:
+   - Bakes the resolved version into `/app/src/dataeval_flow/_version.py` so `dataeval_flow.__version__` matches the wheel version at runtime.
+   - Stamps the OCI `org.opencontainers.image.version` label with the same value.
+4. The image is pushed to Harbor and cosign-signed.
+
+The `ARG DATAEVAL_FLOW_VERSION="…"` default rendered into each committed `docker/Dockerfile.<variant>` by `docker/generate.py` is only used for **local** `docker build` invocations that don't pass `--build-arg`. Release builds always override it, so the committed default is allowed to drift from the latest tag and does not need to be regenerated at release time.
+
 ## License
 
-MIT
+MIT — see [LICENSE](LICENSE).
+
+## Contributing
+
+See [CONTRIBUTING.md](CONTRIBUTING.md) for bug reports and contribution
+guidelines, and [BRANCHING.md](BRANCHING.md) for the branching and release
+strategy.
+
+## Contact
+
+For questions or feedback, reach out to <dataeval-flow@ariacoustics.com>.
+
+## Acknowledgement
+
+### CDAO Funding Acknowledgement
+
+<!-- start acknowledgement -->
+
+This material is based upon work supported by the Chief Digital and Artificial
+Intelligence Office under Contract No. W519TC-23-9-2033. The views and
+conclusions contained herein are those of the author(s) and should not be
+interpreted as necessarily representing the official policies or endorsements,
+either expressed or implied, of the U.S. Government.
+
+<!-- end acknowledgement -->