ci(docs, security): update main branch with CI improvements, documentation updates, and security enhancements #7
Conversation
This file contains 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
…ifications - Changed section title to reflect integration with `EWCModelWrapper` for NER training - Updated imports to directly use `EWCModelWrapper` and `EWC` instead of `create_ewc_pipe` - Clarified flexibility in model loading with note on using any spaCy pre-trained model - Detailed EWC and EWCModelWrapper initialization steps, including FIM calculation - Added explanation of entity annotation generation, depending on model’s pre-trained knowledge - Demonstrated wrapping the NER model with EWCModelWrapper for applying EWC penalties - Included example for adding custom entity labels conditionally to avoid duplication - Expanded training loop description to emphasize EWC penalty’s role in preventing forgetting - Provided example of test sentence to verify new custom labels alongside retained original labels
- Created the develop branch - Updated coverage.yaml to apply workflow to develop branch as well
…cmodelwrapper docs: update README with EWCModelWrapper integration example and clarifications
Defined explicit permissions for contents as read-only in the coverage workflow. This change addresses SSF recommendations by ensuring the GitHub Actions token only has the necessary permissions to perform code coverage analysis. Reduces security exposure by adhering to the principle of least privilege.
ci: update Codecov upload condition in CI workflow
…ssions ci(workflows): add minimal permissions to coverage workflow
DarkRockMountain-admin
added
documentation
JRocabruna
approved these changes
Nov 14, 2024
There was a problem hiding this comment.
Comments
The proposed updates to the main branch encompass significant improvements in continuous integration (CI), documentation, and security. These enhancements are well-structured and align with the project's objectives.
Review Checklist
- Code adheres to the project's coding guidelines.
- Changes are well-documented.
- Tests have been added/updated and pass successfully.
- Commit messages follow the correct format:
type(scope): description. - No conflicts with the base branch.
Approval
Approved: The changes meet the project's contribution standards and are ready for integration.
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.
Description
This pull request merges the latest changes from the
developbranch intomain. Key updates include:Documentation Update: Updated the README with an example for
EWCModelWrapperintegration and clarified usage instructions, improving usability for new users.CI Enhancements:
developbranch to the Codecov workflow, ensuring code coverage is reported for bothmainanddevelop.Merges of Related Pull Requests:
Other Minor Fixes and Enhancements: Improved the overall stability and maintainability of the CI configuration and security settings based on recent changes.
Related Issue: Closes [FEATURE] - Update README with EWCModelWrapper Integration Examples and Clarifications #2 [SECURITY] - Apply Minimal Permissions to GitHub Actions Workflows Based on SSF Report #4
Type of Change:
Checklist
Please ensure the following guidelines are met:
type(scope): description.Additional Information
This merge will update the
mainbranch with the latest CI/CD and documentation improvements fromdevelop. No additional dependencies are required, and the changes help improve the security and reliability of the CI workflows.