Skip to content

docs: align README support and dependency guidance#1008

Merged
mldangelo-oai merged 3 commits intomainfrom
mdangelo/codex/docs-readme-audit-fixes
Apr 16, 2026
Merged

docs: align README support and dependency guidance#1008
mldangelo-oai merged 3 commits intomainfrom
mdangelo/codex/docs-readme-audit-fixes

Conversation

@mldangelo-oai
Copy link
Copy Markdown
Contributor

Summary

  • align the public README and package metadata with supported Python 3.10-3.13
  • clarify that modelaudit[all] is broad portable coverage and TensorFlow remains an explicit extra
  • refresh supported-format/compatibility docs, telemetry privacy wording, PyPI-safe links, and changelog entry

Tests

  • uv lock --check
  • uv run ruff format --check modelaudit/ packages/modelaudit-picklescan/src packages/modelaudit-picklescan/tests tests/
  • uv run ruff check modelaudit/ packages/modelaudit-picklescan/src packages/modelaudit-picklescan/tests tests/
  • uv run mypy modelaudit/ packages/modelaudit-picklescan/src packages/modelaudit-picklescan/tests tests/
  • PROMPTFOO_DISABLE_TELEMETRY=1 uv run pytest -n auto -m "not slow and not integration" --maxfail=1
  • npx prettier --check CHANGELOG.md README.md docs/user/compatibility-matrix.md docs/agents/dependencies.md docs/user/offline-air-gapped.md docs/user/security-model.md
  • git diff --check

@github-actions
Copy link
Copy Markdown
Contributor

github-actions bot commented Apr 15, 2026

Workflow run and artifacts

Performance Benchmarks

Compared 19 shared benchmarks with a regression threshold of 15%.
Status: 0 regressions, 0 improved, 19 stable, 0 new, 0 missing.
Aggregate shared-benchmark median: 181.65ms -> 181.78ms (+0.1%).

Benchmark Target Size Files Baseline Current Change Status
tests/benchmarks/test_picklescan_benchmarks.py::test_picklescan_dangerous_global_payloads[malicious_reduce] malicious_reduce 52 B 1 63.4us 60.8us -4.2% stable
tests/benchmarks/test_picklescan_benchmarks.py::test_picklescan_multi_stream_padded_payload multi_stream_padded 4.1 KiB 1 111.8us 115.6us +3.4% stable
tests/benchmarks/test_picklescan_benchmarks.py::test_picklescan_safe_payloads[safe_small] safe_small 68 B 1 47.8us 46.2us -3.2% stable
tests/benchmarks/test_picklescan_benchmarks.py::test_picklescan_nested_payloads[nested_base64] nested_base64 98 B 1 85.5us 83.2us -2.7% stable
tests/benchmarks/test_picklescan_benchmarks.py::test_picklescan_opcode_budget_tail_payload opcode_budget_tail 14 B 1 58.4us 57.2us -2.2% stable
tests/benchmarks/test_picklescan_benchmarks.py::test_picklescan_nested_payloads[nested_hex] nested_hex 130 B 1 90.0us 88.1us -2.1% stable
tests/benchmarks/test_picklescan_benchmarks.py::test_picklescan_nested_payloads[nested_raw] nested_raw 78 B 1 80.3us 78.8us -2.0% stable
tests/benchmarks/test_picklescan_benchmarks.py::test_picklescan_chunked_stream chunked_stream 278.2 KiB 1 6.74ms 6.81ms +1.0% stable
tests/benchmarks/test_picklescan_benchmarks.py::test_picklescan_dangerous_global_payloads[stack_global] stack_global 21 B 1 53.3us 52.7us -1.0% stable
tests/benchmarks/test_picklescan_benchmarks.py::test_picklescan_hidden_suspicious_string_budget hidden_suspicious_string 8.0 KiB 1 598.1us 592.6us -0.9% stable
tests/benchmarks/test_scan_benchmarks.py::test_scan_safe_pickle safe_model.pkl 49.4 KiB 1 10.82ms 10.91ms +0.8% stable
tests/benchmarks/test_scan_benchmarks.py::test_scan_pytorch_zip state_dict.pt 1.5 MiB 1 31.03ms 30.83ms -0.6% stable
tests/benchmarks/test_picklescan_benchmarks.py::test_picklescan_safe_payloads[safe_large] safe_large 278.2 KiB 1 3.75ms 3.77ms +0.6% stable
tests/benchmarks/test_scan_benchmarks.py::test_detect_file_format_safe_pickle safe_model.pkl 49.4 KiB 1 24.6us 24.5us -0.5% stable
tests/benchmarks/test_scan_benchmarks.py::test_skip_filter_plain_text_files - 4.6 KiB 256 10.16ms 10.21ms +0.5% stable
tests/benchmarks/test_scan_benchmarks.py::test_validate_file_type_pytorch_zip state_dict.pt 1.5 MiB 1 44.2us 44.4us +0.5% stable
tests/benchmarks/test_picklescan_benchmarks.py::test_picklescan_safe_payloads[long_benign_string] long_benign_string 1.0 MiB 1 1.17ms 1.17ms +0.2% stable
tests/benchmarks/test_scan_benchmarks.py::test_scan_mixed_directory mixed-corpus 1.7 MiB 54 72.44ms 72.53ms +0.1% stable
tests/benchmarks/test_scan_benchmarks.py::test_scan_duplicate_directory duplicate-corpus 840.0 KiB 81 44.29ms 44.31ms +0.0% stable

@mldangelo-oai mldangelo-oai force-pushed the mdangelo/codex/docs-readme-audit-fixes branch from 63431fe to 3534977 Compare April 16, 2026 06:46
@mldangelo-oai mldangelo-oai merged commit 5dcd62b into main Apr 16, 2026
8 checks passed
@mldangelo-oai mldangelo-oai deleted the mdangelo/codex/docs-readme-audit-fixes branch April 16, 2026 06:46
@github-actions github-actions bot mentioned this pull request Apr 16, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant