From 92f78137d5ef53e9b74309fd6e710b93ad2bd1e8 Mon Sep 17 00:00:00 2001 From: "Jian Zhang (James)" <6593865@qq.com> Date: Thu, 13 Jun 2024 17:21:25 -0700 Subject: [PATCH] [Doc] Update gconstruct configuration doc to clarify the usage of two 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 Co-authored-by: jalencato --- docs/source/configuration/configuration-gconstruction.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/source/configuration/configuration-gconstruction.rst b/docs/source/configuration/configuration-gconstruction.rst index c210819ff8..6df44c96e9 100644 --- a/docs/source/configuration/configuration-gconstruction.rst +++ b/docs/source/configuration/configuration-gconstruction.rst @@ -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 ` 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.