khiops.tools

Submodule of khiops

Miscellaneous utility tools

Warning

The entry point functions in this module use sys.exit. They are not designed to be called from another program or python shell.

FUNCTION	DESCRIPTION
`kh_status_entry_point`	Entry point of the kh-status command
`kh_samples_entry_point`	Entry point of the kh-samples command
`kh_download_datasets_entry_point`	Entry point for the download samples helper script
`download_datasets`	Downloads the Khiops sample datasets for a given version

Functions:

`kh_status_entry_point()`

Entry point of the kh-status command

`kh_samples_entry_point()`

Entry point of the kh-samples command

`kh_download_datasets_entry_point()`

Entry point for the download samples helper script

`download_datasets(force_overwrite=False, version=DEFAULT_SAMPLES_VERSION, _called_from_shell=False)`

Downloads the Khiops sample datasets for a given version

The datasets are downloaded to: - all systems: KHIOPS_SAMPLES_DIR/khiops_data/samples if KHIOPS_SAMPLES_DIR is defined and non-empty - Windows: - %PUBLIC%\khiops_data\samples if %PUBLIC% is defined - %USERPROFILE%\khiops_data\samples otherwise - Linux/macOS: $HOME/khiops_data/samples

PARAMETER	DESCRIPTION
`force_overwrite`	If `True` it always overwrites the local samples directory even if it exists. TYPE: `bool` DEFAULT: `False`
`version`	The version of the samples datasets. TYPE: `str` DEFAULT: `"11.0.0"`