Merge develop into main – Documentation, Enhancements, and Testing Updates

[DarkRockMountain-admin]

Description

This pull request merges the develop branch into main, introducing key updates that enhance the spacy-ewc library's usability, functionality, and documentation.

Summary of Changes:

1. Documentation Updates:

   • Expanded README.md with detailed installation and usage instructions.
   • Added theoretical context for Elastic Weight Consolidation (EWC).

2. Code Enhancements:

   • Improved functionality and performance of the spacy_ewc module.
   • Enhanced integration with spaCy's Named Entity Recognition (NER) pipeline.

3. New Example Scripts:

   • Added example scripts demonstrating practical EWC applications for training NER models.

4. Test Suite Expansion:

   • Broader test coverage to ensure reliability and stability of the library.

5. Configuration Updates:

   • Updated setup.py and pyproject.toml to reflect new dependencies and changes.

• Related Issue:
  • Closes [Security] - Restrict 'packages: write' Permission to Specific Job in publish.yml Workflow #9
• Type of Change:
  • New feature (non-breaking change that adds functionality)
  • Documentation update (to include expanded content)
  • Bug fix (for minor improvements and test coverage)

Checklist

Please ensure the following guidelines are met:

• The code follows the style guidelines of this project.
• A self-review has been performed on the code.
• The code is well-documented, and comments have been added where necessary.
• Tests have been added to prove that the fix is effective or that the feature works. All existing tests pass.
• Commit messages follow the convention type(scope): description.
• The pull request has no conflicts with the base branch.
• Any dependent changes have been merged and published in downstream modules.

Additional Information

This PR strengthens the spacy-ewc library's value by providing users with a more robust implementation and better documentation. These changes ensure smoother integration for real-world applications and improve overall developer experience.

[JRocabruna]

Comments

The merge of the develop branch into main introduces significant enhancements, including comprehensive documentation updates, code improvements, new example scripts, and expanded test coverage. These changes collectively enhance the usability and functionality of the spacy-ewc library.

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 into the main branch.