Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Various documentation improvements #710

Merged
merged 1 commit into from
Jul 28, 2020
Merged

Various documentation improvements #710

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
[![DOI](http://joss.theoj.org/papers/10.21105/joss.00638/status.svg)](https://doi.org/10.21105/joss.00638)
[![DOI](https://joss.theoj.org/papers/10.21105/joss.00638/status.svg)](https://doi.org/10.21105/joss.00638)
[![Build Status](https://travis-ci.org/rasbt/mlxtend.svg?branch=master)](https://travis-ci.org/rasbt/mlxtend)
[![Build status](https://ci.appveyor.com/api/projects/status/7vx20e0h5dxcyla2/branch/master?svg=true)](https://ci.appveyor.com/project/rasbt/mlxtend/branch/master)
[![Codacy Badge](https://api.codacy.com/project/badge/Grade/2a199e28871c477d9ecf6e200b4977b9)](https://www.codacy.com/manual/rasbt/mlxtend?utm_source=github.com&utm_medium=referral&utm_content=rasbt/mlxtend&utm_campaign=Badge_Grade)
Expand Down
8 changes: 4 additions & 4 deletions docs/make_api.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -156,7 +156,7 @@ def object_to_markdownpage(obj_name, obj, s=''):


def import_package(rel_path_to_package, package_name):
"""Imports a python package into the current namespace.
"""Imports a Python package into the current namespace.

Parameters
----------
Expand Down Expand Up @@ -187,7 +187,7 @@ def get_subpackages(package):

Parameters
----------
package : python package object
package : Python package object

Returns
--------
Expand All @@ -202,7 +202,7 @@ def get_modules(package):

Parameters
----------
package : python package object
package : Python package object

Returns
--------
Expand All @@ -217,7 +217,7 @@ def get_functions_and_classes(package):

Parameters
----------
package : python package object
package : Python package object

Returns
--------
Expand Down
2 changes: 1 addition & 1 deletion docs/mkdocs.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ extra_css:
- cinder/css/font-awesome-4.0.3.css
- cinder/css/highlight.css

copyright: Copyright &copy; 2014-2019 <a href="http://sebastianraschka.com">Sebastian Raschka</a>
copyright: Copyright &copy; 2014-2020 <a href="http://sebastianraschka.com">Sebastian Raschka</a>
google_analytics: ['UA-38457794-2', 'rasbt.github.io/mlxtend/']

nav:
Expand Down
2 changes: 1 addition & 1 deletion docs/sources/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
**Mlxtend (machine learning extensions) is a Python library of useful tools for the day-to-day data science tasks.**


[![DOI](http://joss.theoj.org/papers/10.21105/joss.00638/status.svg)](https://doi.org/10.21105/joss.00638)
[![DOI](https://joss.theoj.org/papers/10.21105/joss.00638/status.svg)](https://doi.org/10.21105/joss.00638)
[![PyPI version](https://badge.fury.io/py/mlxtend.svg)](http://badge.fury.io/py/mlxtend)
![Python 3.6](https://img.shields.io/badge/python-3.6-blue.svg)
![Python 3.7](https://img.shields.io/badge/python-3.7-blue.svg)
Expand Down
52 changes: 26 additions & 26 deletions docs/sources/user_guide/evaluate/PredefinedHoldoutSplit.ipynb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -102,19 +102,24 @@
"metadata": {},
"outputs": [
{
"name": "stdout",
"output_type": "stream",
"text": [
"[mean: 1.00000, std: 0.00000, params: {'n_neighbors': 1}, mean: 1.00000, std: 0.00000, params: {'n_neighbors': 2}, mean: 1.00000, std: 0.00000, params: {'n_neighbors': 3}, mean: 1.00000, std: 0.00000, params: {'n_neighbors': 4}, mean: 1.00000, std: 0.00000, params: {'n_neighbors': 5}]\n"
]
},
{
"name": "stderr",
"output_type": "stream",
"text": [
"/Users/sebastian/miniconda3/lib/python3.6/site-packages/sklearn/model_selection/_search.py:762: DeprecationWarning: The grid_scores_ attribute was deprecated in version 0.18 in favor of the more elaborate cv_results_ attribute. The grid_scores_ attribute will not be available from 0.20\n",
" DeprecationWarning)\n"
]
"data": {
"text/plain": [
"GridSearchCV(cv=<mlxtend.evaluate.holdout.PredefinedHoldoutSplit object at 0x7f93c8d16b38>,\n",
" error_score=nan,\n",
" estimator=KNeighborsClassifier(algorithm='auto', leaf_size=30,\n",
" metric='minkowski',\n",
" metric_params=None, n_jobs=None,\n",
" n_neighbors=5, p=2,\n",
" weights='uniform'),\n",
" iid='deprecated', n_jobs=None,\n",
" param_grid={'n_neighbors': [1, 2, 3, 4, 5]},\n",
" pre_dispatch='2*n_jobs', refit=True, return_train_score=False,\n",
" scoring=None, verbose=0)"
]
},
"execution_count": 3,
"metadata": {},
"output_type": "execute_result"
}
],
"source": [
Expand All @@ -132,10 +137,7 @@
" param_grid=params,\n",
" cv=PredefinedHoldoutSplit(valid_indices=[0, 1, 99]))\n",
"\n",
"grid.fit(X, y)\n",
"\n",
"assert grid.n_splits_ == 1\n",
"print(grid.grid_scores_)"
"grid.fit(X, y)"
]
},
{
Expand Down Expand Up @@ -173,6 +175,11 @@
" training set are used to for a training subset\n",
" for model fitting.\n",
"\n",
"**Examples**\n",
"\n",
"For usage examples, please see\n",
" [http://rasbt.github.io/mlxtend/user_guide/evaluate/PredefinedHoldoutSplit/](http://rasbt.github.io/mlxtend/user_guide/evaluate/PredefinedHoldoutSplit/)\n",
"\n",
"### Methods\n",
"\n",
"<hr>\n",
Expand Down Expand Up @@ -248,13 +255,6 @@
" s = f.read() \n",
"print(s)"
]
},
{
"cell_type": "code",
"execution_count": null,
"metadata": {},
"outputs": [],
"source": []
}
],
"metadata": {
Expand All @@ -274,7 +274,7 @@
"name": "python",
"nbconvert_exporter": "python",
"pygments_lexer": "ipython3",
"version": "3.6.6"
"version": "3.7.1"
},
"toc": {
"nav_menu": {},
Expand All @@ -290,5 +290,5 @@
}
},
"nbformat": 4,
"nbformat_minor": 1
"nbformat_minor": 4
}
52 changes: 26 additions & 26 deletions docs/sources/user_guide/evaluate/RandomHoldoutSplit.ipynb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -102,19 +102,24 @@
"metadata": {},
"outputs": [
{
"name": "stdout",
"output_type": "stream",
"text": [
"[mean: 0.95556, std: 0.00000, params: {'n_neighbors': 1}, mean: 0.95556, std: 0.00000, params: {'n_neighbors': 2}, mean: 0.95556, std: 0.00000, params: {'n_neighbors': 3}, mean: 0.95556, std: 0.00000, params: {'n_neighbors': 4}, mean: 0.95556, std: 0.00000, params: {'n_neighbors': 5}]\n"
]
},
{
"name": "stderr",
"output_type": "stream",
"text": [
"/Users/sebastian/miniconda3/lib/python3.6/site-packages/sklearn/model_selection/_search.py:762: DeprecationWarning: The grid_scores_ attribute was deprecated in version 0.18 in favor of the more elaborate cv_results_ attribute. The grid_scores_ attribute will not be available from 0.20\n",
" DeprecationWarning)\n"
]
"data": {
"text/plain": [
"GridSearchCV(cv=<mlxtend.evaluate.holdout.RandomHoldoutSplit object at 0x7fcf8061ba90>,\n",
" error_score=nan,\n",
" estimator=KNeighborsClassifier(algorithm='auto', leaf_size=30,\n",
" metric='minkowski',\n",
" metric_params=None, n_jobs=None,\n",
" n_neighbors=5, p=2,\n",
" weights='uniform'),\n",
" iid='deprecated', n_jobs=None,\n",
" param_grid={'n_neighbors': [1, 2, 3, 4, 5]},\n",
" pre_dispatch='2*n_jobs', refit=True, return_train_score=False,\n",
" scoring=None, verbose=0)"
]
},
"execution_count": 3,
"metadata": {},
"output_type": "execute_result"
}
],
"source": [
Expand All @@ -131,10 +136,7 @@
" param_grid=params,\n",
" cv=RandomHoldoutSplit(valid_size=0.3, random_seed=123))\n",
"\n",
"grid.fit(X, y)\n",
"\n",
"assert grid.n_splits_ == 1\n",
"print(grid.grid_scores_)"
"grid.fit(X, y)"
]
},
{
Expand Down Expand Up @@ -180,6 +182,11 @@
" True or False, whether to perform a stratified\n",
" split or not\n",
"\n",
"**Examples**\n",
"\n",
"For usage examples, please see\n",
" [http://rasbt.github.io/mlxtend/user_guide/evaluate/RandomHoldoutSplit/](http://rasbt.github.io/mlxtend/user_guide/evaluate/RandomHoldoutSplit/)\n",
"\n",
"### Methods\n",
"\n",
"<hr>\n",
Expand Down Expand Up @@ -255,13 +262,6 @@
" s = f.read() \n",
"print(s)"
]
},
{
"cell_type": "code",
"execution_count": null,
"metadata": {},
"outputs": [],
"source": []
}
],
"metadata": {
Expand All @@ -281,7 +281,7 @@
"name": "python",
"nbconvert_exporter": "python",
"pygments_lexer": "ipython3",
"version": "3.6.6"
"version": "3.7.1"
},
"toc": {
"nav_menu": {},
Expand All @@ -297,5 +297,5 @@
}
},
"nbformat": 4,
"nbformat_minor": 1
"nbformat_minor": 4
}
5 changes: 5 additions & 0 deletions docs/sources/user_guide/evaluate/accuracy_score.ipynb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -281,6 +281,11 @@
"\n",
"score: float\n",
"\n",
"**Examples**\n",
"\n",
"For usage examples, please see\n",
" [http://rasbt.github.io/mlxtend/user_guide/evaluate/accuracy_score/](http://rasbt.github.io/mlxtend/user_guide/evaluate/accuracy_score/)\n",
"\n",
"\n"
]
}
Expand Down
9 changes: 7 additions & 2 deletions docs/sources/user_guide/evaluate/bias_variance_decomp.ipynb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -466,6 +466,11 @@
" average bias, and average bias (all floats), where the average\n",
" is computed over the data points in the test set.\n",
"\n",
"**Examples**\n",
"\n",
"For usage examples, please see\n",
" [http://rasbt.github.io/mlxtend/user_guide/evaluate/bias_variance_decomp/](http://rasbt.github.io/mlxtend/user_guide/evaluate/bias_variance_decomp/)\n",
"\n",
"\n"
]
}
Expand Down Expand Up @@ -494,7 +499,7 @@
"name": "python",
"nbconvert_exporter": "python",
"pygments_lexer": "ipython3",
"version": "3.6.5"
"version": "3.7.1"
},
"toc": {
"nav_menu": {},
Expand All @@ -510,5 +515,5 @@
}
},
"nbformat": 4,
"nbformat_minor": 1
"nbformat_minor": 4
}
Loading