Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Fix parallel docs #450

Merged
merged 2 commits into from
Dec 4, 2024
Merged

Fix parallel docs #450

merged 2 commits into from
Dec 4, 2024

Conversation

skrawcz
Copy link
Contributor

@skrawcz skrawcz commented Dec 4, 2024

Docs were missing parameters. This fixes that. Also fixes notebook and one minor bug about assuming a tracker was always present.

Changes

  • docs
  • one fix for parallel tracker check

How I tested this

  • locally

Notes

Checklist

  • PR has an informative and human-readable title (this will be pulled into the release notes)
  • Changes are limited to a single goal (no scope creep)
  • Code passed the pre-commit check & code is left cleaner/nicer than when first encountered.
  • Any change in functionality is tested
  • New functions are documented (with a description, list of inputs, and expected output)
  • Placeholder code is flagged / future TODOs are captured in comments
  • Project documentation has been updated if adding/changing functionality.

@skrawcz skrawcz requested a review from elijahbenizzy December 4, 2024 00:44
Copy link

@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.

👍 Looks good to me! Reviewed everything up to 0ccbf06 in 26 seconds

More details
  • Looked at 280 lines of code in 2 files
  • Skipped 1 files when reviewing.
  • Skipped posting 4 drafted comments based on config settings.
1. burr/core/parallelism.py:153
  • Draft comment:
    The reduce method signature has been updated to include the state parameter. Ensure that this change is consistently applied across all relevant classes and methods.
  • Reason this comment was not posted:
    Comment did not seem useful.
2. docs/concepts/parallelism.rst:101
  • Draft comment:
    The reduce method signature has been updated to include the state parameter. Ensure that this change is consistently applied across all relevant classes and methods.
  • Reason this comment was not posted:
    Marked as duplicate.
3. burr/core/parallelism.py:306
  • Draft comment:
    The actions and states method signatures have been updated to include context and inputs parameters. Ensure that this change is consistently applied across all relevant classes and methods.
  • Reason this comment was not posted:
    Comment did not seem useful.
4. docs/concepts/parallelism.rst:226
  • Draft comment:
    The actions and states method signatures have been updated to include context and inputs parameters. Ensure that this change is consistently applied across all relevant classes and methods.
  • Reason this comment was not posted:
    Marked as duplicate.

Workflow ID: wflow_p7L5r1tvYLuCDU67


You can customize Ellipsis with 👍 / 👎 feedback, review rules, user-specific overrides, quiet mode, and more.

Copy link

github-actions bot commented Dec 4, 2024

A preview of 0478eb3 is uploaded and can be seen here:

https://burr.dagworks.io/pull/450

Changes may take a few minutes to propagate. Since this is a preview of production, content with draft: true will not be rendered. The source is here: https://github.com/DAGWorks-Inc/burr/tree/gh-pages/pull/450/

The example did not have the correct method signatures.
To have correct function signatures.
@skrawcz skrawcz merged commit 7c5c131 into main Dec 4, 2024
11 checks passed
@skrawcz skrawcz deleted the fix_parallel_docs branch December 4, 2024 01:33
# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants