Quick Start¶
Programming Language: Python 3.7, Cython, C (created by Cython)
Python Packages: numpy, scipy, scikit-learn
You just want to use it¶
1. pip installation¶
The koho
package is available through PyPi and
can be installed using pip:
$: pip install koho
2. Read the Docs¶
The koho documentation is hosted on Read the Docs:
Firefox: http://koho.readthedocs.io
3. Jupyter notebook¶
The koho
package can be used with jupyter notebook:
$: conda install jupyter
$: conda install tornado=5.1.1 # downgrade if connection problems with jupyter
$: jupyter notebook
[] from koho.sklearn import DecisionTreeClassifier, DecisionForestClassifier
[] ...
Download¶
1. Download and install repository¶
Clone the koho repository from GitHub:
$: sudo apt install git
$: git clone https://github.com/aiwerkstatt/koho.git
Build and install the koho
package using the C file generated by Cython:
koho$: python setup.py build_ext --inplace
koho$: pip install -e .
Build and install the koho
package using Cython:
$: pip install cython
koho$: python setup.py build_ext --inplace --use-cython
koho$: pip install -e .
2. Generate the documentation¶
Generate the koho
documentation using sphinx:
$: conda install -c conda-forge sphinx sphinx-gallery sphinx_rtd_theme matplotlib numpydoc pillow
koho/doc$: make html
View the koho
documentation:
Firebox: file:///home/<user>/<...>/koho/doc/_build/html/index.html
3. Run tests¶
Test the koho
package using pytest with pytest-cov plugin:
$: conda install pytest pytest-cov
koho$: pytest --disable-pytest-warnings -v --cov=koho --pyargs koho/sklearn