Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add Report Generation and Configuration Improvements for GuideLLM #24

Merged
merged 3 commits into from
Aug 2, 2024

Conversation

markurtz
Copy link
Member

@markurtz markurtz commented Aug 1, 2024

Summary

Introduces a report file generation feature for GuideLLM and fixes the configuration functionality. Once the frontend is live, we will add the report generation functionality to the CLI and add integration and end to end tests

Details

  • Report Generation Feature:
    • Added logic to generate and inject reports from Pydantic models.
    • Created utility functions for loading HTML templates, injecting data, and saving reports.
    • Implemented support for both local file paths and URLs as sources for HTML templates.
    • Included handling for different environments (local, dev, staging, prod) with environment-specific report URLs.
  • Configuration Improvements:
    • Refactored configuration structure into a more modular and maintainable format.
    • Updated configuration to use Pydantic's BaseSettings and model_validator for environment-based settings.
    • Improved logging configuration with customizable options for console and file logging levels.
    • Enhanced OpenAI settings for more robust API connectivity.
  • Testing:
    • Added comprehensive unit and integration tests for the new report generation feature.
    • Updated existing tests to align with the new configuration structure.
    • Ensured all tests pass successfully and that code coverage is maintained.

Test Plan

  • Automation Testing:
    • Added and verified unit tests for the report generation and configuration functionalities pass without issues.
  • Manual Testing:
    • Manually tested the report generation process using various Pydantic models and HTML templates.

@markurtz markurtz self-assigned this Aug 1, 2024
parfeniukink
parfeniukink previously approved these changes Aug 2, 2024
Copy link
Contributor

@parfeniukink parfeniukink left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice! Feel free to resolve all conversations without my feedback in that PR

@markurtz markurtz merged commit aee89e8 into main Aug 2, 2024
9 checks passed
@markurtz markurtz deleted the injection branch August 2, 2024 21:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants