Metadata-Version: 2.4
Name: smltk
Version: 3.1.0
Summary: Simple Machine Learning Tool Kit package
Home-page: https://smltk.readthedocs.io/
Author: Alessandra Bilardi
Author-email: Alessandra Bilardi <alessandra.bilardi@gmail.com>
License: MIT
Project-URL: Bug_Reports, https://github.com/bilardi/smltk/issues
Project-URL: Documentation, https://smltk.readthedocs.io/
Project-URL: Funding, https://donate.pypi.org
Project-URL: Source, https://github.com/bilardi/smltk
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.6
Description-Content-Type: text/x-rst
License-File: LICENSE
Requires-Dist: klib
Requires-Dist: matplotlib
Requires-Dist: mlxtend
Requires-Dist: numpy
Requires-Dist: pandas
Requires-Dist: pingouin
Requires-Dist: scikit-learn
Requires-Dist: seaborn
Requires-Dist: simplemma
Requires-Dist: snowballstemmer
Requires-Dist: tokenizers
Provides-Extra: ntk
Requires-Dist: nltk; extra == "ntk"
Requires-Dist: wordcloud; extra == "ntk"
Provides-Extra: object-detection
Requires-Dist: torch; extra == "object-detection"
Requires-Dist: torchvision; extra == "object-detection"
Requires-Dist: Pillow; extra == "object-detection"
Requires-Dist: requests; extra == "object-detection"
Provides-Extra: complete
Requires-Dist: nltk; extra == "complete"
Requires-Dist: torch; extra == "complete"
Requires-Dist: torchvision; extra == "complete"
Requires-Dist: Pillow; extra == "complete"
Requires-Dist: requests; extra == "complete"
Requires-Dist: wordcloud; extra == "complete"
Dynamic: author
Dynamic: home-page
Dynamic: license-file
Dynamic: requires-python

Getting started
===============

smltk (Simple Machine Learning Tool Kit) package is implemented for helping your work during

* data preparation
* testing your model

The goal is to implement this package for each step of machine learning process that can simplify your code.

It is part of the `educational repositories <https://github.com/pandle/materials>`_ to learn how to write stardard code and common uses of the TDD.

Installation
############

If you want to use this package into your code, you can install by python3-pip:

.. code-block:: bash

    pip3 install smltk
    python3
    >>> from smltk.modeling import Modeling
    >>> help(Metrics)

The package is not self-consistent. So if you want to contribute, you have to download the package by github and to install the requirements

.. code-block:: bash

    git clone https://github.com/bilardi/smltk
    cd smltk/
    pip3 install --upgrade -r requirements.txt

But you can also decide which package download:

* if you want the basic package,

.. code-block:: bash

    pip3 install smltk

* if you want to download the dependencies of the class Ntk,

.. code-block:: bash

    pip3 install smltk[ntk]

* if you want to download the dependencies of the class ObjectDetection,

.. code-block:: bash

    pip3 install smltk[object_detection]

Read the documentation on `readthedocs <https://smltk.readthedocs.io/en/latest/>`_ for

* API
* Usage
* Development

Change Log
##########

See `CHANGELOG.md <https://github.com/bilardi/smltk/blob/master/CHANGELOG.md>`_ for details.

License
#######

This package is released under the MIT license.  See `LICENSE <https://github.com/bilardi/smltk/blob/master/LICENSE>`_ for details.
