Metadata-Version: 2.1
Name: esntorch
Version: 0.0.3
Summary: Python library: Echo state Networks for NLP
Home-page: UNKNOWN
Author: Playtika Ltd.
Author-email: 
License: MIT License
Description: # EsnTorch (v0.0.2)
        **A library that implements echo state networks (ESNs) for natural language processing (NLP).**
        
        EsnTorch is a library designed for the implementation of echo state networks (ESNs)
        in the context of natural language processing (NLP). 
        More specifically, EsnTorch allows to implement ESNs for text classification tasks.
        EsnTorch is written in PyTorch. 
        
        This library works for Python 3.6 and higher and PyTorch 1.7.1 and higher.
        
        
        Installation
        ------------
        
        This library is distributed on [PyPi](https://pypi.org/project/esntorch/) and
        can be installed with ``pip``. The latest release is version ``0.0.2``.
        
        ~~~~~~~~~~~~~~~~~~~~~~
        $ pip install esntorch 
        ~~~~~~~~~~~~~~~~~~~~~~
        
        The command above will automatically install all the dependencies listed in ``requirements.txt``. 
        
        Please visit the [installation page](docs/src/installation.rst) for more details.
        
        
        
        Documentation
        -------------
        For more information, please read the full [documentation.](https://playtikaresearch.github.io/esntorch/index.html)
        
        
        
        More Info
        ---------
        
        The source code of the library is available on [GitHub](https://github.com/PlaytikaResearch/EsnTorch). 
        It can be cloned via the following command:
         
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
        $ git clone https://github.com/PlaytikaResearch/EsnTorch.git
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
        
        You can install the library and the dependencies with one of the following commands:
        
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
        $ pip install .                        # install library + dependencies
        $ pip install -r requirements.txt      # install dependencies
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
        
        To create the python wheel file ``pyabtest.whl`` for installation with ``pip`` run the following command:
        
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
        $ python setup.py sdist bdist_wheel
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
        
        To create the HTML documentation run the following commands:
        
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
        $ cd docs
        $ sphinx-apidoc -o source/ ../esntorch
        $ make clean
        $ make html
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
        
        
        License
        -------
        
        [Apache License, Version 2.0](LICENSE)
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: Operating System :: OS Independent
Requires-Python: >=3.7
Description-Content-Type: text/markdown
