v2.1.0

Release Notes

New Features

• Add frames_extractor:

  • Added all_frames flag to best_frames_extractor.
  • Implemented all_frames logic in best_frames_extractor and updated tests accordingly.
  • Added all_frames flag to service_initializer and updated tests.

• New Sections and Enhancements in Documentation:

  • Added section Architecture and update README
  • Created and updated CONTRIBUTING.md, CODE_OF_CONDUCT.md, SECURITY.md, and pull_request_template.md.
  • Added visualizations and demo presentation image to the README.
  • Compressed static files and images for better performance.
  • Updated issue templates for bug reports and feature requests.

Bug Fixes

• Fixed logo text color.
• Fixed href links in various sections.
• Fixed typos and improved text in both English and Polish READMEs.
• Fixed code_of_conduct href in CONTRIBUTING.md.
• Removed non-functional README.md badge.
• Fixed typo in extractors.

Refactoring and Improvements

• Replaced | with typing.Union.
• Renamed methods for consistency:
• get_extractor() -> create_extractor() in ExtractorFactory.
• Changed method name in OpenCVVideo from get_next_video_frames to get_next_frames.
• Moved normalizing images from evaluator to extractors.
• Added normalize_images method as an abstract method in image_processors.py.
• Moved ServiceShutdownSignal inside DockerManager.
• Made ServiceInitializer attributes protected.
• Added license to docstrings.
• Added badges and fixed language links.

Other Changes

• Created and updated various markdown files in the .github directory.
• Improved docker configurations by adding .dockerignore.

PerfectFrameAI v2.0.0

Release Notes for Version 2.0.0

We are thrilled to announce the release of version 2.0.0, a significant milestone in our project’s development. This release brings the application to a state of readiness for end-user testing and usage. Here are the key changes and improvements introduced in this version:

Enhancements and New Features:

• New Docker manager
• Full extractor service automation
• Asynchronous images saving and reading
• Comprehensive testing
• New, much faster frames decoding method
• A lot of small imporvements in code
• New README and documentation
• and much more

PerfectFrameAI v2.0.0-alpha

This pull request signifies a significant milestone for our project as we prepare to release version v2.0-alpha. It encompasses a broad range of updates aimed at enhancing functionality, improving code documentation, and refining our testing processes. Below is a summary of the key changes included:

Enhancements and New Features:

• Implemented asynchronous image saving to boost performance.
• Added comprehensive testing for various modules including best_frames_extractor, cuda_check, raters, and more.
• Refactored and improved schemas, image evaluators, and docker management.
• Introduced new docstrings across multiple scripts (app, start.py, config.py, image_evaluators.py) to improve code readability and * maintainability.
• Added --build flag logic to docker_manager for enhanced Docker operation.
• Automated service shutdown after task completion to streamline operations.

Bug Fixes:

• Resolved bugs in docker_manager, top_images_extractor, and schemas.py to enhance stability and performance.
• Addressed issues in test scripts post-refactoring to ensure robustness.

Testing:

• Expanded our testing suite to include new e2e tests, integration tests for docker_manager and service_manager, and additional tests across various modules.
• Implemented normalize_images and InceptionResNetNIMA testing to ensure model efficacy and reliability.

Documentation and Project Structure:

• Transitioned from setup.py to start.py, enhancing project setup and configuration.
• Added poetry.lock and pyproject.toml to align with best practices in Python project dependency management.
• Updated README documentation to remove obsolete content and enhance user guidance with new GIF demos.