Options and settings

cudf.get_option(name)	Get the value of option.
cudf.set_option(name, val)	Set the value of option.
cudf.describe_option([name])	Prints the description of an option.
cudf.option_context(*args)	Context manager to temporarily set options in the with statement context.

Display options are controlled by pandas

Options for display are inherited from pandas. This includes commonly accessed options such as:

• display.max_columns

• display.max_info_rows

• display.max_rows

• display.max_seq_items

For example, to show all rows of a DataFrame or Series in a Jupyter notebook, call pandas.set_option("display.max_rows", None).

See also the full list of pandas display options.

Available options

You can get a list of available options and their descriptions with describe_option(). When called with no argument describe_option() will print out the descriptions for all available options.

In [1]: import cudf

In [2]: cudf.describe_option()
default_integer_bitwidth:
	
Default bitwidth when the dtype of an integer needs to be
inferred. If set to `None`, the API will align dtype with pandas.
APIs that respect this option include:
	- cudf object constructors
	- cudf.read_csv and cudf.read_json when `dtype` is not specified.
	- APIs that require implicit conversion of cudf.RangeIndex to an
	  integer index.
	Valid values are  None, 32 or 64. Default is None.

	[Default: None] [Current: None]
default_float_bitwidth:
	
Default bitwidth when the dtype of a float needs to be
inferred. If set to `None`, the API will align dtype with pandas.
APIs that respect this option include:
	- cudf object constructors
	- cudf.read_csv and cudf.read_json when `dtype` is not specified.
	Valid values are None, 32 or 64. Default is None.

	[Default: None] [Current: None]
spill:
	
Enables spilling.
	Valid values are True or False. Default is False.

	[Default: False] [Current: False]
copy_on_write:
	
If set to `False`, disables copy-on-write.
If set to `True`, enables copy-on-write.
Read more at: :ref:`copy-on-write-user-doc`
	Valid values are True or False. Default is False.

	[Default: False] [Current: False]
spill_on_demand:
	
Enables spilling on demand using an RMM out-of-memory error handler.
This has no effect if spilling is disabled, see the "spill" option.
	Valid values are True or False. Default is True.

	[Default: True] [Current: True]
spill_device_limit:
	
Enforce a device memory limit in bytes.
This has no effect if spilling is disabled, see the "spill" option.
	Valid values are any positive integer or None (disabled).
	Default is None.

	[Default: None] [Current: None]
spill_stats:
	
If not 0, enables statistics at the specified level:
    0  - disabled (no overhead).
    1+ - duration and number of bytes spilled (very low overhead).
    2+ - a traceback for each time a spillable buffer is exposed
        permanently (potential high overhead).

Valid values are any positive integer.
Default is 0 (disabled).

	[Default: 0] [Current: 0]
mode.pandas_compatible:
	
If set to `False`, retains `cudf` specific behavior.
If set to `True`, enables pandas compatibility mode,
which will try to match pandas API behaviors in case of
any inconsistency.
	Valid values are True or False. Default is False.

	[Default: False] [Current: False]
memory_profiling:
	
If set to `False`, disables memory profiling.
If set to `True`, enables memory profiling.
Read more at: :ref:`memory-profiling-user-doc`
	Valid values are True or False. Default is False.

	[Default: False] [Current: False]
io.parquet.low_memory:
	
If set to `False`, reads entire parquet in one go.
If set to `True`, reads parquet file in chunks.
	Valid values are True or False. Default is False.

	[Default: False] [Current: False]
io.json.low_memory:
	
If set to `False`, reads entire json in one go.
If set to `True`, reads json file in chunks.
	Valid values are True or False. Default is False.

	[Default: False] [Current: False]
kvikio_remote_io:
	
Whether to use KvikIO's remote IO backend or not.
	WARN: this is experimental and may be removed at any time
	without warning or deprecation period.
	Set KVIKIO_NTHREADS (default is 8) to change the number of
	concurrent tcp connections, which is important for good performance.
	Valid values are True or False. Default is False.

	[Default: False] [Current: False]