-
Notifications
You must be signed in to change notification settings - Fork 48
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 document for Docset readers and writers. #196
base: main
Are you sure you want to change the base?
Conversation
""" | ||
Read data from different kinds of sources into DocSet. | ||
|
||
DocSetReader is exposed through sycamore context read API. |
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.
Sycamore should be capitalized
@@ -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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Arrow should be capitalized
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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
DocSet caps? OpenSearch caps
Test the generate Sphinx htmls locally.