Rework caching. #48
Open
Rework caching. #48
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
Contributor
There was a problem hiding this comment.
Pull request overview
This PR refactors the caching architecture to use a type-safe CacheParameter interface pattern instead of string arrays. The changes ensure that cache parameters are used correctly and consistently across the codebase through new ArchUnit tests that enforce architectural constraints.
Key Changes
- Introduced
CacheParameterinterface with concrete implementations (ClassifierCacheParameter,EmbeddingCacheParameter) to replace string array parameters - Moved
ClassifierCacheKeyandEmbeddingCacheKeyto dedicated subpackages (classifierandembedding) - Added comprehensive ArchUnit tests to enforce that CacheKey implementations use CacheParameter correctly and that CacheParameter implementations include all fields
Reviewed changes
Copilot reviewed 13 out of 13 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
src/main/java/edu/kit/kastel/sdq/lissa/ratlr/cache/CacheParameter.java |
New interface defining the contract for cache parameters with a parameters() method |
src/main/java/edu/kit/kastel/sdq/lissa/ratlr/cache/classifier/ClassifierCacheParameter.java |
New record implementing CacheParameter for classifier caching, with backward compatibility for temperature |
src/main/java/edu/kit/kastel/sdq/lissa/ratlr/cache/embedding/EmbeddingCacheParameter.java |
New record implementing CacheParameter for embedding caching |
src/main/java/edu/kit/kastel/sdq/lissa/ratlr/cache/classifier/ClassifierCacheKey.java |
Moved to classifier subpackage and updated to use ClassifierCacheParameter in static factory method |
src/main/java/edu/kit/kastel/sdq/lissa/ratlr/cache/embedding/EmbeddingCacheKey.java |
Moved to embedding subpackage and updated to use EmbeddingCacheParameter in static factory method |
src/main/java/edu/kit/kastel/sdq/lissa/ratlr/cache/CacheKey.java |
Updated imports to reflect moved cache key classes |
src/main/java/edu/kit/kastel/sdq/lissa/ratlr/cache/CacheManager.java |
Simplified API to accept CacheParameter instead of string arrays; removed unused getCache(Path, boolean) method |
src/main/java/edu/kit/kastel/sdq/lissa/ratlr/classifier/ChatLanguageModelProvider.java |
Changed getCacheParameters() to return ClassifierCacheParameter instead of string array |
src/main/java/edu/kit/kastel/sdq/lissa/ratlr/classifier/SimpleClassifier.java |
Updated to use new cacheParameters() method and ClassifierCacheKey.of() with CacheParameter |
src/main/java/edu/kit/kastel/sdq/lissa/ratlr/classifier/ReasoningClassifier.java |
Updated to use new cacheParameters() method and ClassifierCacheKey.of() with CacheParameter |
src/main/java/edu/kit/kastel/sdq/lissa/ratlr/preprocessor/SummarizePreprocessor.java |
Updated to use new cacheParameters() method and ClassifierCacheKey.of() with CacheParameter |
src/main/java/edu/kit/kastel/sdq/lissa/ratlr/embeddingcreator/CachedEmbeddingCreator.java |
Updated to use EmbeddingCacheParameter throughout and in EmbeddingCacheKey.of() calls |
src/test/java/edu/kit/kastel/sdq/lissa/ratlr/ArchitectureTest.java |
Added two new ArchUnit rules to enforce CacheKey and CacheParameter implementation contracts |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
src/test/java/edu/kit/kastel/sdq/lissa/ratlr/ArchitectureTest.java
Outdated
Show resolved
Hide resolved
Co-authored-by: Copilot <[email protected]>
…r.java Co-authored-by: Copilot <[email protected]>
|
Contributor
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 19 out of 19 changed files in this pull request and generated 2 comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
src/main/java/edu/kit/kastel/sdq/lissa/ratlr/cache/embedding/EmbeddingCacheKey.java
Show resolved
Hide resolved
src/main/java/edu/kit/kastel/sdq/lissa/ratlr/cache/classifier/ClassifierCacheKey.java
Show resolved
Hide resolved
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.
Now it shall be ensured that CacheParameters are used correctly.