From fd007eec984374188442edf91719d3c5ae5824c5 Mon Sep 17 00:00:00 2001 From: Tianyu Liu Date: Wed, 30 Oct 2024 14:08:27 -0400 Subject: [PATCH] Adjust comment and doc --- cpp/include/cudf/io/config_utils.hpp | 6 +++--- docs/cudf/source/user_guide/io/io.md | 7 +++---- 2 files changed, 6 insertions(+), 7 deletions(-) diff --git a/cpp/include/cudf/io/config_utils.hpp b/cpp/include/cudf/io/config_utils.hpp index 864f76c57b7..070b59a117c 100644 --- a/cpp/include/cudf/io/config_utils.hpp +++ b/cpp/include/cudf/io/config_utils.hpp @@ -37,11 +37,11 @@ bool is_gds_enabled(); bool is_kvikio_enabled(); /** - * @brief Set kvikIO parameters, including: + * @brief Set KvikIO parameters, including: + * - Compatibility mode, according to the environment variable KVIKIO_COMPAT_MODE. If + * KVIKIO_COMPAT_MODE is not set, enable it by default, which enforces the use of POSIX I/O. * - Thread pool size, according to the environment variable KVIKIO_NTHREADS. If KVIKIO_NTHREADS is * not set, use 4 threads by default. - * - Compatibility mode, according to the environment variable KVIKIO_COMPAT_MODE. If - * KVIKIO_COMPAT_MODE is not set, set it to ON by default. */ void set_up_kvikio(); diff --git a/docs/cudf/source/user_guide/io/io.md b/docs/cudf/source/user_guide/io/io.md index c0a1b803a11..ea5dcc2b601 100644 --- a/docs/cudf/source/user_guide/io/io.md +++ b/docs/cudf/source/user_guide/io/io.md @@ -101,10 +101,9 @@ There are four valid values for the environment variable: fall back to the GDS compatibility mode. - "ALWAYS": Enable GDS use. If the cuFile library cannot be properly loaded, throw an exception. -- "KVIKIO": Enable GDS through [KvikIO](https://github.com/rapidsai/kvikio). Note -that if the environment variable `KVIKIO_COMPAT_MODE` is `ON`, or if KvikIO detects -that the system is not properly configured for GDS, the I/O will fall back to the -GDS compatibility mode. +- "KVIKIO": Enable GDS through [KvikIO](https://github.com/rapidsai/kvikio). If +KvikIO detects that the system is not properly configured for GDS, the I/O will +fall back to the GDS compatibility mode. - "OFF": Completely disable GDS use. If no value is set, behavior will be the same as the "KVIKIO" option.