Conversation
Bumps [github/codeql-action](https://github.com/github/codeql-action) from 3 to 4. - [Release notes](https://github.com/github/codeql-action/releases) - [Changelog](https://github.com/github/codeql-action/blob/main/CHANGELOG.md) - [Commits](github/codeql-action@v3...v4) --- updated-dependencies: - dependency-name: github/codeql-action dependency-version: '4' dependency-type: direct:production update-type: version-update:semver-major ... Signed-off-by: dependabot[bot] <support@github.com>
…/github/codeql-action-4 chore(deps): bump github/codeql-action from 3 to 4
There was a problem hiding this comment.
Pull request overview
Release PR for Jabberjay 0.0.7, merging develop into main with updated release metadata, documentation/citation support, small runtime fixes, and expanded tests.
Changes:
- Adds citation metadata (
CITATION.cff) and expands README/docs with citation + support/funding info. - Fixes/adjusts runtime behavior (sample-rate validation, resource cleanup in ViT image rendering, minor model/typing cleanups).
- Expands and refines tests for new validation and cleanup behavior.
Reviewed changes
Copilot reviewed 25 out of 26 changed files in this pull request and generated 4 comments.
Show a summary per file
| File | Description |
|---|---|
uv.lock |
Bumps locked project version to 0.0.7. |
pyproject.toml |
Updates package version and maintainer email. |
src/Jabberjay/jabberjay.py |
Adds sr <= 0 validation; makes load/some handlers static; keeps _result_from_scores typed as list[PredictionScore]. |
src/Jabberjay/Models/Transformer/VIT/utility.py |
Ensures BytesIO is closed in finally alongside figure cleanup. |
src/Jabberjay/Models/Classical/run.py |
Renames model → model_path for clarity. |
src/Jabberjay/Models/Transformer/AST/run.py |
Removes cast() around pipeline output. |
src/Jabberjay/Models/Wav2Vec2/run.py |
Removes cast() around pipeline output. |
src/Jabberjay/Models/HuBERT/run.py |
Removes cast() around pipeline output. |
src/Jabberjay/Models/WavLM/run.py |
Removes cast() around pipeline output. |
src/Jabberjay/Models/Transformer/VIT/MelSpectrogram/run.py |
Removes cast() around pipeline output. |
src/Jabberjay/Models/Transformer/VIT/MFCC/run.py |
Removes cast() around pipeline output. |
src/Jabberjay/Models/Transformer/VIT/ConstantQ/run.py |
Removes cast() around pipeline output. |
src/Jabberjay/Models/RawNet2/model.py |
Refactors/renames Residual_block → ResidualBlock, minor adjustments. |
tests/test_jabberjay.py |
Adds sample-rate validation tests; tightens typing on score fixtures; tweaks load-missing-file test. |
tests/test_models.py |
Adds tests for buffer/figure cleanup paths and Classical predict outcomes; tightens typing. |
README.md |
Adds Sponsors/Ko-fi badges, Support section, and Citation section; table formatting. |
CITATION.cff |
Adds machine-readable citation metadata for GitHub “Cite this repository”. |
CHANGELOG.md |
Adds 0.0.7 release notes. |
CONTRIBUTING.md |
Corrects model-addition template to match current handler/normalization patterns. |
LICENSE |
Updates copyright statement. |
SECURITY.md |
Updates security contact email. |
CODE_OF_CONDUCT.md |
Updates contact email. |
docs/models.md |
Re-formats model documentation tables for readability. |
docs/cli.md |
Re-formats CLI documentation tables for readability. |
.github/workflows/codeql.yml |
Bumps github/codeql-action from v3 to v4. |
.github/FUNDING.yml |
Adds GitHub Sponsors/Ko-fi/Thanks.dev funding links. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
You can also share your feedback on Copilot code review. Take the survey.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
This PR merges
developintomainfor the Jabberjay 0.0.7 release.CITATION.cffand a new Citation section inREADME.mdfor academic usersPredictionScoreCONTRIBUTING.mdChanges
Added
CITATION.cffwith machine-readable citation metadata. GitHub will expose this via a Cite this repository button compatible with Zenodo, Zotero, and BibTeX workflows.README.mdwith a BibTeX entry for researchers.detect(), which now raisesValueErrorwhensr <= 0before model dispatch to prevent silent downstream failures.BytesIObuffer cleanup on success and failure pathsClassical.predict()outcomesFixed
VIT/utility.py: closes theBytesIObuffer in afinallyblock. Previously, the buffer could leak ifImage.open()orimg.load()raised an exception.Classical/run.py: renamesmodeltomodel_pathto reflect that the variable stores the path returned bydownload_pretrained_model(), not a model object.jabberjay.py: restores the_result_from_scoresparameter type tolist[PredictionScore], keeping the type contract consistent from model handlers through toDetectionResult.scores.RawNet2/model.py: addstype: ignoresuppressions for unavoidable false positives in third-party summary utility code.Changed
CONTRIBUTING.md: corrects the model addition template to match real handlers:cast()andnormalize_pipeline_scores()_result_from_scores()in the handler exampleMatthew.Boakes@Gmail.comin:CODE_OF_CONDUCT.mdSECURITY.mdpyproject.tomlLICENSEto2024-2026 Matthew Boakes and The Alan Turing Institute.InconsistentVersionWarningaudioreaddeprecation warnings under Python 3.13codeql-actionfrom v3 to v4 via Dependabot.Test plan
just fix— linting and formatting passjust check— type checking passesjust test— 95 passed, 0 warnings, 100% coveragedeveloppip install jabberjay==0.0.7works