refactor: comprehensive docstring improvements and code cleanup #198
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
Fixed VAR (Vector Autoregression) model data shape issues in multiple components: - TimeSeriesModelSklearn: Removed incorrect transpose for VAR data, now correctly passes (n_obs, n_vars) to backend - BackendToStatsmodelsAdapter: Updated forecast method to properly handle VAR model parameters - test_backend_feature_coverage.py: Fixed VAR test data preparation to use correct shape All VAR models now consistently expect data in (n_obs, n_vars) format throughout the codebase.
- Remove test_tsfit_compatibility that tried to import non-existent TSFit - Replace with test_tsfitbestlag_compatibility that tests deprecation warning - TSFitBestLag is now a deprecated subclass of AutoOrderSelector, not an alias - Test verifies deprecation warning is shown and functionality still works
- Remove TSFitBestLag class entirely from codebase - Update all imports to use AutoOrderSelector directly - Remove deprecation warnings and documentation mentions - Update tests to use AutoOrderSelector instead of TSFitBestLag - Clean up __all__ exports in __init__.py files The AutoOrderSelector class provides the same functionality without the legacy naming. This completes the removal of all TSFit-related code from the codebase.
…folder - Move AutoOrderSelector from model_selection/best_lag.py to utils/auto_order_selector.py - Remove empty model_selection folder entirely - Update all imports to use new location - Rename test_best_lag.py to test_auto_order_selector_legacy.py for clarity - Export AutoOrderSelector from utils/__init__.py - Fix all patch statements in tests to use new import path This simplifies the project structure by removing a folder that contained only one file with a confusing name (best_lag.py).
This commit improves documentation throughout the codebase and completes the migration to the new high-performance backend system. Backend Migration: - Remove deprecated TSFit classes and references - Clean up legacy code paths - Remove obsolete analysis documentation Documentation Improvements: - Update docstrings across 37 files for better clarity - Add detailed explanations of design decisions - Include practical examples and usage patterns - Improve error messages for better debugging - Remove internal references inappropriate for public repository Code Quality: - Enhanced type annotations in type system modules - Improved protocol definitions for backend system - Better documented service architecture - Clearer validation error messages This ensures the codebase has consistent, high-quality documentation that helps users understand both functionality and design rationale.
|
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.
Summary
Test plan