Metadata-Version: 2.1
Name: ru-proverbs
Version: 1.1.2
Summary: Russian Proverbs AI-powered proverbs generator.
Home-page: https://github.com/xSAVIKx/ru-proverbs
License: Apache-2.0
Keywords: python,textgenrnn,ML,AI,tensorflow
Author: Yurii Serhiichuk
Author-email: savik.ne@gmail.com
Requires-Python: >=3.7,<4.0
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Requires-Dist: tensorflow (>=2.3.1,<3.0.0)
Requires-Dist: textgenrnn (>=2.0.0,<3.0.0)
Project-URL: Bug Tracker, https://github.com/xSAVIKx/ru-proverbs/issues
Project-URL: Repository, https://github.com/xSAVIKx/ru-proverbs
Description-Content-Type: text/markdown

RU Proverbs AI module
-------
[![PyPI version](https://badge.fury.io/py/ru-proverbs.svg)](https://badge.fury.io/py/ru-proverbs)

This module provides API that allows generating Russian Proverbs with the power of AI.

# Requirements

For Windows builds:

In the current version we use Python 3.7.8, Tensorflow 2.3.1 and CUDA 10.1.

1. Python 3.7.x x64 (tested with [Python 3.7.6x64][python]).

2. [Poetry][poetry].

3. Install dependencies:

   2.1 Install dependencies and virtual env: `poetry install`.

   2.2 Optionally install and configure CUDA support.

## Configure CUDA

1. Download [CUDA Toolkit][cuda-toolkit] and unpack into e.g. `D:\DevTools\cuda\v10.1`.

2. Download matching [cuDNN][cuDNN] version (e.g. v7.6.5 for CUDA 10.1) and unpack under the
   versioned CUDA folder, e.g. `D:\DevTools\cuda\v10.1\cudnn`.

3. Add CUDA paths to environment variables and `PATH`:

   Create `CUDA_HOME` and `CUDA_PATHS` env variables with the following values:
    ```cmd
    SET CUDA_HOME=D:\DevTools\cuda\v10.1
    SET CUDA_PATHS=%CUDA_HOME%\bin;%CUDA_HOME%\include;%CUDA_HOME%\extras;%CUDA_HOME%\libnvvp;%CUDA_HOME%\cudnn\bin;
    ```

   Add `CUDA_PATHS` to `PATH`: `SET PATH=%CUDA_PATHS%;%PATH%`.

[python]: https://www.python.org/downloads/release/python-376/

[poetry]: https://python-poetry.org/

[tensorflow]: https://www.tensorflow.org/install/pip

[cuda-toolkit]: https://developer.nvidia.com/cuda-10.1-download-archive-update2?target_os=Windows&target_arch=x86_64&target_version=10&target_type=exelocal

[cuDNN]: https://developer.nvidia.com/rdp/cudnn-download

