The usage of options is explained in the user guide. This document provides more explanations on how developers work with options internally.
Options are stored as a dictionary in the
Each option name is its key in the dictionary.
The value of the option is an instance of an
Options object has the following attributes:
value: the current value of the option
description: a text description of the option
validator: a boolean function that returns
Developers can use
cudf.options._register_option to add options to the dictionary.
cudf.get_option() is provided to get option values from the dictionary.
When testing the behavior of a certain option,
it is advised to use
yield fixture to set up and clean up the option.
See the API reference for more details.