redisai


Nameredisai JSON
Version 1.3.0 PyPI version JSON
download
home_page
SummaryRedisAI Python Client
upload_time2023-02-05 15:21:07
maintainer
docs_urlNone
authorRedis
requires_python>=3.8,<=4.0.0
licenseBSD-3-Clause
keywords
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            ==========
redisai-py
==========

.. image:: https://img.shields.io/github/license/RedisAI/redisai-py.svg
        :target: https://github.com/RedisAI/redisai-py

.. image:: https://badge.fury.io/py/redisai.svg
        :target: https://badge.fury.io/py/redisai

.. image:: https://github.com/RedisAI/redisai-py/actions/workflows/integration.yml/badge.svg
        :target: https://github.com/RedisAI/redisai-py/actions/workflows/integration.yml

.. image:: https://img.shields.io/github/release/RedisAI/redisai-py.svg
        :target: https://github.com/RedisAI/redisai-py/releases/latest

.. image:: https://codecov.io/gh/RedisAI/redisai-py/branch/master/graph/badge.svg
        :target: https://codecov.io/gh/RedisAI/redisai-py

.. image:: https://readthedocs.org/projects/redisai-py/badge/?version=latest
        :target: https://redisai-py.readthedocs.io/en/latest/?badge=latest

.. image:: https://img.shields.io/badge/Forum-RedisAI-blue
        :target: https://forum.redis.com/c/modules/redisai

.. image:: https://img.shields.io/discord/697882427875393627?style=flat-square
        :target: https://discord.gg/rTQm7UZ

.. image:: https://snyk.io/test/github/RedisAI/redisai-py/badge.svg?targetFile=pyproject.toml
        :target: https://snyk.io/test/github/RedisAI/redisai-py?targetFile=pyproject.toml

redisai-py is the Python client for RedisAI. Checkout the
`documentation <https://redisai-py.readthedocs.io/en/latest/>`_ for API details and examples

Installation
------------

1. Install Redis 5.0 or above
2. Install `RedisAI <http://redisai.io>`_
3. Install the Python client

.. code-block:: bash

    $ pip install redisai


4. Install serialization-deserialization utility (optional)

.. code-block:: bash

    $ pip install ml2rt

Development
-----------

1. Assuming you have virtualenv installed, create a virtualenv to manage your python dependencies, and activate it.
   ```virtualenv -v venv; source venv/bin/activate```
2. Install [pypoetry](https://python-poetry.org/) to manage your dependencies.
   ```pip install poetry```
3. Install dependencies.
   ```poetry install --no-root```

[tox](https://tox.readthedocs.io/en/latest/) runs all tests as its default target. Running *tox* by itself will run unit tests. Ensure you have a running redis, with the module loaded.

**Contributing**

Prior to submitting a pull request, please ensure you've built and installed poetry as above. Then:

1. Run the linter.
   ```tox -e linters.```
2. Run the unit tests. This assumes you have a redis server running, with the [RedisAI module](https://redisai.io) already loaded.  If you don't, you may want to install a [docker build](https://hub.docker.com/r/redislabs/redisai/tags).
   ```tox -e tests```

`RedisAI example repo <https://github.com/RedisAI/redisai-examples>`_ shows few examples
made using redisai-py under `python_client` folder. Also, checkout
`ml2rt <https://github.com/hhsecond/ml2rt>`_ for convenient functions those might help in
converting models (sparkml, sklearn, xgboost to ONNX), serializing models to disk, loading
it back to redisai-py etc.

            

Raw data

            {
    "_id": null,
    "home_page": "",
    "name": "redisai",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.8,<=4.0.0",
    "maintainer_email": "",
    "keywords": "",
    "author": "Redis",
    "author_email": "oss@redis.com",
    "download_url": "https://files.pythonhosted.org/packages/40/01/bed3f5f19a6b321c8a0e9096e978d9ea93f3bf2c99cbab3ac2d7d5bb2403/redisai-1.3.0.tar.gz",
    "platform": null,
    "description": "==========\nredisai-py\n==========\n\n.. image:: https://img.shields.io/github/license/RedisAI/redisai-py.svg\n        :target: https://github.com/RedisAI/redisai-py\n\n.. image:: https://badge.fury.io/py/redisai.svg\n        :target: https://badge.fury.io/py/redisai\n\n.. image:: https://github.com/RedisAI/redisai-py/actions/workflows/integration.yml/badge.svg\n        :target: https://github.com/RedisAI/redisai-py/actions/workflows/integration.yml\n\n.. image:: https://img.shields.io/github/release/RedisAI/redisai-py.svg\n        :target: https://github.com/RedisAI/redisai-py/releases/latest\n\n.. image:: https://codecov.io/gh/RedisAI/redisai-py/branch/master/graph/badge.svg\n        :target: https://codecov.io/gh/RedisAI/redisai-py\n\n.. image:: https://readthedocs.org/projects/redisai-py/badge/?version=latest\n        :target: https://redisai-py.readthedocs.io/en/latest/?badge=latest\n\n.. image:: https://img.shields.io/badge/Forum-RedisAI-blue\n        :target: https://forum.redis.com/c/modules/redisai\n\n.. image:: https://img.shields.io/discord/697882427875393627?style=flat-square\n        :target: https://discord.gg/rTQm7UZ\n\n.. image:: https://snyk.io/test/github/RedisAI/redisai-py/badge.svg?targetFile=pyproject.toml\n        :target: https://snyk.io/test/github/RedisAI/redisai-py?targetFile=pyproject.toml\n\nredisai-py is the Python client for RedisAI. Checkout the\n`documentation <https://redisai-py.readthedocs.io/en/latest/>`_ for API details and examples\n\nInstallation\n------------\n\n1. Install Redis 5.0 or above\n2. Install `RedisAI <http://redisai.io>`_\n3. Install the Python client\n\n.. code-block:: bash\n\n    $ pip install redisai\n\n\n4. Install serialization-deserialization utility (optional)\n\n.. code-block:: bash\n\n    $ pip install ml2rt\n\nDevelopment\n-----------\n\n1. Assuming you have virtualenv installed, create a virtualenv to manage your python dependencies, and activate it.\n   ```virtualenv -v venv; source venv/bin/activate```\n2. Install [pypoetry](https://python-poetry.org/) to manage your dependencies.\n   ```pip install poetry```\n3. Install dependencies.\n   ```poetry install --no-root```\n\n[tox](https://tox.readthedocs.io/en/latest/) runs all tests as its default target. Running *tox* by itself will run unit tests. Ensure you have a running redis, with the module loaded.\n\n**Contributing**\n\nPrior to submitting a pull request, please ensure you've built and installed poetry as above. Then:\n\n1. Run the linter.\n   ```tox -e linters.```\n2. Run the unit tests. This assumes you have a redis server running, with the [RedisAI module](https://redisai.io) already loaded.  If you don't, you may want to install a [docker build](https://hub.docker.com/r/redislabs/redisai/tags).\n   ```tox -e tests```\n\n`RedisAI example repo <https://github.com/RedisAI/redisai-examples>`_ shows few examples\nmade using redisai-py under `python_client` folder. Also, checkout\n`ml2rt <https://github.com/hhsecond/ml2rt>`_ for convenient functions those might help in\nconverting models (sparkml, sklearn, xgboost to ONNX), serializing models to disk, loading\nit back to redisai-py etc.\n",
    "bugtrack_url": null,
    "license": "BSD-3-Clause",
    "summary": "RedisAI Python Client",
    "version": "1.3.0",
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "e6a98953236caad42a712776bd05314e8a741233a4208f0fe8db4f45b39fad9c",
                "md5": "66f6979b55384ffd63acdc4b92fbcaad",
                "sha256": "22424cbe54353f8fb42ea09c93afd2158733e7224128b95cb19e7ae920048616"
            },
            "downloads": -1,
            "filename": "redisai-1.3.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "66f6979b55384ffd63acdc4b92fbcaad",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.8,<=4.0.0",
            "size": 16799,
            "upload_time": "2023-02-05T15:21:05",
            "upload_time_iso_8601": "2023-02-05T15:21:05.897227Z",
            "url": "https://files.pythonhosted.org/packages/e6/a9/8953236caad42a712776bd05314e8a741233a4208f0fe8db4f45b39fad9c/redisai-1.3.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "4001bed3f5f19a6b321c8a0e9096e978d9ea93f3bf2c99cbab3ac2d7d5bb2403",
                "md5": "e4ad1e24940c6284acbbb966dbe83f87",
                "sha256": "8d9efa3ead4d45ab480d70d98562658b458c6fa28c570e748035540ea2e392a0"
            },
            "downloads": -1,
            "filename": "redisai-1.3.0.tar.gz",
            "has_sig": false,
            "md5_digest": "e4ad1e24940c6284acbbb966dbe83f87",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.8,<=4.0.0",
            "size": 15974,
            "upload_time": "2023-02-05T15:21:07",
            "upload_time_iso_8601": "2023-02-05T15:21:07.673382Z",
            "url": "https://files.pythonhosted.org/packages/40/01/bed3f5f19a6b321c8a0e9096e978d9ea93f3bf2c99cbab3ac2d7d5bb2403/redisai-1.3.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-02-05 15:21:07",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "lcname": "redisai"
}
        
Elapsed time: 0.05686s