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

Add support for async DocParse calls in aryn-sdk #1116

Merged
merged 58 commits into from
Jan 24, 2025

Conversation

MarkLindblad
Copy link
Contributor

No description provided.

@MarkLindblad MarkLindblad marked this pull request as draft January 16, 2025 21:53
@MarkLindblad MarkLindblad marked this pull request as ready for review January 18, 2025 02:51
@MarkLindblad
Copy link
Contributor Author

MarkLindblad commented Jan 18, 2025

Some of the aryn-sdk tests currently check for exact matches of DocParse partitioned output. Since floating point calculations are nondeterministic, we will want to fix this in a future pr so we don't falsely think a regression occurred.

Copy link
Collaborator

@HenryL27 HenryL27 left a comment

Choose a reason for hiding this comment

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

ship it!

@MarkLindblad MarkLindblad merged commit 017db20 into main Jan 24, 2025
12 of 15 checks passed
@MarkLindblad MarkLindblad deleted the mark/add-async-to-aryn-sdk branch January 24, 2025 17:02
Copy link
Contributor

@alexaryn alexaryn left a comment

Choose a reason for hiding this comment

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

Overall much cleaner. Still some things we should change.

A dictionary containing "job_id" which can be used with the `partition_file_result_async`
function to get the results.

Single Job Example:
Copy link
Contributor

Choose a reason for hiding this comment

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

There's still too much and it's too duplicated. It's not standard to have multiple examples in a function's docstring. If an example is needed at all, make it the simple one, and leave out the obvious imports. We don't need both use_ocr and extract_table_structure demonstrated.

The multi-job example is more complicated and such things are usually included only in a user guide or README.

The problem here is that when people encounter a wall of text, they don't read it. They either skip it, or assume the thing is too complicated and run away. The secondary problem is maintenance. Engineers modifying code often neglect to update the docstrings, and the bigger the job, the more they neglect. Updating the README will be even less likely, but there's a chance if the docstring says "For examples of usage see README.md". When documentation (or code) is duplicated, there's a high chance it will diverge.

@MarkLindblad MarkLindblad restored the mark/add-async-to-aryn-sdk branch January 24, 2025 21:46
@MarkLindblad
Copy link
Contributor Author

Further work on async DocParse via the aryn-sdk has been moved here: #1134

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.

4 participants