init repository from sklearn contrib template

.coveragerc

@@ -2,5 +2,5 @@
 
 [run]
 branch = True
-source = skltemplate
-include = */skltemplate/*
+source = fsvm
+include = */fsvm/*

.github/workflows/python-app.yml

@@ -30,4 +30,4 @@ jobs:
         uses: codecov/[email protected]
         with:
           token: ${{ secrets.CODECOV_TOKEN }}
-          slug: scikit-learn-contrib/project-template
+          slug: balins/fsvm

.gitignore

@@ -75,4 +75,4 @@ target/
 .LSOverride
 
 # auto-generated files
-skltemplate/_version.py
+fsvm/_version.py

LICENSE

@@ -11,7 +11,7 @@ modification, are permitted provided that the following conditions are met:
   this list of conditions and the following disclaimer in the documentation
   and/or other materials provided with the distribution.
 
-* Neither the name of project-template nor the names of its
+* Neither the name of fsvm nor the names of its
   contributors may be used to endorse or promote products derived from
   this software without specific prior written permission.
 

README.md

@@ -1,9 +1,9 @@
 project-template - A template for scikit-learn contributions
 ============================================================
 
-![tests](https://github.com/scikit-learn-contrib/project-template/actions/workflows/python-app.yml/badge.svg)
-[![codecov](https://codecov.io/gh/scikit-learn-contrib/project-template/graph/badge.svg?token=L0XPWwoPLw)](https://codecov.io/gh/scikit-learn-contrib/project-template)
-![doc](https://github.com/scikit-learn-contrib/project-template/actions/workflows/deploy-gh-pages.yml/badge.svg)
+![tests](https://github.com/balins/fsvm/actions/workflows/python-app.yml/badge.svg)
+[![codecov](https://codecov.io/gh/balins/fsvm/graph/badge.svg?token=L0XPWwoPLw)](https://codecov.io/gh/balins/fsvm)
+![doc](https://github.com/balins/fsvm/actions/workflows/deploy-gh-pages.yml/badge.svg)
 
 **project-template** is a template project for [scikit-learn](https://scikit-learn.org)
 compatible extensions.

doc/Makefile

@@ -92,17 +92,17 @@ qthelp:
 	@echo
 	@echo "Build finished; now you can run "qcollectiongenerator" with the" \
 	      ".qhcp project file in $(BUILDDIR)/qthelp, like this:"
-	@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/project-template.qhcp"
+	@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/fsvm.qhcp"
 	@echo "To view the help file:"
-	@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/project-template.qhc"
+	@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/fsvm.qhc"
 
 devhelp:
 	$(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
 	@echo
 	@echo "Build finished."
 	@echo "To view the help file:"
-	@echo "# mkdir -p $$HOME/.local/share/devhelp/project-template"
-	@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/project-template"
+	@echo "# mkdir -p $$HOME/.local/share/devhelp/fsvm"
+	@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/fsvm"
 	@echo "# devhelp"
 
 epub:

doc/api.rst

@@ -6,7 +6,7 @@ API Reference
 
 This is an example on how to document the API of your own project.
 
-.. currentmodule:: skltemplate
+.. currentmodule:: fsvm
 
 Estimator
 =========

doc/conf.py

@@ -13,7 +13,7 @@
 project = "Scikit-learn Project Template"
 copyright = "2016, V. Birodkar"
 author = "V. Birodkar"
-release = get_version('skltemplate')
+release = get_version('fsvm')
 version = ".".join(release.split(".")[:3])
 
 # -- General configuration ---------------------------------------------------
@@ -44,11 +44,11 @@
 
 html_theme = "pydata_sphinx_theme"
 html_static_path = ["_static"]
-html_style = "css/project-template.css"
+html_style = "css/fsvm.css"
 html_logo = "_static/img/logo.png"
 # html_favicon = "_static/img/favicon.ico"
 html_css_files = [
-    "css/project-template.css",
+    "css/fsvm.css",
 ]
 html_sidebars = {
     "quick_start": [],
@@ -58,7 +58,7 @@
 
 html_theme_options = {
     "external_links": [],
-    "github_url": "https://github.com/scikit-learn-contrib/project-template",
+    "github_url": "https://github.com/balins/fsvm",
     # "twitter_url": "https://twitter.com/pandas_dev",
     "use_edit_page_button": True,
     "show_toc_level": 1,
@@ -67,7 +67,7 @@
 
 html_context = {
     "github_user": "scikit-learn-contrib",
-    "github_repo": "project-template",
+    "github_repo": "fsvm",
     "github_version": "master",
     "doc_path": "doc",
 }
@@ -106,9 +106,9 @@
 plot_gallery = True
 
 sphinx_gallery_conf = {
-    "doc_module": "skltemplate",
+    "doc_module": "fsvm",
     "backreferences_dir": os.path.join("generated"),
     "examples_dirs": "../examples",
     "gallery_dirs": "auto_examples",
-    "reference_url": {"skltemplate": None},
+    "reference_url": {"fsvm": None},
 }

doc/make.bat

@@ -115,9 +115,9 @@ if "%1" == "qthelp" (
 	echo.
 	echo.Build finished; now you can run "qcollectiongenerator" with the ^
 .qhcp project file in %BUILDDIR%/qthelp, like this:
-	echo.^> qcollectiongenerator %BUILDDIR%\qthelp\project-template.qhcp
+	echo.^> qcollectiongenerator %BUILDDIR%\qthelp\fsvm.qhcp
 	echo.To view the help file:
-	echo.^> assistant -collectionFile %BUILDDIR%\qthelp\project-template.ghc
+	echo.^> assistant -collectionFile %BUILDDIR%\qthelp\fsvm.ghc
 	goto end
 )
 

examples/plot_classifier.py

@@ -3,12 +3,12 @@
 Plotting Template Classifier
 ============================
 
-An example plot of :class:`skltemplate.template.TemplateClassifier`
+An example plot of :class:`fsvm.template.TemplateClassifier`
 """
 
 # %%
 # Train our classifier on very simple dataset
-from skltemplate import TemplateClassifier
+from fsvm import TemplateClassifier
 
 X = [[0, 0], [1, 1]]
 y = [0, 1]

examples/plot_template.py

@@ -3,12 +3,12 @@
 Plotting Template Estimator
 ===========================
 
-An example plot of :class:`skltemplate.template.TemplateEstimator`
+An example plot of :class:`fsvm.template.TemplateEstimator`
 """
 import numpy as np
 from matplotlib import pyplot as plt
 
-from skltemplate import TemplateEstimator
+from fsvm import TemplateEstimator
 
 X = np.arange(100).reshape(100, 1)
 y = np.zeros((100,))

examples/plot_transformer.py

@@ -3,12 +3,12 @@
 Plotting Template Transformer
 =============================
 
-An example plot of :class:`skltemplate.template.TemplateTransformer`
+An example plot of :class:`fsvm.template.TemplateTransformer`
 """
 import numpy as np
 from matplotlib import pyplot as plt
 
-from skltemplate import TemplateTransformer
+from fsvm import TemplateTransformer
 
 X = np.arange(50, dtype=np.float64).reshape(-1, 1)
 X /= 50

skltemplate/_template.py → fsvm/_template.py

@@ -37,7 +37,7 @@ class TemplateEstimator(BaseEstimator):
 
     Examples
     --------
-    >>> from skltemplate import TemplateEstimator
+    >>> from fsvm import TemplateEstimator
     >>> import numpy as np
     >>> X = np.arange(100).reshape(100, 1)
     >>> y = np.zeros((100, ))
@@ -138,7 +138,7 @@ class TemplateClassifier(ClassifierMixin, BaseEstimator):
     Examples
     --------
     >>> from sklearn.datasets import load_iris
-    >>> from skltemplate import TemplateClassifier
+    >>> from fsvm import TemplateClassifier
     >>> X, y = load_iris(return_X_y=True)
     >>> clf = TemplateClassifier().fit(X, y)
     >>> clf.predict(X)

skltemplate/tests/test_common.py → fsvm/tests/test_common.py

@@ -5,7 +5,7 @@
 
 from sklearn.utils.estimator_checks import parametrize_with_checks
 
-from skltemplate.utils.discovery import all_estimators
+from fsvm.utils.discovery import all_estimators
 
 
 # parametrize_with_checks allows to get a generator of check that is more fine-grained

skltemplate/tests/test_template.py → fsvm/tests/test_template.py

@@ -4,7 +4,7 @@
 from sklearn.datasets import load_iris
 from sklearn.utils._testing import assert_allclose, assert_array_equal
 
-from skltemplate import TemplateClassifier, TemplateEstimator, TemplateTransformer
+from fsvm import TemplateClassifier, TemplateEstimator, TemplateTransformer
 
 # Authors: scikit-learn-contrib developers
 # License: BSD 3 clause

skltemplate/utils/discovery.py → fsvm/utils/discovery.py

@@ -1,6 +1,6 @@
 """
-The :mod:`skltemplate.utils.discovery` module includes utilities to discover
-objects (i.e. estimators, displays, functions) from the `skltemplate` package.
+The :mod:`fsvm.utils.discovery` module includes utilities to discover
+objects (i.e. estimators, displays, functions) from the `fsvm` package.
 """
 
 # Adapted from scikit-learn
@@ -26,7 +26,7 @@
 
 
 def all_estimators(type_filter=None):
-    """Get a list of all estimators from `skltemplate`.
+    """Get a list of all estimators from `fsvm`.
 
     This function crawls the module and gets all classes that inherit
     from `BaseEstimator`. Classes that are defined in test-modules are not
@@ -50,7 +50,7 @@ def all_estimators(type_filter=None):
 
     Examples
     --------
-    >>> from skltemplate.utils.discovery import all_estimators
+    >>> from fsvm.utils.discovery import all_estimators
     >>> estimators = all_estimators()
     >>> type(estimators)
     <class 'list'>
@@ -64,12 +64,12 @@ def is_abstract(c):
         return True
 
     all_classes = []
-    root = str(Path(__file__).parent.parent)  # skltemplate package
+    root = str(Path(__file__).parent.parent)  # fsvm package
     # Ignore deprecation warnings triggered at import time and from walking
     # packages
     with ignore_warnings(category=FutureWarning):
         for _, module_name, _ in pkgutil.walk_packages(
-            path=[root], prefix="skltemplate."
+            path=[root], prefix="fsvm."
         ):
             module_parts = module_name.split(".")
             if any(part in _MODULE_TO_IGNORE for part in module_parts):
@@ -126,7 +126,7 @@ def is_abstract(c):
 
 
 def all_displays():
-    """Get a list of all displays from `skltemplate`.
+    """Get a list of all displays from `fsvm`.
 
     Returns
     -------
@@ -136,16 +136,16 @@ def all_displays():
 
     Examples
     --------
-    >>> from skltemplate.utils.discovery import all_displays
+    >>> from fsvm.utils.discovery import all_displays
     >>> displays = all_displays()
     """
     all_classes = []
-    root = str(Path(__file__).parent.parent)  # skltemplate package
+    root = str(Path(__file__).parent.parent)  # fsvm package
     # Ignore deprecation warnings triggered at import time and from walking
     # packages
     with ignore_warnings(category=FutureWarning):
         for _, module_name, _ in pkgutil.walk_packages(
-            path=[root], prefix="skltemplate."
+            path=[root], prefix="fsvm."
         ):
             module_parts = module_name.split(".")
             if any(part in _MODULE_TO_IGNORE for part in module_parts):
@@ -170,14 +170,14 @@ def _is_checked_function(item):
         return False
 
     mod = item.__module__
-    if not mod.startswith("skltemplate.") or mod.endswith("estimator_checks"):
+    if not mod.startswith("fsvm.") or mod.endswith("estimator_checks"):
         return False
 
     return True
 
 
 def all_functions():
-    """Get a list of all functions from `skltemplate`.
+    """Get a list of all functions from `fsvm`.
 
     Returns
     -------
@@ -187,16 +187,16 @@ def all_functions():
 
     Examples
     --------
-    >>> from skltemplate.utils.discovery import all_functions
+    >>> from fsvm.utils.discovery import all_functions
     >>> functions = all_functions()
     """
     all_functions = []
-    root = str(Path(__file__).parent.parent)  # skltemplate package
+    root = str(Path(__file__).parent.parent)  # fsvm package
     # Ignore deprecation warnings triggered at import time and from walking
     # packages
     with ignore_warnings(category=FutureWarning):
         for _, module_name, _ in pkgutil.walk_packages(
-            path=[root], prefix="skltemplate."
+            path=[root], prefix="fsvm."
         ):
             module_parts = module_name.split(".")
             if any(part in _MODULE_TO_IGNORE for part in module_parts):

skltemplate/utils/tests/test_discovery.py → fsvm/utils/tests/test_discovery.py

@@ -3,7 +3,7 @@
 
 import pytest
 
-from skltemplate.utils.discovery import all_displays, all_estimators, all_functions
+from fsvm.utils.discovery import all_displays, all_estimators, all_functions
 
 
 def test_all_estimators():