Add document for Docset readers and writers. #196
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
jonfritz
reviewed
Dec 19, 2023
| """ | ||
| Read data from different kinds of sources into DocSet. | ||
|
|
||
| DocSetReader is exposed through sycamore context read API. |
There was a problem hiding this comment.
Sycamore should be capitalized
jonfritz
reviewed
Dec 19, 2023
| @@ -71,13 +99,43 @@ def json( | |||
| return DocSet(self._context, json_scan) | |||
|
|
|||
| def arrow(self, tables: Union[Table, bytes, list[Union[Table, bytes]]]) -> DocSet: | |||
| """ | |||
| Scan arrow data into a DocSet | |||
There was a problem hiding this comment.
Arrow should be capitalized
jonfritz
requested changes
Dec 19, 2023
| def __init__(self, context: Context, plan: Node): | ||
| self.context = context | ||
| self.plan = plan | ||
|
|
||
| def opensearch( | ||
| self, *, os_client_args: dict, index_name: str, index_settings: Optional[dict] = None, **resource_args | ||
| ) -> None: | ||
| from sycamore.writers import OpenSearchWriter | ||
| """Write a docset into opensearch |
There was a problem hiding this comment.
DocSet caps? OpenSearch caps
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Test the generate Sphinx htmls locally.