time_split_app.config

Configuration namespace.

Values in this module are treated as hard limits by the server.

Module Attributes

PLOT_RAW_TIMESERIES	Enable plot in the 🔍 Show raw data tab.
PLOT_AGGREGATIONS_PER_FOLD	Enable plots in the 📈 Aggregations per fold tab.
FIGURE_DPI	Controls figure fidelity.
MAX_SPLITS	Upper fold count limit.
RAW_DATA_SAMPLES	Maximum number of display and plot in 🔍 Show raw data tab.
DATASETS_CONFIG_PATH	Dataset configuration TOML path.
REQUIRE_DATASETS	If set, refuse to start if the DATASETS_CONFIG_PATH file cannot be read or is invalid.
DATASET_CONFIG_CACHE_TTL	Frequency with which the DATASETS_CONFIG_PATH is read.
DATASET_CACHE_TTL	Cache timeout in seconds.
DATASET_RADIO_LIMIT	Maximum number of dataset options to show as radio buttons.
ENABLE_DATA_GENERATOR	Set to False to disable the built-in dataset generator.
DATA_GENERATOR_INITIAL_RANGE_FN	Initial range callback for generated data.
PROCESS_QUERY_PARAMS	Abort if URL parameters are given when False.
PERMALINK_BASE_URL	Public base address for the application.
USE_CUSTOM_CSS	Disable to use the default Streamlit styling.
CONFIGURE_PLOTTING	Set to False to disable the default plotting style setup.
CONFIGURE_LOGGING	Set to False to disable the default logging setup.
PERFORMANCE_LOG_LEVEL	Level for the time_split_app.performance logger.
DATE_ONLY	If True, lock set the app in date_only mode wherever possible.
DATASET_LOADER	A custom loader implementation.
SPLIT_SELECT_FN	Custom splitting parameters selection function.
PLOT_FN	A custom plotting function; same interface as time_split.plot().
LINK_FN	A custom link function; same interface as create_explorer_link().
DEBUG	Enable to show debug information in the UI.

Functions

get_descriptions()	Get config key descriptions.
get_server_config_info()	Get the readonly server configuration.
get_values()	Get config values as a dict.

PLOT_RAW_TIMESERIES: bool = True

Enable plot in the 🔍 Show raw data tab.

PLOT_AGGREGATIONS_PER_FOLD: bool = True

Enable plots in the 📈 Aggregations per fold tab.

FIGURE_DPI: int = 200

Controls figure fidelity. Higher values look better, but is a lot slower.

MAX_SPLITS = 100

Upper fold count limit. Prevents figures from getting too large.

RAW_DATA_SAMPLES: int = 1000

Maximum number of display and plot in 🔍 Show raw data tab.

DATASETS_CONFIG_PATH: str = 'datasets.toml'

Dataset configuration TOML path. Disable the dataset view if not found.

May be remote, e.g. s3://my-bucket/data/datasets.toml for AWS blob storage.

REQUIRE_DATASETS: bool = False

If set, refuse to start if the DATASETS_CONFIG_PATH file cannot be read or is invalid.

DATASET_CONFIG_CACHE_TTL: int = 30

Frequency with which the DATASETS_CONFIG_PATH is read.

DATASET_CACHE_TTL: int = 43200

Cache timeout in seconds. Default is twelve hours.

DATASET_RADIO_LIMIT: int = 3

Maximum number of dataset options to show as radio buttons.

Radio buttons are shown with one-line descriptions and all options visible at once. If this limit is exceeded, the UI shows a label-only dropdown menu instead. Set to zero to always use the dropdown menu.

ENABLE_DATA_GENERATOR: bool = True

Set to False to disable the built-in dataset generator.

DATA_GENERATOR_INITIAL_RANGE_FN: str = ''

Initial range callback for generated data.

• Type: () -> (start, end).

• Format: path.to.module:func_name.

PROCESS_QUERY_PARAMS: bool = True

Abort if URL parameters are given when False.

PERMALINK_BASE_URL: str = ''

Public base address for the application. Used to create permalinks.

USE_CUSTOM_CSS: bool = True

Disable to use the default Streamlit styling.

CONFIGURE_PLOTTING = True

Set to False to disable the default plotting style setup.

CONFIGURE_LOGGING = True

Set to False to disable the default logging setup.

PERFORMANCE_LOG_LEVEL: int = 20

Level for the time_split_app.performance logger. Default is logging.INFO=20.

DATE_ONLY: bool = True

If True, lock set the app in date_only mode wherever possible.

DATASET_LOADER: str = ''

A custom loader implementation.

• Type: DataLoaderWidget

• Format: path.to.module:ClassName (or an instance thereof).

SPLIT_SELECT_FN: str = ''

Custom splitting parameters selection function.

• Type: () -> DatetimeIndexSplitterKwargs.

• Format: path.to.module:func_name.

To read params produced by create_explorer_link(), use

>>> from time_split_app.widgets.types import QueryParams
>>> QueryParams.get()

Of course, you may also choose to handle this yourself using st.query_params.

PLOT_FN: str = ''

A custom plotting function; same interface as time_split.plot().

• Type: (...) -> Axes.

• Format: path.to.module:func_name.

LINK_FN: str = ''

A custom link function; same interface as create_explorer_link().

• Type: (...) -> str.

• Format: path.to.module:func_name.

May break the QueryParams class.

DEBUG: bool = False

Enable to show debug information in the UI.

get_values() → dict[str, int | bool]

Get config values as a dict.

get_descriptions() → dict[str, str]

Get config key descriptions.

get_server_config_info() → str

Get the readonly server configuration.