On 09/10/2015 06:16 PM, Joel Nothman wrote: > the documentation implies these are for advanced use by (generally) > not referencing them in the narrative documentation. I think that's a > fair way to keep them only for the sight of those who dig deeper, but > this implicitness leaves some maintenance risks. I agree that this is sort-of the distinction, though I haven't fact-checked that they are actually not used. But it is pretty implicit, and I don't think looking at the API docs counts digging deeper. > While I don't think a note in the docstring of each function version > is the right solution, "See Also" could be used to indicate the > relationship. How do you mean? > Additionally, or alternatively, we could split classes.rst into > "Estimators", "Low-level learning functions" and "Utilities". That is actually done for the SVM module: http://scikit-learn.org/dev/modules/classes.html#module-sklearn.svm
For cluster it is less clear: http://scikit-learn.org/dev/modules/classes.html#module-sklearn.cluster @joel do you think it is enough to test the functions via the estimators? I feel that if we do provide this interface, it should either be explicitly low-level (the SVM functions are pretty clear about that, they only accept y to be a 64bit float), or should have a well-tested interface. ------------------------------------------------------------------------------ Monitor Your Dynamic Infrastructure at Any Scale With Datadog! Get real-time metrics from all of your servers, apps and tools in one place. SourceForge users - Click here to start your Free Trial of Datadog now! http://pubads.g.doubleclick.net/gampad/clk?id=241902991&iu=/4140 _______________________________________________ Scikit-learn-general mailing list Scikit-learn-general@lists.sourceforge.net https://lists.sourceforge.net/lists/listinfo/scikit-learn-general
