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][C++][Doc] Add examples and tutorials about how to use the C++ Reader/Writer #205

Closed
lixueclaire opened this issue Jul 17, 2023 · 1 comment
Assignees
Labels
Component:Documentation Improvements or additions to documentation enhancement New feature or request

Comments

@lixueclaire
Copy link
Contributor

lixueclaire commented Jul 17, 2023

Is your feature request related to a problem? Please describe.
The C++ Reader/Writer is the most fundamental tools in the library of GraphAr. Currently, there are not enough resources for beginners to learn about how to use the C++ Reader/Writer. Although we have provided unit tests and API reference, they are not intuitive.

Describe the solution you'd like
Add corresponding examples in this directory refer to the tests, and add some tutorials in the documentation.

Additional context
related to #168

@lixueclaire lixueclaire added Component:Documentation Improvements or additions to documentation enhancement New feature or request help wanted Extra attention is needed and removed help wanted Extra attention is needed labels Jul 17, 2023
@lixueclaire lixueclaire self-assigned this Sep 28, 2023
@lixueclaire
Copy link
Contributor Author

lixueclaire commented Sep 28, 2023

Add examples under this directory about how to use C++ reader/writer.
We can refer to the examples provided by Arrow/Parquet.
These four examples are required in the first step:

  • low_level_reader_example.cc
  • mid_level_reader_example.cc
  • mid_level_writer_example.cc

Optionally, add high-level examples:

  • high_level_reader_example.cc
  • high_level_writer_example.cc

High-level examples are optional since they are already included in the examples of out-of-core graph algorithms like PageRank, BFS and CC.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Component:Documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants