From 74510332f9fbc0394f9ff191ee835323efc15259 Mon Sep 17 00:00:00 2001 From: Lars Buitinck <L.J.Buitinck@uva.nl> Date: Thu, 20 Oct 2011 14:41:54 +0200 Subject: [PATCH] DOC some stuff on input validation --- doc/developers/index.rst | 14 ++++++++++++-- 1 file changed, 12 insertions(+), 2 deletions(-) diff --git a/doc/developers/index.rst b/doc/developers/index.rst index 106c4f4569..a6824be432 100644 --- a/doc/developers/index.rst +++ b/doc/developers/index.rst @@ -271,8 +271,18 @@ A good example of code that we like can be found `here <https://svn.enthought.com/enthought/browser/sandbox/docs/coding_standard.py>`_. -APIs of scikit learn objects -============================= +Input validation +---------------- + +The module ``sklearn.utils`` contains various functions for doing input +validation/conversion. Sometimes, ``np.atleast_2d`` suffices for validation; +in other cases, be sure to call ``safe_asanyarray``, ``atleast2d_or_csr`` or +``as_float_array`` on any array-like argument passed to a scikit-learn API +function. + + +APIs of scikit-learn objects +============================ To have a uniform API, we try to have a common basic API for all the objects. In addition, to avoid the proliferation of framework code, we -- GitLab