Skip to content

Commit

Permalink
names
Browse files Browse the repository at this point in the history
  • Loading branch information
Jaime Sendra committed Apr 16, 2020
1 parent fc3477a commit 6112a7a
Show file tree
Hide file tree
Showing 202 changed files with 608 additions and 608 deletions.
10 changes: 5 additions & 5 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,14 +14,14 @@ Fixes #366
### Pull Request Checklist

- [ ] Added a note about the modification or contribution to the `./docs/sources/CHANGELOG.md` file (if applicable)
- [ ] Added appropriate unit test functions in the `./mlearn/*/tests` directories (if applicable)
- [ ] Modify documentation in the corresponding Jupyter Notebook under `mlearn/docs/sources/` (if applicable)
- [ ] Ran `PYTHONPATH='.' pytest ./mlearn -sv` and make sure that all unit tests pass (for small modifications, it might be sufficient to only run the specific test file, e.g., `PYTHONPATH='.' pytest ./mlearn/classifier/tests/xxx.py -sv`)
- [ ] Checked for style issues by running `flake8 ./mlearn`
- [ ] Added appropriate unit test functions in the `./mlearner/*/tests` directories (if applicable)
- [ ] Modify documentation in the corresponding Jupyter Notebook under `mlearner/docs/sources/` (if applicable)
- [ ] Ran `PYTHONPATH='.' pytest ./mlearner -sv` and make sure that all unit tests pass (for small modifications, it might be sufficient to only run the specific test file, e.g., `PYTHONPATH='.' pytest ./mlearner/classifier/tests/xxx.py -sv`)
- [ ] Checked for style issues by running `flake8 ./mlearner`


<!--NOTE
Due to the improved GitHub UI, the squashing of commits is no longer necessary.
Please DO NOT SQUASH commits since they help with keeping track of the changes during the discussion).
For more information and instructions, please see http://jaisenbe58r.github.io/mlearn/contributing/
For more information and instructions, please see http://jaisenbe58r.github.io/mlearner/contributing/
-->
2 changes: 1 addition & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

# Documentation builds
# docs/site/
# docs/mlearn.pdf
# docs/mlearner.pdf

# Temporary documentation files
# docs/sources/user_guide/*.md
Expand Down
38 changes: 19 additions & 19 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
[![DOI](http://joss.theoj.org/papers/10.21105/joss.00638/status.svg)](https://doi.org/10.21105/joss.00638)
[![Build Status](https://travis-ci.org/jaisenbe58r/mlearn.svg?branch=master)](https://travis-ci.org/jaisenbe58r/mlearn)
[![Build status](https://ci.appveyor.com/api/projects/status/7vx20e0h5dxcyla2/branch/master?svg=true)](https://ci.appveyor.com/project/jaisenbe58r/mlearn/branch/master)
[![Codacy Badge](https://api.codacy.com/project/badge/Grade/2a199e28871c477d9ecf6e200b4977b9)](https://www.codacy.com/manual/jaisenbe58r/mlearn?utm_source=github.com&amp;utm_medium=referral&amp;utm_content=jaisenbe58r/mlearn&amp;utm_campaign=Badge_Grade)
[![Coverage Status](https://coveralls.io/repos/jaisenbe58r/mlearn/badge.svg?branch=master&service=github)](https://coveralls.io/github/jaisenbe58r/mlearn?branch=master)
[![Build Status](https://travis-ci.org/jaisenbe58r/mlearner.svg?branch=master)](https://travis-ci.org/jaisenbe58r/mlearner)
[![Build status](https://ci.appveyor.com/api/projects/status/7vx20e0h5dxcyla2/branch/master?svg=true)](https://ci.appveyor.com/project/jaisenbe58r/mlearner/branch/master)
[![Codacy Badge](https://api.codacy.com/project/badge/Grade/2a199e28871c477d9ecf6e200b4977b9)](https://www.codacy.com/manual/jaisenbe58r/mlearner?utm_source=github.com&amp;utm_medium=referral&amp;utm_content=jaisenbe58r/mlearner&amp;utm_campaign=Badge_Grade)
[![Coverage Status](https://coveralls.io/repos/jaisenbe58r/mlearner/badge.svg?branch=master&service=github)](https://coveralls.io/github/jaisenbe58r/mlearner?branch=master)
![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)
![Python 3.7](https://img.shields.io/badge/python-3.8-blue.svg)
Expand All @@ -12,7 +12,7 @@
![](./docs/sources/img/logo.png)


**mlearn (machine learning for data enginnering) is a Python library of useful tools for the day-to-day data science tasks.**
**mlearner (machine learning for data enginnering) is a Python library of useful tools for the day-to-day data science tasks.**

<br>

Expand All @@ -22,47 +22,47 @@ Jaime Sendra - 2020

## Links

- **Documentation:** [http://jaisenbe58r.github.io/mlearn](http://jaisenbe58r.github.io/mlearn)
- PyPI: [https://pypi.python.org/pypi/mlearn](https://pypi.python.org/pypi/mlearn)
- Changelog: [http://jaisenbe58r.github.io/mlearn/CHANGELOG](http://jaisenbe58r.github.io/mlearn/CHANGELOG)
- Contributing: [http://jaisenbe58r.github.io/mlearn/CONTRIBUTING](http://jaisenbe58r.github.io/mlearn/CONTRIBUTING)
- Questions? Check out the [Google Groups mailing list](https://groups.google.com/forum/#!forum/mlearn)
- **Documentation:** [http://jaisenbe58r.github.io/mlearner](http://jaisenbe58r.github.io/mlearner)
- PyPI: [https://pypi.python.org/pypi/mlearner](https://pypi.python.org/pypi/mlearner)
- Changelog: [http://jaisenbe58r.github.io/mlearner/CHANGELOG](http://jaisenbe58r.github.io/mlearner/CHANGELOG)
- Contributing: [http://jaisenbe58r.github.io/mlearner/CONTRIBUTING](http://jaisenbe58r.github.io/mlearner/CONTRIBUTING)
- Questions? Check out the [Google Groups mailing list](https://groups.google.com/forum/#!forum/mlearner)

<br>
<br>

## Installing mlearn
## Installing mlearner

#### PyPI

To install mlearn, just execute
To install mlearner, just execute

```bash
pip install mlearn
pip install mlearner
```

Alternatively, you could download the package manually from the Python Package Index [https://pypi.python.org/pypi/mlearn](https://pypi.python.org/pypi/mlearn), unzip it, navigate into the package, and use the command:
Alternatively, you could download the package manually from the Python Package Index [https://pypi.python.org/pypi/mlearner](https://pypi.python.org/pypi/mlearner), unzip it, navigate into the package, and use the command:

```bash
python setup.py install
```

#### Conda
If you use conda, to install mlearn just execute
If you use conda, to install mlearner just execute

```bash
conda install -c conda-forge mlearn
conda install -c conda-forge mlearner
```

#### Dev Version

The mlearn version on PyPI may always be one step behind; you can install the latest development version from the GitHub repository by executing
The mlearner version on PyPI may always be one step behind; you can install the latest development version from the GitHub repository by executing

```bash
pip install git+git://github.com/jaisenbe58r/mlearn.git#egg=mlearn
pip install git+git://github.com/jaisenbe58r/mlearner.git#egg=mlearner
```

Or, you can fork the GitHub repository from https://github.com/jaisenbe58r/MLearn and install mlearn from your local drive via
Or, you can fork the GitHub repository from https://github.com/jaisenbe58r/mlearnerer and install mlearner from your local drive via

```bash
python setup.py install
Expand Down
2 changes: 1 addition & 1 deletion docs/ipynb2markdown.py
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# IPython Notebook to Markdown conversion script
#
# Jaime Sendra Berenguer
# mlearn Machine Learning Library Extensions
# mlearner Machine Learning Library Extensions
#
# Author: Sebastian Raschka <sebastianraschka.com>
#
Expand Down
18 changes: 9 additions & 9 deletions docs/make_api.py
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# IPython Notebook to Markdown conversion script
#
# Jaime Sendra Berenguer
# mlearn Machine Learning Library Extensions
# mlearner Machine Learning Library Extensions
#
# Author: Sebastian Raschka <sebastianraschka.com>
#
Expand Down Expand Up @@ -257,8 +257,8 @@ def generate_api_docs(package, api_dir, clean=False,
ignore_packages : iterable or None (default: None)
Iterable (list, set, tuple) that contains the names of packages
and subpackages to ignore or skip. For instance, if the
images subpackage in mlearn is supposed to be split, provide the
argument `{mlearn.image}`.
images subpackage in mlearner is supposed to be split, provide the
argument `{mlearner.image}`.
"""
if printlog:
Expand Down Expand Up @@ -417,10 +417,10 @@ def summarize_methdods_and_functions(api_modules, out_dir,
formatter_class=argparse.RawTextHelpFormatter)

parser.add_argument('-n', '--package_name',
default='mlearn',
default='mlearner',
help='Name of the package')
parser.add_argument('-d', '--package_dir',
default='../../mlearn/',
default='../../mlearner/',
help="Path to the package's enclosing directory")
parser.add_argument('-o1', '--output_module_api',
default='../docs/sources/api_modules',
Expand All @@ -442,11 +442,11 @@ def summarize_methdods_and_functions(api_modules, out_dir,
parser.add_argument('--ignore_packages',
default='',
help='Ignores subpackages listed via this option.'
' For example, to ignore mlearn.image,'
' type "mlearn.image".'
' For example, to ignore mlearner.image,'
' type "mlearner.image".'
' For multiple subpackages, separate them via,'
' commas. For example,'
' "mlearn.image,mlearn.plotting".')
' "mlearner.image,mlearner.plotting".')

args = parser.parse_args()

Expand All @@ -462,6 +462,6 @@ def summarize_methdods_and_functions(api_modules, out_dir,
out_dir=args.output_subpackage_api,
printlog=not(args.silent),
clean=args.clean,
str_above_header=('mlearn'
str_above_header=('mlearner'
' version: %s \n' % (
package.__version__)))
2 changes: 1 addition & 1 deletion docs/make_userguide.py
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# IPython Notebook to Markdown conversion script
#
# Jaime Sendra Berenguer
# mlearn Machine Learning Library Extensions
# mlearner Machine Learning Library Extensions
#
# Author: Sebastian Raschka <sebastianraschka.com>
#
Expand Down
8 changes: 4 additions & 4 deletions docs/md2pdf.py
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# IPython Notebook to Markdown conversion script
#
# Jaime Sendra Berenguer
# mlearn Machine Learning Library Extensions
# mlearner Machine Learning Library Extensions
#
# Author: Sebastian Raschka <sebastianraschka.com>
#
Expand All @@ -11,7 +11,7 @@
import yaml
import os
import subprocess
from mlearn import __version__
from mlearner import __version__

yaml_path = "./mkdocs.yml"
source_path = os.path.join(os.path.dirname(yaml_path), 'sources')
Expand Down Expand Up @@ -58,7 +58,7 @@ def gen_title(fname):

with open(md_out_path, 'w') as f_out:
meta = r"""---
title: mlearn %s
title: mlearner %s
subtitle: Library Documentation
author: Sebastian Raschka
header-includes:
Expand Down Expand Up @@ -93,7 +93,7 @@ def gen_title(fname):
f_out.write(line)
f_out.write('\n\n')

subprocess.check_call(['pandoc', '-N', 'temp.md', '--output=mlearn.pdf',
subprocess.check_call(['pandoc', '-N', 'temp.md', '--output=mlearner.pdf',
'--toc',
'--normalize', '--smart', '--latex-engine=xelatex',
'--toc-depth=4', '--highlight-style=pygments',
Expand Down
10 changes: 5 additions & 5 deletions docs/mkdocs.yml
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
site_name: mlearn
site_url: http://jaisenbe58r.github.io/mlearn
site_name: mlearner
site_url: http://jaisenbe58r.github.io/mlearner
site_author: Jaime Sendra Berenguer
site_description: A library consisting of useful tools and extensions for the day-to-day data science tasks.


repo_url: https://github.com/jaisenbe58r/MLearn
repo_url: https://github.com/jaisenbe58r/mlearnerer
repo_name: GitHub
edit_uri: docs/sources/user_guide/

Expand Down Expand Up @@ -32,7 +32,7 @@ extra_css:
- cinder/css/font-awesome-4.0.3.css
- cinder/css/highlight.css

# google_analytics: ['UA-38457794-2', 'jaisenbe58r.github.io/mlearn/']
# google_analytics: ['UA-38457794-2', 'jaisenbe58r.github.io/mlearner/']

nav:
- Home: index.md
Expand All @@ -47,5 +47,5 @@ nav:
- How To Contribute: CONTRIBUTING.md
- Contributors: contributors.md
- License: license.md
- Citing mlearn: cite.md
- Citing mlearner: cite.md
- Discuss: discuss.md
2 changes: 1 addition & 1 deletion docs/sources/CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
---

The CHANGELOG for the current development version is available at
[https://github.com/jaisenbe58r/MLearn/blob/master/docs/sources/CHANGELOG.md](https://github.com/jaisenbe58r/MLearn/blob/master/docs/sources/CHANGELOG.md).
[https://github.com/jaisenbe58r/mlearnerer/blob/master/docs/sources/CHANGELOG.md](https://github.com/jaisenbe58r/mlearnerer/blob/master/docs/sources/CHANGELOG.md).

---

Expand Down
Loading

0 comments on commit 6112a7a

Please sign in to comment.