Introducing GSP 2.0: A Leap Forward in Performance and Usability! 🚀 #3
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
- Updated `.pylintrc` for stricter linting rules to enforce consistency. - Modified `.editorconfig` for uniform whitespace and indentation. - Adjusted GitHub Actions in `.github` to streamline CI/CD pipeline execution.
- Updated `LICENSE` to clarify usage and copyright terms. - Improved `CONTRIBUTING` guidelines to provide clear instructions for contributors.
- **Performance Improvements**:
- Refactored the GSP algorithm to significantly improve candidate generation.
- Replaced nested loops with optimized `itertools` usage, reducing computational overhead.
- Enhanced `generate_candidates_from_previous` to be more efficient and maintainable by removing redundant checks.
- Performance benchmarks:
- Old implementation: ~2,874 ms.
- New implementation: ~47 ms.
- Overall improvement: ~61x (~98.37%).
- **Test Enhancements**:
- Updated `test_generate_candidates_from_previous` to cover edge cases such as disjoint patterns and single-element sequences.
- Adjusted test cases in `test_gsp` and `test_utils` to validate the new implementation.
- Verified backward compatibility to ensure correctness with the old GSP logic.
- Added benchmarks for comparative analysis of old vs. new utility functions.
- **Code Refactor**:
- Improved the readability and maintainability of core utility functions in `utils`.
- Simplified the logic for candidate generation using a compressed for-loop approach.
- **Files Modified**:
- `gsp`: Core GSP algorithm optimization.
- `test_gsp`: Adjustments for GSP test validation.
- `utils`: Refactored candidate generation utilities.
- `tests/test_gsp`: Enhanced test cases for edge cases and performance benchmarks.
- `tests/test_utils`: Improved unit tests for utility functions.
- **CLI Improvements**: - Refactored the CLI command structure for better usability and maintainability. - Improved error handling and added user-friendly messages for invalid inputs. - Enhanced logging output for better traceability during execution. - **Test Enhancements**: - Added comprehensive test cases in `test_cli` to ensure full coverage of CLI commands. - Validated edge cases, including incorrect parameters and missing configurations. - Benchmarked CLI execution to identify and optimize bottlenecks. - **Files Modified**: - `cli`: Improved command parsing and added user-friendly error messages. - `test_cli`: Expanded test coverage and introduced new edge case validations.
…tation - **Dependency Updates**: - Updated `requirements.txt` to include necessary package versions for compatibility and performance improvements. - Removed unused dependencies to streamline the project environment. - **Setup Configuration**: - Enhanced `setup.py` for better packaging and distribution. - Updated metadata fields such as author information, project URL, and long description handling using the README file. - Improved classifiers for better PyPI categorization. - **Documentation Enhancements**: - Revised `README.md` to reflect the latest project features and usage instructions. - Added examples for common use cases and clarified installation steps. - Fixed typos and restructured sections for better readability. - **Files Modified**: - `requirements.txt`: Dependency updates and cleanup. - `setup.py`: Configuration and metadata improvements. - `README.md`: Documentation updates for features, installation, and usage.
Corrected the parameter name from `minimum_support` to `min_support` in the GSP algorithm call. This ensures compatibility with the GSP method's expected arguments and prevents potential runtime errors.
Welcome to Codecov 🎉Once you merge this PR into your default branch, you're all set! Codecov will compare coverage reports and display results in all future pull requests. Thanks for integrating Codecov - We've got you covered ☂️ |
Remove unnecessary parentheses in conditional expressions and list comprehensions. Add docstrings to test functions in `test_utils.py` for better documentation. Simplify error handling messages in `cli.py` to reduce redundancy and enhance readability.
Renamed `requirements.txt` to `requirements-dev.txt` and moved development dependencies to an `extras_require` block in `setup.py`. Updated the README with instructions for installing development dependencies and clarified their purpose. This refactoring improves dependency management and developer onboarding.
Enhanced test coverage by adding cases for invalid transaction formats, edge values for `min_support`, and direct `_worker_batch` method validation. These tests ensure proper handling of errors and edge conditions in the GSP algorithm.
Introduced multiple tests to validate CLI functionality, including cases for invalid JSON structure, non-existent files, edge cases for `min_support`, and custom GSP errors. These enhancements improve test coverage and ensure robust error reporting and behavior.
Include pylint version 3.2.6 in the requirements file to ensure consistent linting across environments. This addition supports maintaining code quality in the project.
Added pytest, pytest-benchmark, and pytest-cov to the dependencies for better testing capabilities. These additions support benchmarking, coverage analysis, and improved test functionality.
Updated logging to use standardized formatting, enhanced file handling with explicit encoding, and streamlined temporary file usage in tests. These changes improve code readability, maintainability, and robustness against potential issues like encoding errors or file cleanup failures.
Replaced `raise ValueError(msg)` with `raise ValueError(msg) from e` in `cli.py` to preserve original exception context, improving debug information. Removed unnecessary import statement in related test file for cleaner test code.
This commit introduces a FUNDING.yml file to enable contributors to support the project financially. Funding platforms include GitHub Sponsors and Buy Me a Coffee.
Simplified and restructured content for better readability and usability. Updated badges, added concise feature descriptions, and improved example code formatting. Introduced a detailed table of contents and clarified usage instructions.
This workflow automates uploading Python packages to PyPI when a release is created. It builds the package and uses an authenticated action to publish it securely.
This commit introduces GitHub Sponsors and DOI badges to the README for improved visibility of funding and citation options. It also reorders the existing badges for better organization and clarity.
Replaced the GitHub Sponsors badge with a more visually appealing version and adjusted the DOI badge's position for consistency. These changes enhance the overall readability and presentation of the README file.
Introduced a CHANGELOG file to provide clear version histories and updates. Includes details about the new CLI, parallel processing, enhanced logging, and expanded documentation in v2.0, along with highlights from the initial v1.1 release. Also summarizes key improvements and additions between versions.
|
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.
Contents of the Pull Request
This pull request represents a major overhaul of the Generalized Sequential Pattern (GSP) implementation, making it significantly faster, cleaner, and more user-friendly. Here’s what you can expect:
Performance Improvements
itertoolsand streamlined logic for k-sequence construction.Codebase Enhancements
generate_candidates_from_previouslogic for readability and maintainability.itertoolsandcompress-forstatements.README.mdwith clearer instructions, examples, and a quick start guide.Dependency & Tooling Improvements
requirements.txtsetup.pywith updated metadata and streamlined installation steps.How Has This Been Tested?
Comprehensive tests were conducted to validate the changes, including:
Test Configuration:
pytestwith enhanced test casesflake8,black, andisortfor code quality checks.Stacked PR Chains
This PR is self-contained and does not depend on other PRs.
Other Notes
Checklist Before Submission
This PR introduces a powerful upgrade to GSP. We can’t wait for you to experience its improved performance and simplicity. Please review and provide feedback!