tools#

Submodule of khiops.tools

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.

Functions#

download_datasets

Downloads the Khiops sample datasets for a given version

kh_download_datasets_entry_point

Entry point for the download samples helper script

kh_samples_entry_point

Entry point of the kh-samples command

kh_status_entry_point

Entry point of the kh-status command

pk_status_entry_point

Entry point of the pk-status command

khiops.tools.download_datasets(force_overwrite=False, version='10.1.1', _called_from_shell=False)#

Downloads the Khiops sample datasets for a given version

The datasets are downloaded to:
  • Windows: %USERPROFILE%\khiops_data\samples

  • Linux/macOS: $HOME/khiops_data/samples

Parameters:
force_overwritebool, default False

If True it always overwrites the local samples directory even if it exists.

versionstr, default “10.1.1”

The version of the samples datasets.

khiops.tools.kh_download_datasets_entry_point()#

Entry point for the download samples helper script

khiops.tools.kh_samples_entry_point()#

Entry point of the kh-samples command

khiops.tools.kh_status_entry_point()#

Entry point of the kh-status command

khiops.tools.pk_status_entry_point()#

Entry point of the pk-status command

Deprecated will be removed in Khiops 11, use kh_status_entry_point instead.