diff --git a/doc/api.rst b/doc/api.rst index 6053b4b..0bbac09 100644 --- a/doc/api.rst +++ b/doc/api.rst @@ -32,3 +32,15 @@ Predictor :template: class.rst TemplateClassifier + + +Utilities +========= + +.. autosummary:: + :toctree: generated/ + :template: functions.rst + + utils.discovery.all_estimators + utils.discovery.all_displays + utils.discovery.all_functions diff --git a/skltemplate/__init__.py b/skltemplate/__init__.py index 879c4c6..66806e5 100644 --- a/skltemplate/__init__.py +++ b/skltemplate/__init__.py @@ -1,3 +1,6 @@ +# Authors: scikit-learn-contrib developers +# License: BSD 3 clause + from ._template import TemplateClassifier, TemplateEstimator, TemplateTransformer from ._version import __version__ diff --git a/skltemplate/_template.py b/skltemplate/_template.py index aa21f69..ce41d0f 100644 --- a/skltemplate/_template.py +++ b/skltemplate/_template.py @@ -1,6 +1,10 @@ """ This is a module to be used as a reference for building other modules """ + +# Authors: scikit-learn-contrib developers +# License: BSD 3 clause + import numpy as np from sklearn.base import BaseEstimator, ClassifierMixin, TransformerMixin, _fit_context from sklearn.metrics import euclidean_distances diff --git a/skltemplate/_version.py b/skltemplate/_version.py index d1b5dc8..d1cbff4 100644 --- a/skltemplate/_version.py +++ b/skltemplate/_version.py @@ -1 +1,4 @@ +# Authors: scikit-learn-contrib developers +# License: BSD 3 clause + __version__ = "0.0.4.dev0" diff --git a/skltemplate/tests/__init__.py b/skltemplate/tests/__init__.py index e69de29..52e3f96 100644 --- a/skltemplate/tests/__init__.py +++ b/skltemplate/tests/__init__.py @@ -0,0 +1,2 @@ +# Authors: scikit-learn-contrib developers +# License: BSD 3 clause diff --git a/skltemplate/tests/test_common.py b/skltemplate/tests/test_common.py index 381c11b..4249e7f 100644 --- a/skltemplate/tests/test_common.py +++ b/skltemplate/tests/test_common.py @@ -1,13 +1,16 @@ """This file shows how to write test based on the scikit-learn common tests.""" +# Authors: scikit-learn-contrib developers +# License: BSD 3 clause + from sklearn.utils.estimator_checks import parametrize_with_checks -from skltemplate import TemplateClassifier, TemplateEstimator, TemplateTransformer +from skltemplate.utils.discovery import all_estimators # parametrize_with_checks allows to get a generator of check that is more fine-grained # than check_estimator -@parametrize_with_checks([TemplateEstimator(), TemplateTransformer(), TemplateClassifier()]) +@parametrize_with_checks([est() for _, est in all_estimators()]) def test_estimators(estimator, check, request): """Check the compatibility with scikit-learn API""" check(estimator) diff --git a/skltemplate/tests/test_template.py b/skltemplate/tests/test_template.py index 6803945..b34b106 100644 --- a/skltemplate/tests/test_template.py +++ b/skltemplate/tests/test_template.py @@ -6,6 +6,8 @@ from skltemplate import TemplateClassifier, TemplateEstimator, TemplateTransformer +# Authors: scikit-learn-contrib developers +# License: BSD 3 clause @pytest.fixture def data():