Additional updates to parallelism docs #453
Conversation
elijahbenizzy
force-pushed
the
improve-parallelism-docs
branch
from
87bb48e to
95c5a8c
Compare
![ellipsis-dev[bot]](https://avatars.githubusercontent.com/in/64358?s=60&v=4){kind=small}
There was a problem hiding this comment.
❌ Changes requested. Incremental review on 95c5a8c in 28 seconds
More details
- Looked at
120lines of code in2files - Skipped
0files when reviewing. - Skipped posting
0drafted comments based on config settings.
Workflow ID: wflow_Hg452Bk5TmtutZBO
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.
docs/concepts/parallelism.rst
Outdated
| return ["prompts"] + super().inputs # make sure to include the superclass inputs | ||
|
|
||
| def states(self, state: State, context: ApplicationContext, inputs: Dict[str, Any]) -> Generator[Tuple[State, dict], None, None]: | ||
| for prompt in inputs["prompts"] |
There was a problem hiding this comment.
Missing colon at the end of the for loop.
| for prompt in inputs["prompts"] | |
| for prompt in inputs["prompts"]: |
|
A preview of 6abea5c is uploaded and can be seen here: ✨ https://burr.dagworks.io/pull/453 ✨ Changes may take a few minutes to propagate. Since this is a preview of production, content with |
elijahbenizzy
force-pushed
the
improve-parallelism-docs
branch
from
95c5a8c to
be539f1
Compare
More updates to make API consistent: 1. Showing inputs for class-based action (repeat but good to hammer home) 2. Making API consistent
There was a problem hiding this comment.
❌ Changes requested. Incremental review on be539f1 in 50 seconds
More details
- Looked at
129lines of code in2files - Skipped
0files when reviewing. - Skipped posting
2drafted comments based on config settings.
1. docs/concepts/parallelism.rst:167
- Draft comment:
Thestatemethod should includecontextandinputsparameters for consistency.
def state(self, state: State, context: ApplicationContext, inputs: Dict[str, Any]) -> State:
- Reason this comment was not posted:
Marked as duplicate.
2. docs/concepts/parallelism.rst:375
- Draft comment:
Theactionmethod should includestate,context, andinputsparameters for consistency.
def action(self, state: State, context: ApplicationContext, inputs: Dict[str, Any]) -> Action | Callable | RunnableGraph:
- Reason this comment was not posted:
Marked as duplicate.
Workflow ID: wflow_zXaGU9PCJHfDxls2
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.
elijahbenizzy
force-pushed
the
improve-parallelism-docs
branch
from
be539f1 to
6abea5c
Compare
There was a problem hiding this comment.
👍 Looks good to me! Incremental review on 6abea5c in 31 seconds
More details
- Looked at
129lines of code in2files - Skipped
0files when reviewing. - Skipped posting
1drafted comments based on config settings.
1. docs/concepts/parallelism.rst:81
- Draft comment:
Avoid usingpdb.set_trace()in production code as it can halt execution unexpectedly. Consider using logging or other debugging techniques instead. - Reason this comment was not posted:
Comment was on unchanged code.
Workflow ID: wflow_94hIhZblzAggb8pe
You can customize Ellipsis with 👍 / 👎 feedback, review rules, user-specific overrides, quiet mode, and more.
More updates to make API consistent:
Important
Updates parallelism documentation for consistent API and input handling, with minor debugging code addition.
parallelism.rst.inputsproperty examples inparallelism.rstfor parallel actions.actions.rstto reinforce class-based action inputs.pdb.set_trace()inrun_and_update()inparallelism.pyfor debugging.This description was created by
for 6abea5c. It will automatically update as commits are pushed.