search

weavel-ai / Ape

Your first AI prompt engineer
https://docs.weavel.ai/sdk-reference/ape-common
MIT License
331 stars 13 forks source link

[feature] Change ape-common functor names, update ape-core structure and introduce multiple trainers #36

Closed engineerA314 closed 1 week ago

engineerA314 commented 1 week ago

Description

This pull request introduces significant refactoring and improvements to the Ape project, focusing on enhancing the evaluation and generation processes. Key changes include:

  1. Renaming and restructuring core components:

    • Evaluate class is now Evaluator
    • Generate and BaseGenerate are renamed to Generator and BaseGenerator
    • fit method is renamed to train in trainer classes

  2. Refactoring the evaluation process:

    • Simplified Evaluator class with improved async handling
    • Removed EvaluationResult type, streamlining the evaluation output

  3. Updating type hints and function signatures for better consistency and clarity

  4. Improving logging by replacing print statements with proper logger calls

  5. Introducing new trainer classes, including DspyMiproTrainer

  6. Updating version numbers: ape-common to 0.2.0 and ape-core to 0.9.0

These changes aim to improve code organization, readability, and maintainability while enhancing the overall functionality of the Ape project.

Changes that Break Backward Compatibility

  1. Renaming of core classes and methods:

    • Evaluate to Evaluator
    • Generate to Generator
    • BaseGenerate to BaseGenerator
    • fit method to train in trainer classes

  2. Removal of EvaluationResult type

  3. Changes in function signatures and type hints across multiple files

  4. Renaming of metadata field to trace in evaluation results

These changes will require updates to any code that relies on the previous class names, method names, or type structures.

Documentation

N/A

Created with Palmier

aschung01 commented 1 week ago

@palmier-bot describe