@@ -494,6 +494,10 @@ def export_dictionary_as_json(
494494 ----------
495495 dictionary_file_path_or_domain : str or `.DictionaryDomain`
496496 Path of a Khiops dictionary file or a DictionaryDomain object.
497+ json_dictionary_file_path : str
498+ Path (absolute path recommended) to the output dictionary file,
499+ in the JSON format. Note that a relative path will produce a file in
500+ the current working directory.
497501 ... :
498502 See :ref:`core-api-common-params`.
499503
@@ -538,7 +542,8 @@ def build_dictionary_from_data_table(
538542 output_dictionary_name : str
539543 Name dictionary to be created.
540544 output_dictionary_file_path : str
541- Path of the output dictionary file.
545+ Path (absolute path recommended) of the output dictionary file. Note that
546+ a relative path will produce a file in the current working directory.
542547 detect_format : bool, default ``True``
543548 If ``True`` detects automatically whether the data table file has a header and
544549 its field separator. It is set to ``False`` if ``header_line`` or
@@ -700,9 +705,11 @@ def train_predictor(
700705 constructs a classifier and if it is numerical a regressor. If equal to "" it
701706 performs an unsupervised analysis.
702707 analysis_report_file_path : str
703- Path to the analysis report file in the JSON format. An additional dictionary
704- file with the same name and extension ``.model.kdic`` is built, which contains
705- the trained models.
708+ Path (absolute path recommended) to the analysis report file,
709+ in the JSON format. An additional dictionary file with the same name and
710+ extension ``.model.kdic`` is built, which contains the trained models.
711+ Note that a relative path will produce a report file in the current working
712+ directory.
706713 detect_format : bool, default ``True``
707714 If ``True`` detects automatically whether the data table file has a header and
708715 its field separator. It is set to ``False`` if ``header_line`` or
@@ -1010,7 +1017,9 @@ def evaluate_predictor(
10101017 data_table_path : str
10111018 Path of the evaluation data table file.
10121019 evaluation_report_file_path : str
1013- Path to the evaluation report file, in the JSON format.
1020+ Path (absolute path recommended) to the evaluation report file,
1021+ in the JSON format. Note that a relative path will produce a report file in
1022+ the current working directory.
10141023 detect_format : bool, default ``True``
10151024 If ``True`` detects automatically whether the data table file has a header and
10161025 its field separator. It is set to ``False`` if ``header_line`` or
@@ -1146,9 +1155,11 @@ def train_recoder(
11461155 target_variable : str
11471156 Name of the target variable. If equal to "" it trains an unsupervised recoder.
11481157 analysis_report_file_path : str
1149- Path to the analysis report file in the JSON format. An additional dictionary
1150- file with the same name and extension ``.model.kdic`` is built, which contains
1151- the trained recoding model.
1158+ Path (absolute path recommended) to the analysis report file,
1159+ in the JSON format. An additional dictionary file with the same name and
1160+ extension ``.model.kdic`` is built, which contains the trained recoding model.
1161+ Note that a relative path will produce a report file in the current working
1162+ directory.
11521163 detect_format : bool, default ``True``
11531164 If ``True`` detects automatically whether the data table file has a header and
11541165 its field separator. It is set to ``False`` if ``header_line`` or
@@ -1338,7 +1349,8 @@ def deploy_model(
13381349 data_table_path : str
13391350 Path of the data table file.
13401351 output_data_table_path : str
1341- Path of the output data file.
1352+ Path (absolute path recommended) of the output data file. Note that a
1353+ relative path will produce a file in the current working directory.
13421354 detect_format : bool, default ``True``
13431355 If ``True`` detects automatically whether the data table file has a header and
13441356 its field separator. It is set to ``False`` if ``header_line`` or
@@ -1424,7 +1436,8 @@ def build_deployed_dictionary(
14241436 dictionary_name : str
14251437 Name of the dictionary to be analyzed.
14261438 output_dictionary_file_path : str
1427- Path of the output dictionary file.
1439+ Path (absolute path recommended) of the output dictionary file. Note that
1440+ a relative path will produce a file in the current working directory.
14281441 ... :
14291442 See :ref:`core-api-common-params`.
14301443
@@ -1480,7 +1493,8 @@ def sort_data_table(
14801493 data_table_path : str
14811494 Path of the data table file.
14821495 output_data_table_path : str
1483- Path of the output data file.
1496+ Path (absolute path recommended) of the output data file. Note that a
1497+ relative path will produce a file in the current working directory.
14841498 sort_variables : list of str, optional
14851499 The names of the variables to sort. If not set sorts the table by its key.
14861500 detect_format : bool, default ``True``
@@ -1555,7 +1569,8 @@ def extract_keys_from_data_table(
15551569 data_table_path : str
15561570 Path of the data table file.
15571571 output_data_table_path : str
1558- Path of the output data file.
1572+ Path (absolute path recommended) of the output data file. Note that a
1573+ relative path will produce a file in the current working directory.
15591574 detect_format : bool, default ``True``
15601575 If ``True`` detects automatically whether the data table file has a header and
15611576 its field separator. It is set to ``False`` if ``header_line`` or
@@ -1634,7 +1649,9 @@ def train_coclustering(
16341649 coclustering_variables : list of str
16351650 The names of variables to use in coclustering. Min length: 2. Max length: 10.
16361651 coclustering_report_file_path : str
1637- Path to the coclustering report file in the JSON format.
1652+ Path (absolute path recommended) to the coclustering report file,
1653+ in the JSON format. Note that a relative path will produce a report file in
1654+ the current working directory.
16381655 detect_format : bool, default ``True``
16391656 If ``True`` detects automatically whether the data table file has a header and
16401657 its field separator. It is set to ``False`` if ``header_line`` or
@@ -1745,7 +1762,9 @@ def train_instance_variable_coclustering(
17451762 data_table_path : str
17461763 Path of the data table file.
17471764 coclustering_report_file_path : str
1748- Path to the coclustering report file in the JSON format.
1765+ Path (absolute path recommended) to the coclustering report file,
1766+ in the JSON format. Note that a relative path will produce a report file in
1767+ the current working directory.
17491768 detect_format : bool, default ``True``
17501769 If ``True`` detects automatically whether the data table file has a header and
17511770 its field separator. It is set to ``False`` if ``header_line`` or
@@ -1833,7 +1852,9 @@ def simplify_coclustering(
18331852 coclustering_file_path : str
18341853 Path of the coclustering file (extension ``.khc``, or ``.khcj``).
18351854 simplified_coclustering_file_path : str
1836- Path of the output coclustering file.
1855+ Path (absolute path recommended) of the output coclustering file. Note
1856+ that a relative path will produce a report file in the current working
1857+ directory.
18371858 max_preserved_information : int, default 0
18381859 Maximum information preserve in the simplified coclustering. If equal to 0
18391860 there is no limit.
@@ -2009,7 +2030,8 @@ def extract_clusters(
20092030 cluster_variable : str
20102031 Name of the variable for which the clusters are extracted.
20112032 clusters_file_path : str
2012- Path of the output clusters TSV file.
2033+ Path (absolute path recommended) of the output clusters TSV file. Note
2034+ that a relative path will produce a file in the current working directory.
20132035 max_preserved_information : int, default 0
20142036 Maximum information preserve in the simplified coclustering. If equal to 0 there
20152037 is no limit.
0 commit comments