Skip to content

docs(examples): add common evaluation workflow examples - #289

Merged
himanshu231204 merged 1 commit into
OpenAgentHQ:mainfrom
Nithyaviswak:docs/example-workflows
Aug 17, 2026
Merged

docs(examples): add common evaluation workflow examples#289
himanshu231204 merged 1 commit into
OpenAgentHQ:mainfrom
Nithyaviswak:docs/example-workflows

Conversation

@Nithyaviswak

Copy link
Copy Markdown
Contributor

Expand docs/examples.md with copy-paste workflows for the core APIs: quick eval from Python, model comparison (GPT-4o vs Claude), CI/CD threshold gating, and batch evaluation over multiple configs. Also fix the pytest-suite snippet, which referenced an undefined 'dataset'.

Closes #119

Description

A clear and concise description of what this PR does.

Type of Change

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Documentation update
  • Refactoring (no functional changes)
  • Test update
  • CI/CD update

Related Issues

Closes #(issue_number)

How Has This Been Tested?

Describe the tests that you ran to verify your changes.

  • Unit tests pass (uv run pytest)
  • Linter passes (uv run ruff check .)
  • Type checker passes (uv run mypy openagent_eval/)
  • Manual testing performed

Checklist

  • My code follows the project's coding standards
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes

Screenshots (if applicable)

Add screenshots to demonstrate visual changes.

Additional Notes

Add any other notes about the PR here.

Expand docs/examples.md with copy-paste workflows for the core APIs:
quick eval from Python, model comparison (GPT-4o vs Claude), CI/CD
threshold gating, and batch evaluation over multiple configs. Also fix
the pytest-suite snippet, which referenced an undefined 'dataset'.

Closes OpenAgentHQ#119
@himanshu231204
himanshu231204 merged commit bffcf16 into OpenAgentHQ:main Aug 17, 2026
9 checks passed
@github-actions

Copy link
Copy Markdown

🎉 Congratulations @Nithyaviswak!

Your pull request has been successfully merged into main. 🚀

Thank you for contributing to OpenAgentHQ and helping improve the project.

We truly appreciate your contribution and hope to see you back with more amazing PRs!

Happy Open Sourcing! ❤️

@himanshu231204 himanshu231204 mentioned this pull request Aug 17, 2026
4 tasks
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.

Add common evaluation workflow examples to docs/examples.md

2 participants