Skip to content

Commit 8694508

Browse files
agramfortagramfort
committed
more renaming
1 parent b922603 commit 8694508

17 files changed

+45
-48
lines changed

‎.coveragerc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,8 @@
22

33
[run]
44
branch = True
5-
source = skltemplate
6-
include = */skltemplate/*
5+
source = sklearn_extra
6+
include = */sklearn_extra/*
77
omit =
88
*/setup.py
99

‎.travis.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ install:
3636
script:
3737
- mkdir for_test
3838
- cd for_test
39-
- pytest -v --cov=skltemplate --pyargs skltemplate
39+
- pytest -v --cov=sklearn_extra --pyargs sklearn_extra
4040

4141
after_success:
4242
- codecov

‎README.rst

Lines changed: 9 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,21 @@
11
.. -*- mode: rst -*-
22
3-
|Travis|_ |AppVeyor|_ |Codecov|_ |CircleCI|_ |ReadTheDocs|_
3+
|Travis|_ |Codecov|_ |CircleCI|_ |ReadTheDocs|_
44

5-
.. |Travis| image:: https://travis-ci.org/scikit-learn-contrib/project-template.svg?branch=master
5+
.. |Travis| image:: https://travis-ci.org/scikit-learn-contrib/scikit-learn-extra.svg?branch=master
66
.. _Travis: https://travis-ci.org/scikit-learn-contrib/project-template
77

8-
.. |AppVeyor| image:: https://ci.appveyor.com/api/projects/status/coy2qqaqr1rnnt5y/branch/master?svg=true
9-
.. _AppVeyor: https://ci.appveyor.com/project/glemaitre/project-template
10-
118
.. |Codecov| image:: https://codecov.io/gh/scikit-learn-contrib/project-template/branch/master/graph/badge.svg
12-
.. _Codecov: https://codecov.io/gh/scikit-learn-contrib/project-template
9+
.. _Codecov: https://codecov.io/gh/scikit-learn-contrib/scikit-learn-extra
1310

14-
.. |CircleCI| image:: https://circleci.com/gh/scikit-learn-contrib/project-template.svg?style=shield&circle-token=:circle-token
15-
.. _CircleCI: https://circleci.com/gh/scikit-learn-contrib/project-template/tree/master
11+
.. |CircleCI| image:: https://circleci.com/gh/scikit-learn-contrib/scikit-learn-extra.svg?style=shield&circle-token=:circle-token
12+
.. _CircleCI: https://circleci.com/gh/scikit-learn-contrib/scikit-learn-extra/tree/master
1613

17-
.. |ReadTheDocs| image:: https://readthedocs.org/projects/sklearn-template/badge/?version=latest
14+
.. |ReadTheDocs| image:: https://readthedocs.org/projects/scikit-learn-extra/badge/?version=latest
1815
.. _ReadTheDocs: https://sklearn-template.readthedocs.io/en/latest/?badge=latest
1916

20-
project-template - A template for scikit-learn contributions
21-
============================================================
17+
scikit-learn-extra - A set of useful tools compatible with scikit-learn
18+
=======================================================================
2219

2320
.. _scikit-learn: https://scikit-learn.org
2421

@@ -30,7 +27,7 @@ and (hyper)parameter search, while facilitating testing (including some API
3027
compliance), documentation, open source development, packaging, and continuous
3128
integration.
3229

33-
.. _documentation: https://sklearn-template.readthedocs.io/en/latest/quick_start.html
30+
.. _documentation: https://scikit-learn-extra.readthedocs.io/en/latest/quick_start.html
3431

3532
Refer to the documentation_ to modify the template for your own scikit-learn
3633
contribution.

‎appveyor.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ install:
3636
test_script:
3737
- mkdir for_test
3838
- cd for_test
39-
- pytest -v --cov=skltemplate --pyargs skltemplate
39+
- pytest -v --cov=sklearn_extra --pyargs sklearn_extra
4040

4141
after_test:
4242
- cp .coverage %APPVEYOR_BUILD_FOLDER%

‎doc/api.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ project-template API
44

55
This is an example on how to document the API of your own project.
66

7-
.. currentmodule:: skltemplate
7+
.. currentmodule:: sklearn_extra
88

99
Estimator
1010
=========

‎doc/conf.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -82,7 +82,7 @@
8282
# built documents.
8383
#
8484
# The short X.Y version.
85-
from skltemplate import __version__
85+
from sklearn_extra import __version__
8686
version = __version__
8787
# The full version, including alpha/beta/rc tags.
8888
release = __version__
@@ -306,10 +306,10 @@
306306

307307
# sphinx-gallery configuration
308308
sphinx_gallery_conf = {
309-
'doc_module': 'skltemplate',
309+
'doc_module': 'sklearn_extra',
310310
'backreferences_dir': os.path.join('generated'),
311311
'reference_url': {
312-
'skltemplate': None}
312+
'sklearn_extra': None}
313313
}
314314

315315
def setup(app):

‎doc/quick_start.rst

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
#####################################
2-
Quick Start with the project-template
3-
#####################################
1+
#######################################
2+
Quick Start with the scikit-learn-extra
3+
#######################################
44

55
This package serves as a skeleton package aiding at developing compatible
66
scikit-learn contribution.
@@ -11,22 +11,22 @@ Creating your own scikit-learn contribution package
1111
1. Download and setup your repository
1212
-------------------------------------
1313

14-
To create your package, you need to clone the ``project-template`` repository::
14+
To create your package, you need to clone the ``scikit-learn-extra`` repository::
1515

16-
$ git clone https://github.com/scikit-learn-contrib/project-template.git
16+
$ git clone https://github.com/scikit-learn-contrib/scikit-learn-extra.git
1717

1818
Before to reinitialize your git repository, you need to make the following
19-
changes. Replace all occurrences of ``skltemplate`` and ``sklearn-template``
19+
changes. Replace all occurrences of ``sklearn_extra`` and ``sklearn-template``
2020
with the name of you own contribution. You can find all the occurrences using
2121
the following command::
2222

23-
$ git grep skltemplate
23+
$ git grep sklearn_extra
2424
$ git grep sklearn-template
2525

2626
To remove the history of the template package, you need to remove the `.git`
2727
directory::
2828

29-
$ cd project-template
29+
$ cd scikit-learn-extra
3030
$ rm -rf .git
3131

3232
Then, you need to initialize your new git repository::

‎examples/plot_classifier.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,11 +3,11 @@
33
Plotting Template Classifier
44
============================
55
6-
An example plot of :class:`skltemplate.template.TemplateClassifier`
6+
An example plot of :class:`sklearn_extra.template.TemplateClassifier`
77
"""
88
import numpy as np
99
from matplotlib import pyplot as plt
10-
from skltemplate import TemplateClassifier
10+
from sklearn_extra import TemplateClassifier
1111

1212
X = [[0, 0], [1, 1]]
1313
y = [0, 1]

‎examples/plot_template.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,11 +3,11 @@
33
Plotting Template Estimator
44
===========================
55
6-
An example plot of :class:`skltemplate.template.TemplateEstimator`
6+
An example plot of :class:`sklearn_extra.template.TemplateEstimator`
77
"""
88
import numpy as np
99
from matplotlib import pyplot as plt
10-
from skltemplate import TemplateEstimator
10+
from sklearn_extra import TemplateEstimator
1111

1212
X = np.arange(100).reshape(100, 1)
1313
y = np.zeros((100, ))

‎examples/plot_transformer.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,11 +3,11 @@
33
Plotting Template Transformer
44
=============================
55
6-
An example plot of :class:`skltemplate.template.TemplateTransformer`
6+
An example plot of :class:`sklearn_extra.template.TemplateTransformer`
77
"""
88
import numpy as np
99
from matplotlib import pyplot as plt
10-
from skltemplate import TemplateTransformer
10+
from sklearn_extra import TemplateTransformer
1111

1212
X = np.arange(50, dtype=np.float).reshape(-1, 1)
1313
X /= 50

0 commit comments

Comments
 (0)