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

Combine workflow and aworkflow (and Other Annotations) #2434

Open
nirga opened this issue Dec 22, 2024 · 0 comments
Open

Combine workflow and aworkflow (and Other Annotations) #2434

nirga opened this issue Dec 22, 2024 · 0 comments
Labels
documentation Improvements or additions to documentation enhancement New feature or request

Comments

@nirga
Copy link
Member

nirga commented Dec 22, 2024

OpenLLMetry currently separates annotations for synchronous and asynchronous functions (e.g., @workflow and @aworkflow). This approach introduces redundancy and complexity. We propose unifying these into single, flexible decorators (e.g., @workflow) that handle both sync and async functions seamlessly. This change should extend to all annotations with similar patterns.

Proposed Changes:
1. Create unified decorators for @workflow, @task, and similar annotations.
2. Enhance internal logic to automatically detect and handle function types.
3. Update annotations documentation with clear examples.
4. Deprecate old annotations with migration guidance.

Tasks:
• Design and implement unified decorators.
• Update tests and documentation for all affected annotations.
• Deprecate old annotations with clear migration steps.

Benefits:
Streamlines API usage across the board, reduces complexity, and makes OpenLLMetry more intuitive and maintainable.

@dosubot dosubot bot added documentation Improvements or additions to documentation enhancement New feature or request labels Dec 22, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant