Skip to main content

Ayase

Modular media quality metrics for video, image, and audio datasets.

Work in progress - APIs and module interfaces may change before 1.0.

What It Does

Ayase runs quality assessment modules over a dataset and writes structured per-sample metrics. 375 modules produce 511 metrics across 21 categories (NR-IQA, FR-IQA, NR-VQA, temporal, motion, audio, face, safety, aesthetics, text-video alignment, and more). Modules are independent - pick only what you need.

Full metric catalog: METRICS.md. Pretrained model catalog: MODELS.md.

Install

pip install ayase

Ayase is distributed as a single install. Runtime dependencies are managed by the project itself, and model weights are downloaded and cached on first use.

Isolated installation

Applications that already have their own PyTorch, NumPy, or media dependency constraints can keep Ayase completely outside their environment:

pip install ayase --no-deps
from ayase_client import AyasePipeline

pipeline = AyasePipeline(modules=["basic", "metadata", "motion"])
results = pipeline.run("./my_dataset")
pipeline.export("report.json")
pipeline.close()

This installs the same Ayase wheel without ML dependencies. On first use the client creates a private full-runtime venv and starts a loopback worker. Media is passed by local path. Regular pip install ayase remains unchanged.

Optional check: ayase-client doctor. To use an existing runtime, set AYASE_RUNTIME_PYTHON.

CLI

ayase scan ./dataset                                    # default balanced pipeline
ayase scan ./dataset --deep                             # run every discovered module
ayase scan ./dataset --modules metadata,basic_quality   # selected modules
ayase help                                              # list every metric and provider
ayase help rqvqa_score                                  # metric/module models, config, and usage
ayase modules list                                      # show all 375 modules
ayase modules check                                     # import/dependency readiness
ayase filter ./dataset --min-score 70 --output ./good   # filter by quality
ayase stats ./dataset                                   # dataset statistics for images/video
ayase tui                                               # terminal UI

Python API

from ayase import AyasePipeline

pipeline = AyasePipeline(modules=["basic", "metadata", "motion"])
results = pipeline.run("./my_dataset")

for path, sample in results.items():
    qm = sample.quality_metrics
    if qm:
        print(f"{sample.path.name}: technical={qm.technical_score} blur={qm.blur_score}")

pipeline.export("report.json")   # also: report.csv, report.html

Configuration

ayase.toml in project root:

[general]
parallel_jobs = 8  # concurrency hint passed to capable modules/backends

[pipeline]
modules = ["metadata", "basic_quality", "motion"]

[output]
default_format = "json"
artifacts_dir = "reports"

Custom Modules

from ayase.models import QualityMetrics, Sample, ValidationIssue, ValidationSeverity
from ayase.pipeline import PipelineModule
import cv2

class BlurCheck(PipelineModule):
    name = "blur_check"
    description = "Flag blurry frames via Laplacian variance"
    default_config = {"threshold": 100.0}

    def process(self, sample: Sample) -> Sample:
        img = cv2.imread(str(sample.path), cv2.IMREAD_GRAYSCALE)
        if img is None:
            return sample
        score = float(cv2.Laplacian(img, cv2.CV_64F).var())
        if sample.quality_metrics is None:
            sample.quality_metrics = QualityMetrics()
        sample.quality_metrics.blur_score = score
        if score < self.config.get("threshold", 100.0):
            sample.validation_issues.append(
                ValidationIssue(
                    severity=ValidationSeverity.WARNING,
                    message=f"Blurry ({score:.0f})",
                )
            )
        return sample

Modules auto-register via __init_subclass__. Config is available as self.config.

Development

git clone <repo-url> && cd ayase
pip install -e ".[dev]"
pytest                    # 8000+ tests, ~4 min
pytest tests/ --full      # with ML model loading

License

Ayase's own code is MIT. Model weights downloaded at runtime carry their own licenses - see MODELS.md.

Some metrics run research code vendored under ayase/vendor (see the inventory), and four of those components are not permissive. Running one of these metrics places its component's licence on your use of the result, whatever Ayase's own licence says. Each affected module declares what it runs and logs a notice at setup:

Metric Vendored component Licence
chronomagic, dynamics_controllability, physics, video_edit_motion_fidelity, vmbench_pas, vmbench_tcs CoTracker CC BY-NC 4.0 - non-commercial only
mj_video MJ-Video no licence file upstream - no grant is stated
vbench2 VBench 2.0 with its vendored YOLO-World and CoTracker Apache-2.0, plus GPL-3.0 and CC BY-NC 4.0 inside

Every other vendored component is MIT, BSD or Apache-2.0 and imposes nothing beyond attribution, which the retained licence files provide.

This is a disclosure, not a resolution. The plan for 1.0 is to replace these components with implementations Ayase can license itself, so that the whole distribution is MIT in substance and not only in name.

Release files for ayase 0.1.76

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for ayase 0.1.76
File Size Uploaded
ayase-0.1.76.tar.gz 13.3 MB Details

Built distribution (wheel)

Table of built distributions (wheels) for ayase 0.1.76
File Interpreter ABI Platform
ayase-0.1.76-py3-none-any.whl Python 3 none any Details

Total release size: 29.0 MB

Release files / ayase-0.1.76.tar.gz

Download URL ayase-0.1.76.tar.gz
Size 13.3 MB
Tags Source
SHA-256 checksum
How to use checksums
92023ef2df4363301055c3322e6972602a8ef17cb563e0239408f0b66b635740
BLAKE2b-256 checksum
How to use checksums
e947430dd7f458a0eda5e4dfa4c31fbe7e8aa6b916ce65aeadada35cad427622
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.10.11

Release files / ayase-0.1.76-py3-none-any.whl

Download URL ayase-0.1.76-py3-none-any.whl
Size 15.7 MB
Tags Python 3
SHA-256 checksum
How to use checksums
3e90c79b5a999269b0dd7496815fddafda93a36fce592d06f475cf5c51d8a914
BLAKE2b-256 checksum
How to use checksums
91bb3416c9d1ff7499b878803273662b51198f408e1c90cbf6fedb5ace5ba6ce
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.10.11

Release history Release notifications | RSS feed

0.1.79

2 release files

0.1.78

2 release files

0.1.77

2 release files

This release

0.1.76 This release

2 release files

0.1.73

2 release files

0.1.72

2 release files

0.1.71

2 release files

0.1.70

2 release files

0.1.69

2 release files

0.1.68

2 release files

0.1.67

2 release files

0.1.66

2 release files

0.1.65

2 release files

0.1.64

1 release file

0.1.63

2 release files

0.1.62

2 release files

0.1.61

2 release files

0.1.55

2 release files

0.1.54

2 release files

0.1.53

1 release file

0.1.52

1 release file

0.1.51

1 release file

0.1.50

1 release file

0.1.49

2 release files

0.1.45

2 release files

0.1.44

2 release files

0.1.43

2 release files

0.1.42

2 release files

0.1.41

2 release files

0.1.40

2 release files

0.1.39

2 release files

0.1.38

2 release files

0.1.37

2 release files

0.1.36

2 release files

0.1.35

2 release files

0.1.34

2 release files

0.1.33

2 release files

0.1.32

2 release files

0.1.31

2 release files

0.1.30

2 release files

0.1.29

2 release files

0.1.26

2 release files

0.1.25

2 release files

0.1.24

2 release files

0.1.23

2 release files

0.1.22

2 release files

0.1.21

2 release files

0.1.20

2 release files

0.1.19

2 release files

0.1.18

2 release files

0.1.17

2 release files

0.1.16

2 release files

0.1.15

2 release files

0.1.14

2 release files

0.1.13

2 release files

0.1.12

2 release files

0.1.11

2 release files

0.1.10

2 release files

0.1.9

2 release files

0.1.8

2 release files

0.1.7

2 release files

0.1.6

2 release files

0.1.5

2 release files

0.1.4

2 release files

0.1.3

2 release files

0.1.2

2 release files

0.1.1

2 release files

0.1.0

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page