docs(python): improve Python SDK documentation#931
Merged
Conversation
Iskander14yo
commented
Jun 3, 2026
|
|
||
| Wish you a happy use！ No newline at end of file | ||
| | --------------------------------- | -------------------- | | ||
| | `graphar.vertex_chunk_size` | `100` | |
Contributor
Author
There was a problem hiding this comment.
From this link vertex and edge chunk sizes are recommended to be 2^18 and 2^22 correspondingly. Should we correct values here?
Iskander14yo
commented
Jun 3, 2026
| ## Import config file | ||
| ## Usage | ||
|
|
||
| The config file supports `yaml` data type. We provide two reference templates for it: full and mini. |
Contributor
Author
There was a problem hiding this comment.
Can you please point me to these templates? I think it's better to have links to them (if this info is not outdated) or delete this block otherwise (what I did).
Member
SemyonSinchenko
added
the
Component:Documentation
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
Reason for this PR
Improve the Python SDK documentation for first-time users.
Particularly, this updates the Python README and CLI README to clarify installation, quick-start usage, examples, test data setup, CLI commands, and import config behavior.
What changes are included in this PR?
GAR_TEST_DATAfor examples and tests.Are these changes tested?
No.
Are there any user-facing changes?
Both Python's READMEs are updated.
Checklist
make cpplintbefore submitting when changed files are in thecppdirectory.pre-commit runbefore commit the changed files.