From de5ecd45cc53205dfbf8d7daa4ad32ce114363e5 Mon Sep 17 00:00:00 2001 From: angela0xdata Date: Mon, 26 Jun 2017 10:10:14 -0700 Subject: [PATCH] PUBDEV-4621: Add documentation for missing GLM parameters MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit In the GLM section of the user guide, added parameters for the following: - balance_classes - class_sampling_factors - max_after_balance_size - max_hit_ratio_k - max_runtime_secs In the Parameters Appendix, added “GLM” to the “Available In” section for these parameters. --- .../src/product/data-science/algo-params/balance_classes.rst | 2 +- .../data-science/algo-params/class_sampling_factors.rst | 2 +- .../data-science/algo-params/max_after_balance_size.rst | 2 +- .../src/product/data-science/algo-params/max_hit_ratio_k.rst | 2 +- h2o-docs/src/product/data-science/glm.rst | 10 ++++++++++ 5 files changed, 14 insertions(+), 4 deletions(-) diff --git a/h2o-docs/src/product/data-science/algo-params/balance_classes.rst b/h2o-docs/src/product/data-science/algo-params/balance_classes.rst index 75de8764061..d5842fb45d8 100644 --- a/h2o-docs/src/product/data-science/algo-params/balance_classes.rst +++ b/h2o-docs/src/product/data-science/algo-params/balance_classes.rst @@ -1,7 +1,7 @@ ``balance_classes`` ------------------- -- Available in: GBM, DRF, Deep Learning, Naïve-Bayes +- Available in: GBM, DRF, Deep Learning, GLM, Naïve-Bayes - Hyperparameter: yes Description diff --git a/h2o-docs/src/product/data-science/algo-params/class_sampling_factors.rst b/h2o-docs/src/product/data-science/algo-params/class_sampling_factors.rst index 90087c4633f..3c36297c928 100644 --- a/h2o-docs/src/product/data-science/algo-params/class_sampling_factors.rst +++ b/h2o-docs/src/product/data-science/algo-params/class_sampling_factors.rst @@ -1,7 +1,7 @@ ``class_sampling_factors`` -------------------------- -- Available in: GBM, DRF, Deep Learning, Naïve-Bayes +- Available in: GBM, DRF, Deep Learning, GLM, Naïve-Bayes - Hyperparameter: yes Description diff --git a/h2o-docs/src/product/data-science/algo-params/max_after_balance_size.rst b/h2o-docs/src/product/data-science/algo-params/max_after_balance_size.rst index aeb39250588..6afe8b3bb1e 100644 --- a/h2o-docs/src/product/data-science/algo-params/max_after_balance_size.rst +++ b/h2o-docs/src/product/data-science/algo-params/max_after_balance_size.rst @@ -1,7 +1,7 @@ ``max_after_balance_size`` -------------------------- -- Available in: GBM, DRF, Deep Learning, Naïve-Bayes +- Available in: GBM, DRF, Deep Learning, GLM, Naïve-Bayes - Hyperparameter: yes Description diff --git a/h2o-docs/src/product/data-science/algo-params/max_hit_ratio_k.rst b/h2o-docs/src/product/data-science/algo-params/max_hit_ratio_k.rst index cda1f0ea46b..f6660f02054 100644 --- a/h2o-docs/src/product/data-science/algo-params/max_hit_ratio_k.rst +++ b/h2o-docs/src/product/data-science/algo-params/max_hit_ratio_k.rst @@ -1,7 +1,7 @@ ``max_hit_ratio_k`` ------------------- -- Available in: GBM, DRF, Deep Learning, Naïve-Bayes +- Available in: GBM, DRF, Deep Learning, GLM, Naïve-Bayes - Hyperparameter: no Description diff --git a/h2o-docs/src/product/data-science/glm.rst b/h2o-docs/src/product/data-science/glm.rst index ac4825dac66..4d1d7821601 100644 --- a/h2o-docs/src/product/data-science/glm.rst +++ b/h2o-docs/src/product/data-science/glm.rst @@ -153,6 +153,16 @@ Defining a GLM Model - `interactions `__: Specify a list of predictor column indices to interact. All pairwise combinations will be computed for this list. +- `balance_classes `__: Specify whether to oversample the minority classes to balance the class distribution. This option is not enabled by default and can increase the data frame size. This option is only applicable for classification. Majority classes can be undersampled to satisfy the **max_after_balance_size** parameter. + +- `class_sampling_factors `__: Specify the per-class (in lexicographical order) over/under-sampling ratios. By default, these ratios are automatically computed during training to obtain the class balance. + +- `max_after_balance_size `__: Specify the maximum relative size of the training data after balancing class counts (**balance_classes** must be enabled). The value can be less than 1.0. + +- `max_hit_ratio_k `__: Specify the maximum number (top K) of predictions to use for hit ratio computation. Applicable to multi-class only. To disable, enter 0. + +- `max_runtime_secs `__: Maximum allowed runtime in seconds for model training. Use 0 to disable. + Interpreting a GLM Model ~~~~~~~~~~~~~~~~~~~~~~~~