Update Workflow Developement Tutorial#310
Conversation
Summary of ChangesHello @pan-x-c, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed! This pull request delivers a substantial update to the workflow development tutorial, aiming to provide a more comprehensive and user-friendly guide. It clarifies fundamental concepts, introduces visual aids like Mermaid flowcharts, and expands on advanced features crucial for building efficient and flexible workflows. The changes cover performance optimizations, asynchronous operations, and seamless integration with external APIs like OpenAI, ensuring developers have the necessary tools and knowledge to leverage the framework effectively. Highlights
Using Gemini Code AssistThe full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips. Invoking Gemini You can request assistance from Gemini at any point by creating a comment using either
Customization To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a Limitations & Feedback Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here. You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension. Footnotes
|
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request significantly improves the workflow development tutorial by adding a conceptual diagram, introducing advanced features like batch inference and async support, and providing examples for using the OpenAI API. The documentation is now more structured and easier to follow.
I've left a few comments on the documentation to fix some inconsistencies and missing definitions in the code examples. I also found a potential issue in the base Workflow class change that might unintentionally affect SimpleWorkflow and its subclasses.
Additionally, there's a small typo in the pull request title: "Developement" should be "Development".
|
/unittest-all |
There was a problem hiding this comment.
Pull Request Overview
This PR updates the workflow development tutorial documentation and related code to improve clarity and add new features. The changes focus on enhancing documentation with visual diagrams, expanding content coverage, and ensuring workflow implementations include proper repeatability support.
- Added mermaid diagram support to visualize the relationship between Task, Model, Workflow, and Experience
- Enhanced tutorial content with more detailed explanations and performance optimization sections
- Implemented
repeatableproperty across multiple workflow classes to support batch inference optimization
Reviewed Changes
Copilot reviewed 8 out of 8 changed files in this pull request and generated 4 comments.
Show a summary per file
| File | Description |
|---|---|
| trinity/common/workflows/workflow.py | Modified base workflow class to change default repeatable behavior and added repeatable property to subclasses |
| trinity/common/workflows/envs/alfworld/RAFT_alfworld_workflow.py | Added repeatable property implementation |
| tests/utils/plugins/my_workflow.py | Added repeatable property to test workflow |
| pyproject.toml | Added sphinxcontrib-mermaid dependency for documentation |
| docs/sphinx_doc/source_zh/tutorial/develop_workflow.md | Comprehensive update to Chinese tutorial with improved structure and new content |
| docs/sphinx_doc/source_zh/conf.py | Added mermaid extension configuration |
| docs/sphinx_doc/source/tutorial/develop_workflow.md | Comprehensive update to English tutorial with improved structure and new content |
| docs/sphinx_doc/source/conf.py | Added mermaid extension configuration |
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
|
/unittest-module-common |
Summary
Tests
Github Test Reporter by CTRF 💚 |
|
/unittest-module-trainer |
Summary
Failed Tests
Skipped
Tests
Github Test Reporter by CTRF 💚 |
|
/unittest-module-trainer |
Summary
Skipped
Tests
Github Test Reporter by CTRF 💚 |
2 participants
Description
As the title says
Checklist
Please check the following items before code is ready to be reviewed.