BCG-X-Official / artkit

Automated prompt-based testing and evaluation of Gen AI applications
https://bcg-x-official.github.io/artkit/_generated/home.html
Apache License 2.0
76 stars 6 forks source link

FIX: Final tweaks leading up to 1.0 release #3

Closed AlexanderLontke closed 1 week ago

AlexanderLontke commented 1 week ago

Description: This pull request addresses several issues identified in the current release candidate v1.0rc2. The changes focus on improving the stability, readability, and user experience of the codebase. The following fixes have been implemented:

  1. Move Optional Dependencies into Try-Except Statement:

    • Commit: FIX: Move optional dependencies into try-except statement (1ebe8ea)
    • Description: This change ensures that optional dependencies are only imported if available, preventing runtime errors if these dependencies are missing. This is achieved by wrapping the import statements in a try-except block, allowing the program to handle the absence of optional packages gracefully.
  2. Update Log Throttler Doc Strings:

    • Commit: FIX: Updated log throttler doc strings (928d216a64c29801a945a4f49020487560476bd8, cd2de1e1fe3ec9e0c7556a3af13030a0e52bb5cb)
    • Description: The documentation strings for the log throttler have been updated to conform to formatting standards.
  3. Remove Warnings When Running Tests:

    • Commit: FIX: Removed warnings when running tests (476e1d0d0d829e7d9c5364f75ee389633d24d020)
    • Description: This fix addresses several warnings that were being generated during the test execution. By resolving these warnings, the test output is now cleaner, making it easier to identify real issues and maintain a high-quality codebase.
  4. Remove Warnings When Running Tests:

    • Commits: Exclude artkit.api from sphinx doc build (e16df41a8dc4d6f809a7da26e1cab37a6e1c8be6, 1d8d666a914ed69826b7b646ccce80b932383b66)
    • Description: Addresses warnings during sphinx build stemming from module structure.

Changes Made:

Testing: