Skip to content

Commit e11dcc3

Browse files
committed
Update Core API docstrings to silence Sphinx warnings
1 parent d47193a commit e11dcc3

File tree

1 file changed

+15
-0
lines changed

1 file changed

+15
-0
lines changed

khiops/core/api.py

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -757,9 +757,11 @@ def train_predictor(
757757
Maximum number of text features to construct.
758758
text_features : str, default "words"
759759
Type of the text features. Can be either one of:
760+
760761
- "words": sequences of non-space characters
761762
- "ngrams": sequences of bytes
762763
- "tokens": user-defined
764+
763765
max_trees : int, default 10
764766
Maximum number of trees to construct.
765767
max_pairs : int, default 0
@@ -788,8 +790,10 @@ def train_predictor(
788790
Maximum number of variable parts produced by preprocessing methods. If equal
789791
to 0 it is automatically calculated.
790792
Special default values for unsupervised analysis:
793+
791794
- If ``discretization_method`` is "EqualWidth" or "EqualFrequency": 10
792795
- If ``grouping_method`` is "BasicGrouping": 10
796+
793797
... :
794798
See :ref:`core-api-common-params`.
795799
@@ -1181,9 +1185,11 @@ def train_recoder(
11811185
Maximum number of text features to construct.
11821186
text_features : str, default "words"
11831187
Type of the text features. Can be either one of:
1188+
11841189
- "words": sequences of non-space characters
11851190
- "ngrams": sequences of bytes
11861191
- "tokens": user-defined
1192+
11871193
max_trees : int, default 10
11881194
Maximum number of trees to construct.
11891195
max_pairs : int, default 0
@@ -1210,13 +1216,16 @@ def train_recoder(
12101216
If ``True`` keeps initial numerical variables.
12111217
categorical_recoding_method : str
12121218
Type of recoding for categorical variables. Types available:
1219+
12131220
- "part Id" (default): An id for the interval/group
12141221
- "part label": A label for the interval/group
12151222
- "0-1 binarization": A 0's and 1's coding the interval/group id
12161223
- "conditional info": Conditional information of the interval/group
12171224
- "none": Keeps the variable as-is
1225+
12181226
numerical_recoding_method : str
12191227
Type of recoding recoding for numerical variables. Types available:
1228+
12201229
- "part Id" (default): An id for the interval/group
12211230
- "part label": A label for the interval/group
12221231
- "0-1 binarization": A 0's and 1's coding the interval/group id
@@ -1226,13 +1235,16 @@ def train_recoder(
12261235
- "rank normalization": mean normalized rank (between 0 and 1) of the
12271236
instances
12281237
- "none": Keeps the variable as-is
1238+
12291239
pairs_recoding_method : str
12301240
Type of recoding for bivariate variables. Types available:
1241+
12311242
- "part Id" (default): An id for the interval/group
12321243
- "part label": A label for the interval/group
12331244
- "0-1 binarization": A 0's and 1's coding the interval/group id
12341245
- "conditional info": Conditional information of the interval/group
12351246
- "none": Keeps the variable as-is
1247+
12361248
discretization_method : str, default "MODL"
12371249
Name of the discretization method in case of unsupervised analysis.
12381250
Its valid values are: "MODL", "EqualWidth", "EqualFrequency" or "none".
@@ -1245,15 +1257,18 @@ def train_recoder(
12451257
Maximum number of variable parts produced by preprocessing methods. If equal
12461258
to 0 it is automatically calculated.
12471259
Special default values for unsupervised analysis:
1260+
12481261
- If ``discretization_method`` is "EqualWidth" or "EqualFrequency": 10
12491262
- If ``grouping_method`` is "BasicGrouping": 10
1263+
12501264
... :
12511265
See :ref:`core-api-common-params`.
12521266
12531267
Returns
12541268
-------
12551269
tuple
12561270
A 2-tuple containing:
1271+
12571272
- The path of the JSON file report of the process
12581273
- The path of the dictionary containing the recoding model
12591274

0 commit comments

Comments
 (0)