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

[Feat][Doc] Refactor and update the format specification document #387

Merged
merged 6 commits into from
Mar 13, 2024

Conversation

acezen
Copy link
Contributor

@acezen acezen commented Mar 4, 2024

Proposed changes

Refactor and update the format specification document

  • Add concepts to explain relevant concepts and terms.
  • Refine file-format.rst to give more detail of GraphAr format
  • Update the status: c++ support Date and Timestamp
  • Add format & libraries feature update workflow to contributing guide

Checklist

Put an x in the boxes that apply. You can also fill these out after creating the PR. If you're unsure about any of them, don't hesitate to ask. We're here to help! This is simply a reminder of what we are going to look for before merging your code.

  • I have read the CONTRIBUTING doc
  • I have signed the CLA
  • Lint and unit tests pass locally with my changes
  • I have added tests that prove my fix is effective or that my feature works
  • I have added necessary documentation (if appropriate)

Further comments

close #362

@Thespica
Copy link
Contributor

Thespica commented Mar 5, 2024

Hi, @acezen . I think we can highlight the benefits of splitting vertices/edges into chunks and splitting properties into property_groups (why we split that) for a little list, like:

1. Random access querying without reading all data from the file.
2. Appending data without modifying the existing files(or need only modifying the last chunk).

Maybe the third point: convenience for parallel reading.

@acezen acezen marked this pull request as ready for review March 12, 2024 11:05
Copy link
Member

@SemyonSinchenko SemyonSinchenko left a comment

Choose a reason for hiding this comment

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

Looks cool! One question: as I see, Timestamp and Date are already supported in #398, maybe we can update status.rst in this PR? Or it will be a separated PR?

@acezen
Copy link
Contributor Author

acezen commented Mar 13, 2024

Looks cool! One question: as I see, Timestamp and Date are already supported in #398, maybe we can update status.rst in this PR? Or it will be a separated PR?

Thanks for pointing out, I will update the status.rst in this PR.

@acezen acezen requested a review from lixueclaire March 13, 2024 01:53
Signed-off-by: acezen <qiaozi.zwb@alibaba-inc.com>
Signed-off-by: acezen <qiaozi.zwb@alibaba-inc.com>
@acezen acezen merged commit abfa385 into apache:main Mar 13, 2024
2 checks passed
@acezen acezen deleted the 362-file-format-doc branch March 13, 2024 06:04
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.

[Feat][Format] Format Specification as part of docs
3 participants