Skip to content

Commit 006a0cd

Browse files
h2oaiGH-16188: Updating user guide page API Changes to reflect makersaurus guidelines (h2oai#16198)
* ht/initial updates * ht/secondary changes * ht/updates
1 parent a72a974 commit 006a0cd

File tree

1 file changed

+40
-36
lines changed

1 file changed

+40
-36
lines changed

h2o-docs/src/product/api-changes.rst

+40-36
Original file line numberDiff line numberDiff line change
@@ -1,89 +1,93 @@
1-
API-Related Changes
2-
-------------------
1+
API-related changes
2+
===================
33

44
H2O-3 does its best to keep backwards compatibility between major versions, but sometimes breaking changes are needed in order to improve code quality and to address issues. This section provides a list of current breaking changes between specific releases.
55

66
From 3.32.0.1
7-
~~~~~~~~~~~~~
7+
-------------
88

99
Modules
10-
'''''''
10+
~~~~~~~
1111

1212
The deprecated ``h2o-scala`` module has been removed.
1313

1414
Target Encoding
15-
'''''''''''''''
15+
~~~~~~~~~~~~~~~
1616

17-
The Target Encoder API has been clarified and its consistency across clients has been improved:
17+
The Target Encoder API has been clarified and its consistency across clients has been improved. The following parameters are now deprecated in all clients and officially replaced by their new alternative:
1818

19-
The following parameters are now deprecated in all clients and officially replaced by their new alternative:
20-
- ``k`` -> ``inflection_point``
21-
- ``f`` -> ``smoothing``
22-
- ``noise_level`` -> ``noise``
23-
- ``use_blending`` (R only) -> ``blending``
19+
- ``k`` :math:`\to` ``inflection_point``
20+
- ``f`` :math:`\to` ``smoothing``
21+
- ``noise_level`` :math:`\to` ``noise``
22+
- ``use_blending`` (R only) :math:`\to` ``blending``
2423

25-
Legacy client code using the deprecated parameters should expect a deprecation warning when using them, they are strongly encouraged to update their code to use the new naming.
24+
Legacy client code using the deprecated parameters should expect a deprecation warning when using them. You are strongly encouraged to update your code to use the new naming.
25+
26+
``transform`` parameter updates
27+
'''''''''''''''''''''''''''''''
28+
29+
In an objective of performance optimization on the backend, and of simplification of the API, the ``transform`` method used to apply target encoding was modified as follows:
2630

27-
In an objective of performance optimization on the backend, and of simplification of the API, the ``transform`` method used to apply target encoding was modified as follow.
2831
- The R ``h2o.transform`` function (accepting a target encoder model as the first argument) and the Python ``H2OTargetEncoderEstimator.transform`` methods are now fully compatible: they accept the same parameters and work consistently.
29-
- The parameters ``data_leakage_handling``, ``seed`` are now ignored on those methods: ``transform`` will use by default the corresponding values defined when building the TargetEncoder model.
32+
- The parameters ``data_leakage_handling``, ``seed`` are now ignored on those methods: by default, ``transform`` will use the corresponding values defined when building the TargetEncoder model.
3033
- The other regularization parameters on these ``transform`` methods (e.g. ``noise``, ``blending``, ``inflection_point``, ``smoothing``), always default to the value defined on the TargetEncoder model.
3134
- A new ``as_training`` parameter has been introduced to simplify and enforce a correct usage of target encoding:
3235

33-
- When transforming a training dataset, user should use (R) ``h2o.transform(te_model, train_dataset, as_training=TRUE)`` or (Python) ``te_model.transform(train_dataset, as_training=True)``.
34-
- When transforming any other dataset (validation, test, ...), user can just use (R) ``h2o.transform(te_model, train_dataset)`` or (Python) ``te_model.transform(train_dataset)``.
36+
- When transforming a training dataset, you should use (R) ``h2o.transform(te_model, train_dataset, as_training=TRUE)`` or (Python) ``te_model.transform(train_dataset, as_training=True)``.
37+
- When transforming any other dataset (validation, test, ...), you can just use (R) ``h2o.transform(te_model, train_dataset)`` or (Python) ``te_model.transform(train_dataset)``.
3538
- Legacy code using for example ``h2o.transform(te_model, train_dataset, data_leakage_handling="KFold")`` will now be translated internally to ``h2o.transform(te_model, train_dataset, as_training=TRUE)``.
3639

3740

38-
Finally the following APIs, deprecated since 3.28, have been fully removed:
41+
Finally the following APIs (deprecated since 3.28) have been fully removed:
42+
3943
- Python: ``h2o.targetencoder`` module.
4044
- R: ``h2o.target_encode_fit`` and ``h2o.target_encode_transform`` functions.
4145

4246
Parameters
43-
''''''''''
44-
The ``max_hit_ratio_k`` param has been removed.
47+
~~~~~~~~~~
48+
49+
The ``max_hit_ratio_k`` parameter has been removed.
4550

4651
From 3.30.1.2
47-
~~~~~~~~~~~~~
52+
-------------
4853

49-
The ``max_hit_ratio_k`` param is deprecated in version 3.30.1.2 and will be completely removed in the next major version, 3.32.0.1.
54+
The ``max_hit_ratio_k`` parameter is deprecated in version 3.30.1.2 and will be completely removed in the next major version, 3.32.0.1.
5055

5156
From 3.30.1.1
52-
~~~~~~~~~~~~~
57+
-------------
5358

5459
The deprecated ``h2o-scala`` module has been removed.
5560

5661

5762
From 3.30.0.5
58-
~~~~~~~~~~~~~
63+
-------------
5964

6065
The ``h2o-scala`` module is deprecated in version 3.30.0.5 and will be completely removed in the next major version, 3.30.1.1.
6166

6267

6368
From 3.30.0.4
64-
~~~~~~~~~~~~~
69+
-------------
6570

6671
The following options are no longer supported by native `XGBoost <https://xgboost.readthedocs.io/en/latest/parameter.html>`__ and have been removed.
6772

6873
- ``min_sum_hessian_in_leaf``
6974
- ``min_data_in_leaf``
7075

7176

72-
From 3.28 or Below to 3.30
73-
~~~~~~~~~~~~~~~~~~~~~~~~~~~
77+
From 3.28 or below to 3.30
78+
--------------------------
7479

7580
Java API
76-
''''''''
81+
~~~~~~~~
7782

78-
``hex.grid.HyperSpaceWalker`` and ``hex.grid.HyperspaceWalker.HyperSpaceIterator`` interfaces have been simplified.
79-
Users implementing those interfaces directly, for example to create a custom grid search exploration algorithm, may want to look at the default implementations in **h2o-core/src/main/java/hex/grid/HyperSpaceWalker.java** if they are facing any issue when compiling against the new interfaces.
83+
The ``hex.grid.HyperSpaceWalker`` and ``hex.grid.HyperspaceWalker.HyperSpaceIterator`` interfaces have been simplified. Users implementing those interfaces directly, for example to create a custom grid search exploration algorithm, may want to look at the default implementations in ``h2o-core/src/main/java/hex/grid/HyperSpaceWalker.java`` if they are facing any issue when compiling against the new interfaces.
8084

8185

82-
From 3.26 or Below to 3.28
83-
~~~~~~~~~~~~~~~~~~~~~~~~~~~
86+
From 3.26 or below to 3.28
87+
--------------------------
8488

8589
Java API
86-
''''''''
90+
~~~~~~~~
8791

8892
The following classes were moved:
8993

@@ -96,11 +100,11 @@ The following classes were moved:
96100
================================================= =========================================
97101

98102

99-
From 3.22 or Below to 3.24
100-
~~~~~~~~~~~~~~~~~~~~~~~~~~~
103+
From 3.22 or below to 3.24
104+
--------------------------
101105

102106
Java API
103-
''''''''
107+
~~~~~~~~
104108

105109
The following classes were moved and/or renamed:
106110

@@ -112,4 +116,4 @@ The following classes were moved and/or renamed:
112116
``ai.h2o.automl.AutoML.algo`` ``ai.h2o.automl.Algo``
113117
================================================= ======================================
114118

115-
Some internal methods of ``StackedEnsemble`` and ``StackedEnsembleModel`` are no longer public, but this should not impact users.
119+
Some internal methods of ``StackedEnsemble`` and ``StackedEnsembleModel`` are no longer public, but this should not impact you.

0 commit comments

Comments
 (0)