lux._config.config.Config¶

class lux._config.config.Config[source]¶

Class for Lux configurations applied globally across entire session

__init__()[source]¶: Initialize self. See help(type(self)) for accurate signature.

Methods

`__init__`()	Initialize self.
`read_query_template`(query_template)
`register_action`(name, action, Any] = None, …)	Registers the provided action globally in lux
`remove_action`(name)	Removes the provided action globally in lux
`set_SQL_connection`(connection)	Sets SQL connection to a database
`set_executor_type`(exe)

Attributes

`default_display`	Set the widget display to show Pandas by default or Lux by default :param type: Default display type, can take either the string lux or pandas (regardless of capitalization) :type type: str
`heatmap`	param heatmap_flag: Whether or not a heatmap will be used instead of a scatter plot.
`interestingness_fallback`
`label_len`
`number_of_bars`
`pandas_fallback`
`plotting_backend`
`plotting_scale`
`sampling`	param sample_flag: Whether or not sampling will occur.
`sampling_cap`	param sample_number: Cap on the number of rows to sample.
`sampling_start`	param sample_number: Number of rows required to begin sampling.
`sort`
`topk`

register_action(name: str = '', action: Callable[[Any], Any] = None, display_condition: Optional[Callable[[Any], Any]] = None, *args) → None[source]¶

Registers the provided action globally in lux

Parameters:	name (str) – the name of the action action (Callable[[Any], Any]) – the function used to generate the recommendations display_condition (Callable[[Any], Any]) – the function to check whether or not the function should be applied args (Any) – any additional arguments the function may require

remove_action(name: str = '') → None[source]¶

Removes the provided action globally in lux

Parameters:	name (str) – the name of the action to remove

set_SQL_connection(connection)[source]¶

Sets SQL connection to a database

Parameters:	connection – SQLAlchemy connectable, str, or sqlite3 connection For more information, see here

default_display¶: Set the widget display to show Pandas by default or Lux by default :param type: Default display type, can take either the string lux or pandas (regardless of capitalization) :type type: str

heatmap¶: param heatmap_flag: Whether or not a heatmap will be used instead of a scatter plot. :type heatmap_flag: bool

sampling¶: param sample_flag: Whether or not sampling will occur. :type sample_flag: bool

sampling_cap¶: param sample_number: Cap on the number of rows to sample. Must be larger than _sampling_start :type sample_number: int

sampling_start¶: param sample_number: Number of rows required to begin sampling. Must be smaller or equal to _sampling_cap :type sample_number: int