Enhance documentation, add in-memory GIF scanning, and update benchmarks#1
Merged
Conversation
Add a new docs/ folder with `docs/output.md` (full `ScanResult` JSON schema) and `docs/README.md` linking the docs. Update README.md to add PyPI/CI badges and a Documentation section pointing to the new output reference. Adjust pyproject.toml sdist build settings: replace `include` with `only-include` and update the listed files to ensure `src/pyframe`, `tests`, `README.md`, and `LICENSE` are packaged.
Introduce an in-memory GIF/image scanning path: add iter_frames_from_bytes and scan_bytes so GIFs can be decoded and scanned without touching disk. Expose Scanner.scan_bytes and Pipe.scan_bytes, update package exports and README with usage example, and add a unit test for in-memory decoding. Remove the save_frames option and its related CLI/config/Scanner side-effect (frame-saving was removed). Also add two benchmarking scripts (bench_decode.py, bench_gifs.py) and ignore bench_results.jsonl in .gitignore.
Add a new performance guide and tooling: create docs/performance.md and link it from docs/README.md; add media/perf_stages.png and media/perf_latency.png. Introduce scripts/bench_gifs.py (capacity-planning benchmark that runs the real GIF moderation path, synthesizes a corpus if needed, stubs AWS precise calls and emits bench_results.jsonl) and scripts/plot_results.py (generates the two performance charts from the JSONL). This change documents per-stage timing, throughput/latency results, and provides reproducible benchmark + plotting utilities.
Add links and badges pointing to eden.report/docs from README and in-repo docs (README.md, docs/README.md, docs/output.md, docs/performance.md) to surface the live/annotated pipeline documentation. Remove legacy benchmarking and plotting utilities (scripts/bench_gifs.py and scripts/plot_results.py).
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
1 participant
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.
No description provided.