Functions
IO Configuration

Functions

void cudf::io::kvikio_integration::set_up_kvikio (std::optional< uint32_t > nthreads=std::nullopt)
 Set KvikIO parameters. More...
 
bool cudf::io::nvcomp_integration::is_all_enabled ()
 Returns true if all nvCOMP uses are enabled. More...
 
bool cudf::io::nvcomp_integration::is_stable_enabled ()
 Returns true if stable nvCOMP use is enabled. More...
 
bool cudf::io::integrated_memory_optimization::is_enabled ()
 Returns true if integrated memory optimizations are enabled. More...
 

Detailed Description

Function Documentation

◆ is_all_enabled()

bool cudf::io::nvcomp_integration::is_all_enabled ( )

#include <cudf/io/config_utils.hpp>

Returns true if all nvCOMP uses are enabled.

Returns
true if all nvCOMP uses are enabled

◆ is_enabled()

bool cudf::io::integrated_memory_optimization::is_enabled ( )

#include <cudf/io/config_utils.hpp>

Returns true if integrated memory optimizations are enabled.

Controlled by the LIBCUDF_INTEGRATED_MEMORY_OPTIMIZATION environment variable. Valid values: "AUTO" (default), "ON", "OFF"

  • AUTO: Use hardware detection (cudaDevAttrIntegrated)
  • ON: Always enable optimization
  • OFF: Always disable optimization
Returns
true if integrated memory optimizations are enabled

◆ is_stable_enabled()

bool cudf::io::nvcomp_integration::is_stable_enabled ( )

#include <cudf/io/config_utils.hpp>

Returns true if stable nvCOMP use is enabled.

Returns
true true if stable nvCOMP use is enabled

◆ set_up_kvikio()

void cudf::io::kvikio_integration::set_up_kvikio ( std::optional< uint32_t >  nthreads = std::nullopt)

#include <cudf/io/config_utils.hpp>

Set KvikIO parameters.

Parameters include:

  • 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. If nthreads is provided, it is used directly. Otherwise, the value is read from the environment variable KVIKIO_NTHREADS, defaulting to 4 if unset.
Parameters
nthreadsOptional thread pool size override. If provided, supersedes KVIKIO_NTHREADS.