This pull request sets up a monorepo structure and separates packages into common and core components. The main changes include:
Restructuring the project layout:
Moving common functionality to libs/ape-common/ape/common/
Removing the main ape/ directory and its contents
Refactoring and updating imports:
Updating import statements to reflect the new package structure
Renaming some classes and functions for consistency
Modifying the GitHub Actions workflow:
Updating the publish workflow to support multiple packages
Adding logic to extract package directory from release title
Introducing new modules:
Adding generate module with BaseGenerate and Generate classes
Creating metric_prompts module for managing metric-related prompts
Refactoring existing modules:
Updating BaseMetric, GlobalMetric, and specific metric implementations
Modifying Evaluate class to work with the new structure
These changes aim to improve the project's modularity, making it easier to maintain and extend different components independently.
Changes that Break Backward Compatibility
This PR introduces several breaking changes:
Package structure: The ape package has been split into ape-common and potentially other packages, requiring updates to import statements in existing code.
Class and function signatures: Some classes and functions have been modified, potentially requiring updates to any code that uses them. For example:
BaseMetric.compute() method signature has changed
Evaluate class initialization and usage may need to be updated
Configuration: The EvaluationConfig class has been moved and may have different import paths.
Prompt handling: The way prompts are loaded and used has changed with the introduction of ApeMetricPrompts.
Users of the library will need to update their code to accommodate these changes.
aschung01
commented
1 week ago
Description
This pull request sets up a monorepo structure and separates packages into common and core components. The main changes include:
Restructuring the project layout:
libs/ape-common/ape/common/ape/directory and its contentsRefactoring and updating imports:
Modifying the GitHub Actions workflow:
Introducing new modules:
generatemodule withBaseGenerateandGenerateclassesmetric_promptsmodule for managing metric-related promptsRefactoring existing modules:
BaseMetric,GlobalMetric, and specific metric implementationsEvaluateclass to work with the new structureThese changes aim to improve the project's modularity, making it easier to maintain and extend different components independently.
Changes that Break Backward Compatibility
This PR introduces several breaking changes:
Package structure: The
apepackage has been split intoape-commonand potentially other packages, requiring updates to import statements in existing code.Class and function signatures: Some classes and functions have been modified, potentially requiring updates to any code that uses them. For example:
BaseMetric.compute()method signature has changedEvaluateclass initialization and usage may need to be updatedConfiguration: The
EvaluationConfigclass has been moved and may have different import paths.Prompt handling: The way prompts are loaded and used has changed with the introduction of
ApeMetricPrompts.Users of the library will need to update their code to accommodate these changes.
Documentation
N/A
Created with Palmier