Skip to content

Commit

Permalink
fix
Browse files Browse the repository at this point in the history
  • Loading branch information
yuhaoran1214 committed Sep 21, 2024
1 parent ad1587d commit 0a755e5
Show file tree
Hide file tree
Showing 19 changed files with 230 additions and 230 deletions.
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -18,5 +18,5 @@
blank_issues_enabled: false
contact_links:
- name: Questions
url: https://github.com/apache/incubator-graphar/discussions
url: https://github.com/apache/graphar/discussions
about: Search for and ask questions on our github Discussions chat.
4 changes: 2 additions & 2 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
<!--
Thanks for contributing to GraphAr.
If this is your first pull request you can find detailed information on [CONTRIBUTING.md](https://github.com/apache/incubator-graphar/blob/main/CONTRIBUTING.md)
If this is your first pull request you can find detailed information on [CONTRIBUTING.md](https://github.com/apache/graphar/blob/main/CONTRIBUTING.md)
The Apache GraphAr (incubating) community has restrictions on the naming of pr title. You can find instructions in
[CONTRIBUTING.md](https://github.com/apache/incubator-graphar/blob/main/CONTRIBUTING.md#title) too.
[CONTRIBUTING.md](https://github.com/apache/graphar/blob/main/CONTRIBUTING.md#title) too.
-->

### Reason for this PR
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/java.yml
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@ jobs:
- name: Run test
working-directory: maven-projects/java
run: |
# Temporarily using Java 8, related issue: https://github.com/apache/incubator-graphar/issues/277
# Temporarily using Java 8, related issue: https://github.com/apache/graphar/issues/277
export JAVA_HOME=${JAVA_HOME_8_X64}
export LLVM11_HOME=/usr/lib/llvm-11
export GAR_TEST_DATA=$PWD/../../testing/
Expand Down
336 changes: 168 additions & 168 deletions CHANGELOG.md

Large diffs are not rendered by default.

8 changes: 4 additions & 4 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,8 +27,8 @@ We expect all community members to follow our [Code of Conduct](https://www.apac

## First Contribution

1. Ensure your change has an issue! Find an [existing issue](https://github.com/apache/incubator-graphar/issues) or [open a new issue](https://github.com/apache/incubator-graphar/issues/new).
1. [Fork the GraphAr repository](https://github.com/apache/incubator-graphar/fork) in your own GitHub account.
1. Ensure your change has an issue! Find an [existing issue](https://github.com/apache/graphar/issues) or [open a new issue](https://github.com/apache/graphar/issues/new).
1. [Fork the GraphAr repository](https://github.com/apache/graphar/fork) in your own GitHub account.
1. [Create a new Git branch](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/creating-and-deleting-branches-within-your-repository).
1. Make your changes.
1. [Submit the branch as a pull request](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request-from-a-fork) to the main GraphAr repo. An GraphAr team member should comment and/or review your pull request within a few days. Although, depending on the circumstances, it may take longer.
Expand All @@ -54,7 +54,7 @@ $ git checkout -b 42-add-chinese-translations
### GitHub Pull Requests

Once your changes are ready you must submit your branch as a [pull request](
https://github.com/apache/incubator-graphar/pulls)
https://github.com/apache/graphar/pulls)

#### Title

Expand Down Expand Up @@ -82,7 +82,7 @@ All pull requests should be reviewed by at least one GraphAr committer.
All pull requests are squash merged.
We generally discourage large pull requests that are over 300–500 lines of diff.
If you would like to propose a change that is larger, we suggest
coming onto our [Discussions](https://github.com/apache/incubator-graphar/discussions) and discussing it with us.
coming onto our [Discussions](https://github.com/apache/graphar/discussions) and discussing it with us.
This way we can talk through the solution and discuss if a change that large is even needed!
This will produce a quicker response to the change and likely produce code that aligns better with our process.

Expand Down
16 changes: 8 additions & 8 deletions README-zh-cn.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,13 +6,13 @@
</p>

[![GraphAr
CI](https://github.com/apache/incubator-graphar/actions/workflows/ci.yml/badge.svg)](https://github.com/apache/incubator-graphar/actions)
CI](https://github.com/apache/graphar/actions/workflows/ci.yml/badge.svg)](https://github.com/apache/graphar/actions)
[![Docs
CI](https://github.com/apache/incubator-graphar/actions/workflows/docs.yml/badge.svg)](https://github.com/apache/incubator-graphar/actions)
CI](https://github.com/apache/graphar/actions/workflows/docs.yml/badge.svg)](https://github.com/apache/graphar/actions)
[![GraphAr
Docs](https://img.shields.io/badge/docs-latest-brightgreen.svg)](https://graphar.apache.org/docs/)
[![Good First
Issue](https://img.shields.io/github/labels/apache/incubator-graphar/Good%20First%20Issue?color=green&label=Contribute)](https://github.com/apache/incubator-graphar/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22)
Issue](https://img.shields.io/github/labels/apache/graphar/Good%20First%20Issue?color=green&label=Contribute)](https://github.com/apache/graphar/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22)
[![README-en](https://shields.io/badge/README-English-blue)](README.md)

## GraphAr 项目简介
Expand Down Expand Up @@ -140,15 +140,15 @@ PySpark 库是作为 GraphAr Spark 库的绑定进行开发的。有关 PySpark

## 参与本项目

- 请参阅 [贡献指南](https://github.com/apache/incubator-graphar/blob/main/CONTRIBUTING.md)
- 提交 [Github Issue](https://github.com/apache/incubator-graphar/issues) 以报告错误或提出功能请求。
- 请参阅 [贡献指南](https://github.com/apache/graphar/blob/main/CONTRIBUTING.md)
- 提交 [Github Issue](https://github.com/apache/graphar/issues) 以报告错误或提出功能请求。
-[开发者邮件列表](mailto:[email protected])上讨论([订阅](mailto:[email protected]?subject=(send%20this%20email%20to%20subscribe)) / [取消订阅](mailto:[email protected]?subject=(send%20this%20email%20to%20unsubscribe)) / [归档](https://lists.apache.org/[email protected]))。
-[GitHub Discussion](https://github.com/apache/incubator-graphar/discussions/new?category=q-a) 中提出问题。
- 加入我们的 [两周一次的社区会议](https://github.com/apache/incubator-graphar/wiki/GraphAr-Community-Meeting)
-[GitHub Discussion](https://github.com/apache/graphar/discussions/new?category=q-a) 中提出问题。
- 加入我们的 [两周一次的社区会议](https://github.com/apache/graphar/wiki/GraphAr-Community-Meeting)

## 开源协议

**GraphAr** 遵循 [Apache License 2.0](https://github.com/apache/incubator-graphar/blob/main/LICENSE) 开源协议分发。同时请注意,某些依赖的第三方库可能采用了与 GraphAr 不同的开源许可协议。
**GraphAr** 遵循 [Apache License 2.0](https://github.com/apache/graphar/blob/main/LICENSE) 开源协议分发。同时请注意,某些依赖的第三方库可能采用了与 GraphAr 不同的开源许可协议。

## 论文

Expand Down
18 changes: 9 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,14 +6,14 @@
</p>

[![GraphAr
CI](https://github.com/apache/incubator-graphar/actions/workflows/ci.yml/badge.svg)](https://github.com/apache/incubator-graphar/actions)
CI](https://github.com/apache/graphar/actions/workflows/ci.yml/badge.svg)](https://github.com/apache/graphar/actions)
[![Docs
CI](https://github.com/apache/incubator-graphar/actions/workflows/docs.yml/badge.svg)](https://github.com/apache/incubator-graphar/actions)
[![codecov](https://codecov.io/gh/apache/incubator-graphar/graph/badge.svg)](https://codecov.io/gh/apache/incubator-graphar)
CI](https://github.com/apache/graphar/actions/workflows/docs.yml/badge.svg)](https://github.com/apache/graphar/actions)
[![codecov](https://codecov.io/gh/apache/graphar/graph/badge.svg)](https://codecov.io/gh/apache/graphar)
[![GraphAr
Docs](https://img.shields.io/badge/docs-latest-brightgreen.svg)](https://graphar.apache.org/docs/)
[![Good First
Issue](https://img.shields.io/github/labels/apache/incubator-graphar/Good%20First%20Issue?color=green&label=Contribute)](https://github.com/apache/incubator-graphar/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22)
Issue](https://img.shields.io/github/labels/apache/graphar/Good%20First%20Issue?color=green&label=Contribute)](https://github.com/apache/graphar/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22)
[![README-zh](https://shields.io/badge/README-%E4%B8%AD%E6%96%87-blue)](README-zh-cn.md)

## What is GraphAr?
Expand Down Expand Up @@ -240,16 +240,16 @@ for details about the PySpark library.

## Contributing

- Start with [Contributing Guide](https://github.com/apache/incubator-graphar/blob/main/CONTRIBUTING.md).
- Submit [Issues](https://github.com/apache/incubator-graphar/issues) for bug reports, feature requests.
- Start with [Contributing Guide](https://github.com/apache/graphar/blob/main/CONTRIBUTING.md).
- Submit [Issues](https://github.com/apache/graphar/issues) for bug reports, feature requests.
- Discuss at [dev mailing list](mailto:[email protected]) ([subscribe](mailto:[email protected]?subject=(send%20this%20email%20to%20subscribe)) / [unsubscribe](mailto:[email protected]?subject=(send%20this%20email%20to%20unsubscribe)) / [archives](https://lists.apache.org/[email protected])).
- Asking questions on [GitHub Discussions](https://github.com/apache/incubator-graphar/discussions/new?category=q-a).
- Join our [Biweekly Community Meeting](https://github.com/apache/incubator-graphar/wiki/GraphAr-Community-Meeting).
- Asking questions on [GitHub Discussions](https://github.com/apache/graphar/discussions/new?category=q-a).
- Join our [Biweekly Community Meeting](https://github.com/apache/graphar/wiki/GraphAr-Community-Meeting).

## License

**GraphAr** is distributed under [Apache License
2.0](https://github.com/apache/incubator-graphar/blob/main/LICENSE).
2.0](https://github.com/apache/graphar/blob/main/LICENSE).
Please note that third-party libraries may not have the same license as
GraphAr.

Expand Down
2 changes: 1 addition & 1 deletion cpp/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ All the instructions below assume that you have cloned the GraphAr git
repository and navigated to the ``cpp`` subdirectory with:

```bash
git clone https://github.com/apache/incubator-graphar.git
git clone https://github.com/apache/graphar.git
cd graphar/cpp
```

Expand Down
2 changes: 1 addition & 1 deletion docs/libraries/cpp/examples/bgl.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ in a graph. Learn more about [the CC
algorithm](https://en.wikipedia.org/wiki/Connected_component).

The source code of CC based on BGL can be found at
[bgl_example.cc](https://github.com/apache/incubator-graphar/blob/main/cpp/examples/bgl_example.cc).
[bgl_example.cc](https://github.com/apache/graphar/blob/main/cpp/examples/bgl_example.cc).
In this program, the graph information file is first read to get the
metadata:

Expand Down
14 changes: 7 additions & 7 deletions docs/libraries/cpp/examples/out-of-core.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ usually building blocks for constructing other graph algorithms.
[PageRank (PR)](https://en.wikipedia.org/wiki/PageRank) is an algorithm
used by Google Search to rank web pages in their search engine results.
The source code of PageRank based on GraphAr located at
[pagerank_example.cc](https://github.com/apache/incubator-graphar/blob/main/cpp/examples/pagerank_example.cc),
[pagerank_example.cc](https://github.com/apache/graphar/blob/main/cpp/examples/pagerank_example.cc),
and the explanations can be found in the [Getting
Started](../getting-started#a-pagerank-example) page.

Expand Down Expand Up @@ -80,13 +80,13 @@ for (int iter = 0; ; iter++) {
```
The file
[cc_stream_example.cc](https://github.com/apache/incubator-graphar/blob/main/cpp/examples/cc_stream_example.cc)
[cc_stream_example.cc](https://github.com/apache/graphar/blob/main/cpp/examples/cc_stream_example.cc)
located inside the source tree contains the complete implementation for
this algorithm. Also, we can only process active vertices (the vertices
which are updated in the last iteration) and the corresponding edges for
each iteration, since an inactive vertex does not need to update its
neighbors. Please refer to
[cc_push_example.cc](https://github.com/apache/incubator-graphar/blob/main/cpp/examples/cc_push_example.cc)
[cc_push_example.cc](https://github.com/apache/graphar/blob/main/cpp/examples/cc_push_example.cc)
for the complete code.
:::tip
Expand Down Expand Up @@ -152,17 +152,17 @@ for (int iter = 0; ; iter++) {

The above algorithm is implemented based on streaming all edges for each
iteration, the source code can be found at
[bfs_stream_example.cc](https://github.com/apache/incubator-graphar/blob/main/cpp/examples/bfs_stream_example.cc).
[bfs_stream_example.cc](https://github.com/apache/graphar/blob/main/cpp/examples/bfs_stream_example.cc).

Meanwhile, BFS could be implemented in a **push**-style which only
traverses the edges that from active vertices for each iteration, which
is typically more efficient on real-world graphs. This implementation
can be found at
[bfs_push_example.cc](https://github.com/apache/incubator-graphar/blob/main/cpp/examples/bfs_push_example.cc).
[bfs_push_example.cc](https://github.com/apache/graphar/blob/main/cpp/examples/bfs_push_example.cc).
Similarly, we provide a BFS implementation in a **pull**-style which
only traverses the edges that lead to non-visited vertices (i.e., the
vertices that have not been traversed), as shown in
[bfs_pull_example.cc](https://github.com/apache/incubator-graphar/blob/main/cpp/examples/bfs_pull_example.cc).
[bfs_pull_example.cc](https://github.com/apache/graphar/blob/main/cpp/examples/bfs_pull_example.cc).

:::tip

Expand All @@ -176,4 +176,4 @@ In some cases, it is required to record the path of BFS, that is, to
maintain each vertex's predecessor (also called *father*) in the
traversing tree rather than only recording the distance. The
implementation of BFS with recording fathers can be found at
[bfs_father_example.cc](https://github.com/apache/incubator-graphar/blob/main/cpp/examples/bfs_father_example.cc).
[bfs_father_example.cc](https://github.com/apache/graphar/blob/main/cpp/examples/bfs_father_example.cc).
2 changes: 1 addition & 1 deletion docs/libraries/cpp/examples/snap-to-graphar.md
Original file line number Diff line number Diff line change
Expand Up @@ -87,5 +87,5 @@ e_builder->Clear();

For comprehensive insights into this example, please consult the
accompanying [source
code](https://github.com/apache/incubator-graphar/tree/main/cpp/examples/snap_dataset_to_graphar.cc)
code](https://github.com/apache/graphar/tree/main/cpp/examples/snap_dataset_to_graphar.cc)
.
8 changes: 4 additions & 4 deletions docs/libraries/cpp/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ sidebar_position: 1

This article is a quick guide that explains how to work with GraphAr
C++. To begin with, please refer to the [Building
Steps](https://github.com/apache/incubator-graphar/blob/main/README.md#building-libraries)
Steps](https://github.com/apache/graphar/blob/main/README.md#building-libraries)
to install GraphAr.

## Information Files
Expand Down Expand Up @@ -146,7 +146,7 @@ as an example.
It is convenient to construct the graphar metadata and dump it to generate
information files. We provide an [example
program](https://github.com/apache/incubator-graphar/blob/main/cpp/examples/construct_info_example.cc)
program](https://github.com/apache/graphar/blob/main/cpp/examples/construct_info_example.cc)
located in the source code which shows how to construct and dump the
files for graph information, vertex information and edge information.
Expand Down Expand Up @@ -262,7 +262,7 @@ algorithms based on GraphAr which calculates the PageRank. Please look
[here](https://en.wikipedia.org/wiki/PageRank) if you want a detailed
explanation of the PageRank algorithm. And the source code can be found
at
[pagerank_example.cc](https://github.com/apache/incubator-graphar/blob/main/cpp/examples/pagerank_example.cc).
[pagerank_example.cc](https://github.com/apache/graphar/blob/main/cpp/examples/pagerank_example.cc).

This program first reads in the graph information file to obtain the
metadata; then, it constructs the vertex and edge collections to enable
Expand All @@ -285,6 +285,6 @@ AWS S3 and Alibaba Cloud OSS.
To read data from cloud storage, you can specify the path of the data files
with URI schema, e.g., "s3://bucket-name/path/to/data" or "s3://\[access-key:secret-key\]@bucket-name/path/to/data".

[Code example](https://github.com/apache/incubator-graphar/blob/main/cpp/test/test_info.cc#L777-L792) demonstrates how to read data from S3.
[Code example](https://github.com/apache/graphar/blob/main/cpp/test/test_info.cc#L777-L792) demonstrates how to read data from S3.

Note that once you use cloud storage, you need to call `graphar::InitializeS3` to initialize S3 APIs before starting the work and call`graphar::FinalizeS3()` to shut down the APIs after the work finish.
8 changes: 4 additions & 4 deletions docs/libraries/java/java.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ Make the graphar-java-library directory as the current working
directory:

```bash
git clone https://github.com/apache/incubator-graphar.git
git clone https://github.com/apache/graphar.git
cd incubator-graphar
git submodule update --init
cd maven-projects/java
Expand Down Expand Up @@ -119,7 +119,7 @@ if (!graphInfoResult.hasError()) {
```

See [test for
graphinfo](https://github.com/apache/incubator-graphar/blob/main/maven-projects/java/src/test/java/org/apache/incubator-graphar/graphinfo)
graphinfo](https://github.com/apache/graphar/blob/main/maven-projects/java/src/test/java/org/apache/graphar/graphinfo)
for the complete example.

### Writers
Expand Down Expand Up @@ -176,7 +176,7 @@ writer.sortAndWriteAdjListTable(table, 0, 0); // Write adj list of vertex chunk
```

See [test for
writers](https://github.com/apache/incubator-graphar/blob/main/maven-projects/java/src/test/java/org/apache/incubator-graphar/writers)
writers](https://github.com/apache/graphar/blob/main/maven-projects/java/src/test/java/org/apache/graphar/writers)
for the complete example.

### Readers
Expand Down Expand Up @@ -210,5 +210,5 @@ StdPair<Long, Long> range = reader.getRange().value();
```

See [test for
readers](https://github.com/apache/incubator-graphar/blob/main/maven-projects/java/src/test/java/org/apache/incubator-graphar/readers)
readers](https://github.com/apache/graphar/blob/main/maven-projects/java/src/test/java/org/apache/graphar/readers)
for the complete example.
Loading

0 comments on commit 0a755e5

Please sign in to comment.