Skip to content

Commit

Permalink
[Doc] Update gconstruct configuration doc to clarify the usage of two…
Browse files Browse the repository at this point in the history
… boolean arguments (#876)

*Issue #, if available:*

*Description of changes:*
This PR update the gconstruction documents, clarifying the explanation
of the two boolean arguments.

By submitting this pull request, I confirm that you can use, modify,
copy, and redistribute this contribution, under the terms of your
choice.

---------

Co-authored-by: Ubuntu <[email protected]>
Co-authored-by: jalencato <[email protected]>
  • Loading branch information
3 people authored Jun 14, 2024
1 parent 0af2213 commit 92f7813
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions docs/source/configuration/configuration-gconstruction.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,8 @@ Graph Construction
* **-\-num-processes-for-edges**: the number of processes to process edge data simulteneously. Increase this number can speed up edge data processing.
* **-\-output-dir**: (**Required**) the path of the output data files.
* **-\-graph-name**: (**Required**) the name assigned for the graph.
* **-\-remap-node-id**: boolean value to decide whether to rename node IDs or not. Default is true.
* **-\-add-reverse-edges**: boolean value to decide whether to add reverse edges for the given graph. Default is true.
* **-\-remap-node-id**: boolean value to decide whether to rename node IDs or not. Adding this argument will set it to be true, otherwise false.
* **-\-add-reverse-edges**: boolean value to decide whether to add reverse edges for the given graph. Adding this argument will set it to be true, otherwise false.
* **-\-output-format**: the format of constructed graph, options are ``DGL``, ``DistDGL``. Default is ``DistDGL``. It also accepts multiple graph formats at the same time separated by an space, for example ``--output-format "DGL DistDGL"``. The output format is explained in the :ref:`Output <output-format>` section below.
* **-\-num-parts**: the number of partitions of the constructed graph. This is only valid if the output format is ``DistDGL``.
* **-\-skip-nonexist-edges**: boolean value to decide whether skip edges whose endpoint nodes don't exist. Default is true.
Expand Down

0 comments on commit 92f7813

Please sign in to comment.