Conversation
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.
This pull request includes various updates across multiple files to enhance functionality, documentation, and code clarity. The most significant changes involve adding a new GitHub Actions workflow, updating pre-commit hooks, improving documentation for color correction classes, and renaming some class identifiers for better readability.
GitHub Actions Workflow:
.github/workflows/docs.yml: Added a new workflow to deploy the MkDocs site to GitHub Pages, triggered by changes in thedocsfolder ormkdocs.ymlfile or triggered by manual.Pre-commit Hooks:
.pre-commit-config.yaml: Added new hooks foruv-pre-commitand updated the configurations for existing hooks.Documentation Improvements:
color_correction/core/card_detection/det_yv8_onnx.py: Expanded the docstring forYOLOv8CardDetectorto include detailed descriptions of parameters and attributes.color_correction/core/correction/affine_reg.py: RenamedAffineRegtoAffineRegressionand added comprehensive docstrings for the class and its methods. [1] [2] [3]color_correction/core/correction/least_squares.py: Added detailed docstrings forLeastSquaresRegressionclass and its methods. [1] [2] [3]color_correction/core/correction/linear_reg.py: RenamedLinearRegtoLinearRegressionand added detailed docstrings for the class and its methods. [1] [2]color_correction/core/correction/polynomial.py: Added detailed docstrings forPolynomialclass and its methods. [1] [2]color_correction/services/color_correction.py: Added detailed docstrings for various methods to improve code readability and maintainability. [1] [2] [3]Code Identifier Renaming:
color_correction/core/correction/__init__.py: RenamedAffineRegtoAffineRegressionandLinearRegtoLinearRegressionfor consistency and clarity.color_correction/core/correction/_factory.py: Updated references to renamed classesAffineRegressionandLinearRegression. [1] [2]