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

chore(docs): updated type of task steps page #1164

Merged
merged 5 commits into from
Feb 15, 2025
Merged

Conversation

Vedantsahai18
Copy link
Member

@Vedantsahai18 Vedantsahai18 commented Feb 15, 2025

PR Type

Documentation, Enhancement


Description

  • Updated documentation for workflow syntax and task steps.

    • Introduced new syntax for input/output data references.
    • Replaced Jinja templates with Python f-strings.
  • Added examples for subworkflow steps and map-reduce workflows.

  • Enhanced visual elements in markdown files with badges and logos.

  • Updated navigation structure in mint.json for advanced topics.


Changes walkthrough 📝

Relevant files
Enhancement
header.html
Adjusted logo image height in header template                       

scripts/templates/header.html

  • Added height attribute to the logo image.
+1/-1     
CHANGELOG.md
Adjusted logo image height in changelog                                   

CHANGELOG.md

  • Added height attribute to the logo image.
+1/-1     
Documentation
IDEAS.md
Added logo and badges to IDEAS markdown                                   

cookbooks/IDEAS.md

  • Added logo and badges for visual enhancement.
  • Included links to API key, documentation, and social platforms.
  • +32/-0   
    README.md
    Enhanced README with logo and badges                                         

    cookbooks/README.md

  • Updated logo and added badges for API, documentation, and social
    links.
  • Enhanced visual presentation of the README.
  • +29/-1   
    new-syntax.mdx
    Updated workflow syntax and template usage                             

    documentation/docs/advanced/new-syntax.mdx

  • Updated workflow syntax for input/output references.
  • Replaced Jinja templates with Python f-strings.
  • Added notes on $ prefix usage.
  • +12/-10 
    types-of-task-steps.mdx
    Added subworkflow and map-reduce examples                               

    documentation/docs/advanced/types-of-task-steps.mdx

  • Added examples for subworkflow steps.
  • Enhanced examples for map-reduce and conditional steps.
  • Updated notes on parallelism and data references.
  • +125/-86
    tasks.mdx
    Updated task steps table with subworkflow                               

    documentation/docs/concepts/tasks.mdx

  • Added subworkflow step to the task steps table.
  • Removed parallel step from the table.
  • +1/-1     
    mint.json
    Updated navigation structure in mint.json                               

    documentation/mint.json

  • Reorganized advanced topics navigation.
  • Added new pages for workflow syntax and task steps.
  • +6/-6     

    Need help?
  • Type /help how to ... in the comments thread for any questions about Qodo Merge usage.
  • Check out the documentation for more information.
  • Copy link
    Contributor

    PR Reviewer Guide 🔍

    Here are some key observations to aid the review process:

    ⏱️ Estimated effort to review: 1 🔵⚪⚪⚪⚪
    🧪 No relevant tests
    🔒 No security concerns identified
    ⚡ Recommended focus areas for review

    Documentation Clarity

    The parallelism note for map-reduce steps contains unclear and possibly contradictory information about default parallelism value and subworkflow restrictions

    - By default the `parallelism` if not mentioned is 100. If mentioned, it is the maximum number of steps that can run in parallel concurrently.
    - When using `over` step, the `map` step is executed for each value in the collection.
    - The `reduce` step is executed after the `map` step.
    - When using `map-reduce` step for subworkflows, the `parallelism` has to be mentioned as `1` or it will throw an error.

    Copy link
    Contributor

    PR Code Suggestions ✨

    Explore these optional code suggestions:

    CategorySuggestion                                                                                                                                    Impact
    General
    Improve document formatting consistency

    The document formatting is inconsistent with mixed heading levels and irregular
    spacing. Standardize the heading hierarchy and add consistent spacing between
    sections to improve readability.

    documentation/docs/advanced/new-syntax.mdx [7-14]

     ## Overview
     
    -We've updated our workflow syntax to make data flow more explicit and consistent. 
    -These changes improve readability and make workflows more maintainable. 
    -While this update requires modifications to existing workflows, it provides a more robust foundation for workflow development.
    +We've updated our workflow syntax to make data flow more explicit and consistent. These changes improve readability and make workflows more maintainable. While this update requires modifications to existing workflows, it provides a more robust foundation for workflow development.
     
    +## Input/Output Data References
     
    -## 1. Input/Output Data References
    -
    • Apply this suggestion
    Suggestion importance[1-10]: 3

    __

    Why: The suggestion addresses minor formatting inconsistencies in document structure, proposing better spacing and heading hierarchy. While valid, this is a low-priority stylistic improvement with minimal impact on functionality.

    Low

    Copy link
    Contributor

    @ellipsis-dev ellipsis-dev bot left a comment

    Choose a reason for hiding this comment

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

    ❌ Changes requested. Reviewed everything up to 0a02a82 in 1 minute and 59 seconds

    More details
    • Looked at 476 lines of code in 8 files
    • Skipped 0 files when reviewing.
    • Skipped posting 8 drafted comments based on config settings.
    1. cookbooks/IDEAS.md:1
    • Draft comment:
      The newly added header block with the logo and badges looks consistent with other sections. Verify that the formatting renders correctly across devices.
    • Reason this comment was not posted:
      Marked as duplicate.
    2. cookbooks/README.md:1
    • Draft comment:
      The updated header in the README (including the revised image with height and badge links) is clear and consistent. Ensure that all Colab links function as expected.
    • Reason this comment was not posted:
      Marked as duplicate.
    3. documentation/docs/advanced/new-syntax.mdx:7
    • Draft comment:
      Heading levels and formatting have been adjusted for clarity. Double-check that the hierarchy (using '##' for main sections) remains logical throughout the document.
    • Reason this comment was not posted:
      Comment did not seem useful. Confidence is useful = 0% <= threshold 50%
      This comment is asking the PR author to double-check the hierarchy of sections in a document. It doesn't provide a specific suggestion or point out a specific issue, which violates the rule against asking the author to double-check things.
    4. documentation/docs/advanced/types-of-task-steps.mdx:145
    • Draft comment:
      The new 'Subworkflow Step' section is a useful addition. In the YAML examples (especially in the foreach block), note that the removal of list markers (dashes) for step items may affect YAML array formatting. Verify that the task runner accepts this structure.
    • Reason this comment was not posted:
      Marked as duplicate.
    5. documentation/docs/advanced/types-of-task-steps.mdx:275
    • Draft comment:
      The note on 'map-reduce' now clearly explains parallelism settings. Ensure that the requirement for 'parallelism: 1' in subworkflows is documented prominently so users don’t run into runtime errors.
    • Reason this comment was not posted:
      Comment was not on a location in the diff, so it can't be submitted as a review comment.
    6. documentation/docs/concepts/tasks.mdx:98
    • Draft comment:
      The addition of the '[Subworkflow]' row in the tasks steps table improves clarity. The table now accurately reflects all available step types.
    • Reason this comment was not posted:
      Comment was not on a location in the diff, so it can't be submitted as a review comment.
    7. documentation/mint.json:175
    • Draft comment:
      Navigation groupings have been updated in the mint.json file. Please double-check that the updated order of pages in the 'Advanced Topics' group (and others) matches the current documentation structure.
    • Reason this comment was not posted:
      Comment did not seem useful. Confidence is useful = 0% <= threshold 50%
      This comment is asking the PR author to double-check the order of pages in a configuration file. It doesn't provide a specific suggestion or point out a clear issue with the code. It violates the rule against asking the author to double-check things.
    8. scripts/templates/header.html:1
    • Draft comment:
      The header template now includes a height attribute for the logo image, aligning with other documentation sections. This update looks good and is consistent.
    • Reason this comment was not posted:
      Marked as duplicate.

    Workflow ID: wflow_ClHiWBl8CyHj02Ri


    Want Ellipsis to fix these issues? Tag @ellipsis-dev in a comment. You can customize Ellipsis with 👍 / 👎 feedback, review rules, user-specific overrides, quiet mode, and more.

    Vedantsahai18 and others added 3 commits February 15, 2025 12:19
    Co-authored-by: ellipsis-dev[bot] <65095814+ellipsis-dev[bot]@users.noreply.github.com>
    Co-authored-by: ellipsis-dev[bot] <65095814+ellipsis-dev[bot]@users.noreply.github.com>
    Copy link
    Contributor

    CI Feedback 🧐

    A test triggered by this PR failed. Here is an AI-generated analysis of the failure:

    Action: Typecheck

    Failed stage: Typecheck [❌]

    Failed test name: agents_api.workflows.task_execution.init

    Failure summary:

    The pytype static type checker failed due to an attribute error in the task execution workflow:

  • Error occurred in file agents_api/workflows/task_execution/init.py at line 405
  • Trying to access execution_input attribute on self.context which could be None
  • The type checker detected that self.context is of type Optional[StepContext], meaning it needs
    null-safety checks

  • Relevant error logs:
    1:  ##[group]Operating System
    2:  Ubuntu
    ...
    
    1469:  [152/294] check agents_api.routers.users.update_user
    1470:  [153/294] check agents_api.clients.temporal
    1471:  [154/294] check agents_api.routers.users.patch_user
    1472:  [155/294] check agents_api.routers.users.list_users
    1473:  [156/294] check agents_api.routers.users.get_user_details
    1474:  [157/294] check agents_api.routers.users.delete_user
    1475:  [158/294] check agents_api.routers.users.create_user
    1476:  [159/294] check agents_api.workflows.task_execution.__init__
    1477:  FAILED: /home/runner/work/julep/julep/agents-api/.pytype/pyi/agents_api/workflows/task_execution/__init__.pyi 
    1478:  /home/runner/work/julep/julep/agents-api/.venv/bin/python -m pytype.main --disable pyi-error --imports_info /home/runner/work/julep/julep/agents-api/.pytype/imports/agents_api.workflows.task_execution.__init__.imports --module-name agents_api.workflows.task_execution.__init__ --platform linux -V 3.12 -o /home/runner/work/julep/julep/agents-api/.pytype/pyi/agents_api/workflows/task_execution/__init__.pyi --analyze-annotated --nofail --none-is-not-bool --quick --strict-none-binding /home/runner/work/julep/julep/agents-api/agents_api/workflows/task_execution/__init__.py
    1479:  /home/runner/work/julep/julep/agents-api/agents_api/workflows/task_execution/__init__.py:405:13: error: in _handle_YieldStep: No attribute 'execution_input' on None [attribute-error]
    1480:  In Optional[agents_api.common.protocol.tasks.StepContext]
    1481:  self.context.execution_input,
    1482:  ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
    1483:  For more details, see https://google.github.io/pytype/errors.html#attribute-error
    ...
    
    1574:  [250/294] check agents_api.common.utils.__init__
    1575:  [251/294] check tests.test_nlp_utilities
    1576:  [252/294] check agents_api.__init__
    1577:  [253/294] check agents_api.rec_sum.__init__
    1578:  [254/294] check agents_api.metrics.__init__
    1579:  [255/294] check agents_api.activities.__init__
    1580:  [256/294] check agents_api.common.exceptions.agents
    1581:  [257/294] check tests.__init__
    1582:  ninja: build stopped: cannot make progress due to previous errors.
    1583:  Computing dependencies
    1584:  Generated API key since not set in the environment: 68799643113066178673842626642576
    1585:  Sentry DSN not found. Sentry will not be enabled.
    1586:  Analyzing 284 sources with 0 local dependencies
    1587:  Leaving directory '.pytype'
    1588:  ##[error]Process completed with exit code 1.
    

    @Vedantsahai18 Vedantsahai18 merged commit 37b42cb into dev Feb 15, 2025
    9 of 10 checks passed
    @Vedantsahai18 Vedantsahai18 deleted the x/docs-updates branch February 15, 2025 17:30
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Projects
    None yet
    Development

    Successfully merging this pull request may close these issues.

    1 participant