-
Notifications
You must be signed in to change notification settings - Fork 76
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
Updates docs to handle async persister case #496
Conversation
- Clarifies the concepts to be more relevant to Burr - Adds docs for async persister in the references
There was a problem hiding this 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 7e0792f in 13 seconds
More details
- Looked at
183
lines of code in3
files - Skipped
0
files when reviewing. - Skipped posting
3
drafted comments based on config settings.
1. docs/concepts/sync-vs-async.rst:10
- Draft comment:
Typo: 'avaialble' should be 'available'.
1. Use the `async` interfaces when you have I/O-heavy applications that require horizontal scaling, and have available asynchronous APIs (E.G. async LLM APIs)
- Reason this comment was not posted:
Confidence changes required:10%
The word 'avaialble' is misspelled and should be corrected to 'available'.
2. docs/concepts/sync-vs-async.rst:43
- Draft comment:
Typo: 'suports' should be 'supports'.
are missing a specific implementation). Furthermore, Burr supports the following APIs for both synchronous/asynchronous interfaces:
- Reason this comment was not posted:
Confidence changes required:10%
The word 'suports' is misspelled and should be corrected to 'supports'.
3. docs/concepts/sync-vs-async.rst:53
- Draft comment:
Typo: 'bellow' should be 'below'.
legacy code, ...) and we give some options to handle that. The table below shows the
- Reason this comment was not posted:
Confidence changes required:10%
The word 'bellow' is misspelled and should be corrected to 'below'.
Workflow ID: wflow_STStILKNcOgfuj1E
You can customize Ellipsis with 👍 / 👎 feedback, review rules, user-specific overrides, quiet
mode, and more.
A preview of 5c18047 is uploaded and can be seen here: ✨ https://burr.dagworks.io/pull/496 ✨ Changes may take a few minutes to propagate. Since this is a preview of production, content with |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
added more specificity - since the language is ambiguous by what "application" is being referred to...
Co-authored-by: Stefan Krawczyk <[email protected]>
Important
Updates documentation to clarify sync vs async usage and add async persister references in Burr.
sync-vs-async.rst
.persister.rst
.AsyncBaseStatePersister
,AsyncBaseStateLoader
, andAsyncBaseStateSaver
classes.index.rst
to be more relevant to Burr.This description was created by for 7e0792f. It will automatically update as commits are pushed.