Skip to main content

QSARCert

CI PyPI version Python versions License: MIT DOI

Numerical checks of OECD validation principles 3 and 4 for QSAR and molecular machine-learning regression models: applicability domain, external predictivity, Y-randomization and train/test leakage.


Overview

QSARCert is an open-source package that computes the numerical checks of OECD validation principles 3 (applicability domain) and 4 (goodness-of-fit, robustness, predictivity) for regression QSAR/QSPR and machine-learning models, and reports for each check whether it passes, warns, fails or is not applicable to the model given. Principles 1, 2 and 5 (endpoint, algorithm, mechanistic interpretation) are documentation requirements that no software can verify.

Version 1.2.0 was validated on 180 real models (MLR, ridge regression and random forests on ESOL, FreeSolv and Lipophilicity, random and scaffold splits); see validation/ and the CHANGELOG for the defects this exposed in 1.1.0.

What it computes:

  • Applicability domain (Principle 3): leverage $h = x(X^TX)^{+}x^T$ of each evaluated compound on the standardised training design, warning leverage $h^* = 3p'/n$ ($p'$ = rank of the design, i.e. $p+1$ for non-collinear descriptors), Williams plot. Membership is decided by leverage alone; residuals, standardised with the training residual scale, only label response outliers. The check is not applicable when $h^* \ge 1$ (e.g. fingerprints with more bits than compounds).
  • External predictivity (Principle 4): $Q^2_{F1}$, $Q^2_{F2}$, $Q^2_{F3}$ (Consonni et al. 2009), CCC (Lin 1989), RMSE, MAE; Golbraikh–Tropsha criteria with the squared Pearson correlation and regressions through the origin; Roy's $r_m^2$ and $\Delta r_m^2$.
  • Y-randomization (Principle 4): $cR^2_p = R\sqrt{R^2 - \bar R_r^2}$ with 100 permutations. By default an OLS surrogate on the model's descriptors (expected chance $R^2 = p/(n-1)$; not applicable when that exceeds 0.5); pass the model as estimator to refit it and use 5-fold cross-validated $R^2$.
  • Train/test leakage: identical input vectors; Tanimoto nearest neighbours for binary fingerprints; duplicate structures and shared Bemis–Murcko scaffolds when SMILES are given.
  • 📑 Publication Deliverables:
    • Interactive self-contained report.html dashboard.
    • Publication vector plots (Williams Plot, Observed vs Predicted scatter, Y-scrambling histogram) in SVG, PDF, PNG (300 DPI).
    • Ready-to-compile LaTeX summary tables (.tex).
    • Draft Methods paragraph that reports the actual results (including failed checks) and BibTeX citation (citation.bib).
    Predictions CSV / Feature Matrices (Train & Test)
                           │
                           ▼
  ┌───────────────────────────────────────────────────────────┐
  │                         QSARCert                          │
  │  ├── Applicability Domain & Williams Plot (h* = 3(p+1)/n) │
  │  ├── Tropsha-Golbraikh & Roy r_m^2 Statistical Metrics    │
  │  ├── Y-Randomization Scrambling Engine (cR^2_p > 0.50)    │
  │  └── Train/Test Scaffold Data Leakage Detection           │
  └───────────────────────────────────────────────────────────┘
                           │
                           ▼
  ┌───────────────────────────────────────────────────────────┐
  │                   Publication Deliverables                │
  │  ├── report.html (Interactive Dashboard & Badges)         │
  │  ├── qsarcert_williams_plot.pdf/svg/png                   │
  │  ├── qsarcert_observed_vs_predicted.pdf/svg/png           │
  │  ├── qsarcert_y_randomization.pdf/svg/png                 │
  │  ├── qsarcert_summary_table.tex / .csv                    │
  │  ├── methods_snippet.txt (Ready for Manuscript)           │
  │  └── citation.bib (BibTeX Reference)                      │
  └───────────────────────────────────────────────────────────┘

Installation

From PyPI

Note: PyPI release pending. Until then, install from the tagged GitHub release:

pip install "git+https://github.com/sircalch/qsarcert@v1.2.0"

From Source

git clone https://github.com/sircalch/qsarcert.git
cd qsarcert
pip install -e .[dev]

Quickstart (CLI)

1. Run the demo (synthetic data)

qsarcert demo -o my_qsar_audit/

Open my_qsar_audit/report.html in any browser to inspect the interactive report!

2. Assess Predictions CSV

qsarcert assess -i predictions.csv -o qsar_report/

predictions.csv has columns y_true, y_pred, split (train/test), optionally smiles, and one column per descriptor. The training rows are needed for $Q^2_{F1}$, $Q^2_{F3}$, the residual scale and Y-randomization.


Python API Usage

from qsarcert import assess_qsar_quality
from qsarcert.parsers import parse_predictions_csv
from qsarcert.reporters import generate_qsar_figures, generate_qsar_manuscript_assets, generate_qsar_html_report

# 1. Parse prediction results
data = parse_predictions_csv("qsar_predictions.csv")

# 2. Assess OECD principles and applicability domain
report = assess_qsar_quality(
    metadata={"endpoint": "pIC50", "algorithm": "Random Forest"},
    y_true=data["y_eval"],
    y_pred=data["y_eval_pred"],
    x_train=data["x_train"],
    x_eval=data["x_eval"],
    y_train=data["y_train"],
    y_train_pred=data["y_train_pred"],
    smiles_train=data["smiles_train"],
    smiles_eval=data["smiles_eval"],
    estimator=None,  # or your fitted scikit-learn model, refitted in Y-randomization
    n_scrambling_iterations=100
)

print(f"Overall status: {report.overall_status}")
print(f"Predictivity: Q^2_F1 = {report.oecd_metrics.q2_f1:.3f}, CCC = {report.oecd_metrics.ccc:.3f}")
print(f"Applicability domain: {report.applicability_domain.status}, {report.applicability_domain.pct_in_domain:.1f}% inside (h* = {report.applicability_domain.warning_leverage:.3f})")
print(f"Y-randomization: {report.y_randomization.status}, cR^2_p = {report.y_randomization.cr2_p:.3f}")

# 3. Export all publication assets
generate_qsar_figures(report, "output_dir/", y_true=data["y_eval"], y_pred=data["y_eval_pred"])
generate_qsar_manuscript_assets(report, "output_dir/")
generate_qsar_html_report(report, "output_dir/report.html")

Citation

If you use QSARCert in your research, please cite:

@software{monreal2026qsarcert,
  author = {Monreal-Hern{\'a}ndez, Andre},
  title = {{QSARCert: An Open-Source Toolkit for OECD Validation Principles, Applicability Domain Assessment, Y-Randomization, and Reproducibility Certification of QSAR and Molecular Machine Learning Models}},
  year = {2026},
  version = {1.2.0},
  publisher = {Zenodo},
  url = {https://github.com/sircalch/qsarcert}
}

License

This project is licensed under the MIT License - see the LICENSE file for details.

Metadata

Release files for qsarcert 1.2.0

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

Source distribution (sdist)

Source distribution for qsarcert 1.2.0
File Size Uploaded Provenance
qsarcert-1.2.0.tar.gz 35.2 kB With provenance Details

Built distribution (wheel)

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

Total release size: 70.3 kB

Release files / qsarcert-1.2.0.tar.gz

Download URL qsarcert-1.2.0.tar.gz
Size 35.2 kB
Tags Source
SHA-256 checksum
How to use checksums
f232e646c0d939625e28a0b10b15e3699ea4426f13052efa264aae41babecbf6
BLAKE2b-256 checksum
How to use checksums
5b13fb2a784a1096e6f296b928ce35ca8191292fd0a8eacca09f93258acc9911
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.14

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Sep 30, 2026.

Transparency log

Release files / qsarcert-1.2.0-py3-none-any.whl

Download URL qsarcert-1.2.0-py3-none-any.whl
Size 35.1 kB
Tags Python 3
SHA-256 checksum
How to use checksums
477e3ba433ff238058fe213edc92f2f7ea7a1a4de3ae3dc7ffb7bee8f11ccb44
BLAKE2b-256 checksum
How to use checksums
f01072e0f33b3c4d967604714771e816b83eab363efbf0be1106b0f914d8cf91
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.14

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Sep 30, 2026.

Transparency log

Security for qsarcert 1.2.0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

Full provenance

All 2 files in this release have been uploaded with provenance metadata.

Select from 2 files

Attestation for qsarcert-1.2.0.tar.gz

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Sep 30, 2026.

Transparency log

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

1.2.0 This release

2 release files Full provenance

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