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

Parallelism example #426

Merged
merged 2 commits into from
Nov 19, 2024
Merged

Parallelism example #426

merged 2 commits into from
Nov 19, 2024

Conversation

elijahbenizzy
Copy link
Contributor

@elijahbenizzy elijahbenizzy commented Nov 19, 2024

Need an example for parallelism -- this will be fixed up a bit later but I want to push out now

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

Important

Add parallelism example documentation and update get_source() in burr/core/action.py to handle exceptions.

  • Behavior:
    • Update get_source() in burr/core/action.py to return "No source available" if an exception occurs.
  • Documentation:
    • Add examples/parallelism/README.md to introduce Burr's parallelism capabilities with links to a notebook and a Loom video.
  • Misc:
    • Add "parallelism" to FILTERLIST in validate_examples.py to temporarily exclude it from validation.

This description was created by Ellipsis for 8100c66. It will automatically update as commits are pushed.

TBD why this is happening, but this is OK for now.
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.

❌ Changes requested. Reviewed everything up to 4181b44 in 52 seconds

More details
  • Looked at 30 lines of code in 2 files
  • Skipped 1 files when reviewing.
  • Skipped posting 0 drafted comments based on config settings.

Workflow ID: wflow_iyE25ZZL5dPwaeGL


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.

return inspect.getsource(self.__class__)
try:
return inspect.getsource(self.__class__)
except Exception:
Copy link

Choose a reason for hiding this comment

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

Catching a broad Exception is not recommended as it can mask other issues. Consider catching specific exceptions like OSError or TypeError.

Suggested change
except Exception:
except OSError:

Copy link

github-actions bot commented Nov 19, 2024

A preview of 8100c66 is uploaded and can be seen here:

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

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/426/

@elijahbenizzy elijahbenizzy merged commit 5f3df0b into main Nov 19, 2024
11 checks passed
@elijahbenizzy elijahbenizzy deleted the parallelism-example branch November 19, 2024 05:36
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! Incremental review on 8100c66 in 8 seconds

More details
  • Looked at 26 lines of code in 2 files
  • Skipped 1 files when reviewing.
  • Skipped posting 1 drafted comments based on config settings.
1. examples/validate_examples.py:28
  • Draft comment:
    Consider marking this comment as a TODO for clarity, as it indicates a temporary state.
  • Reason this comment was not posted:
    Confidence changes required: 50%
    The comment on line 28 indicates that the 'parallelism' directory is temporarily in the FILTERLIST and should be removed later. This is a placeholder comment and should be marked as a TODO for clarity.

Workflow ID: wflow_wbSYUXmrYvQq0qQd


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

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.

1 participant