From 6705d6ecde8e86d85f4cc47fe59e1b198288fd4a Mon Sep 17 00:00:00 2001 From: Gertjan van den Burg Date: Wed, 6 Mar 2019 22:31:36 -0500 Subject: Minor documentation fixes --- README.rst | 4 ++-- gensvm/core.py | 7 +++++-- 2 files changed, 7 insertions(+), 4 deletions(-) diff --git a/README.rst b/README.rst index bf3c120..44c47a7 100644 --- a/README.rst +++ b/README.rst @@ -73,8 +73,8 @@ from Scikit-Learn as follows: >>> scaler = MaxAbsScaler().fit(X_train) >>> X_train, X_test = scaler.transform(X_train), scaler.transform(X_test) -Note that we scale the data using the `maxabs_scale -`_ +Note that we scale the data using the `MaxAbsScaler +`_ function. This scales the columns of the data matrix to ``[-1, 1]`` without breaking sparsity. Scaling the dataset can have a significant effect on the computation time of GenSVM and is `generally recommended for SVMs diff --git a/gensvm/core.py b/gensvm/core.py index dab2368..c994995 100644 --- a/gensvm/core.py +++ b/gensvm/core.py @@ -76,13 +76,16 @@ def _fit_gensvm( if status_ == 1 and verbose > 0: warnings.warn( "GenSVM optimization prematurely ended due to a " - "incorrect step in the optimization algorithm.", + "incorrect step in the optimization algorithm. " + "This can be due to data quality issues, hyperparameter " + "settings, or numerical precision errors.", FitFailedWarning, ) if status_ == 2 and verbose > 0: warnings.warn( - "GenSVM failed to converge, increase " "the number of iterations.", + "GenSVM failed to converge, you may want to increase " + "the number of iterations.", ConvergenceWarning, ) -- cgit v1.2.3