diff options
Diffstat (limited to 'docs/auto_functions.rst')
| -rw-r--r-- | docs/auto_functions.rst | 47 |
1 files changed, 45 insertions, 2 deletions
diff --git a/docs/auto_functions.rst b/docs/auto_functions.rst index 3ba1fff..2a6596f 100644 --- a/docs/auto_functions.rst +++ b/docs/auto_functions.rst @@ -1,9 +1,52 @@ -.. py:function:: load_default_grid() +.. py:function:: load_grid_tiny() :noindex: :module: gensvm.gridsearch - Load the default parameter grid for GenSVM + Load a tiny parameter grid for the GenSVM grid search + + This function returns a parameter grid to use in the GenSVM grid search. + This grid was obtained by analyzing the experiments done for the GenSVM + paper and selecting the configurations that achieve accuracy within the + 95th percentile on over 90% of the datasets. It is a good start for a + parameter search with a reasonably high chance of achieving good + performance on most datasets. + + Note that this grid is only tested to work well in combination with the + linear kernel. + + :returns: **pg** -- List of 10 parameter configurations that are likely to perform + reasonably well. + :rtype: list + + +.. py:function:: load_grid_small() + :noindex: + :module: gensvm.gridsearch + + Load a small parameter grid for GenSVM + + This function loads a default parameter grid to use for the #' GenSVM + gridsearch. It contains all possible combinations of the following #' + parameter sets:: + + pg = { + 'p': [1.0, 1.5, 2.0], + 'lmd': [1e-8, 1e-6, 1e-4, 1e-2, 1], + 'kappa': [-0.9, 0.5, 5.0], + 'weights': ['unit', 'group'], + } + + :returns: **pg** -- Mapping from parameters to lists of values for those parameters. To be + used as input for the :class:`.GenSVMGridSearchCV` class. + :rtype: dict + + +.. py:function:: load_grid_full() + :noindex: + :module: gensvm.gridsearch + + Load the full parameter grid for GenSVM This is the parameter grid used in the GenSVM paper to run the grid search experiments. It uses a large grid for the ``lmd`` regularization parameter |