{
    "info": {
        "author": "Junjie Wu",
        "author_email": "wujj38@mail2.sysu.edu.cn",
        "bugtrack_url": null,
        "classifiers": [],
        "description": "# Politenessr\n\n## Intro\nPolitenessr is a package used to predict the value of politeness of texts.\n\nIt is based on a fine tuned BERT model.\n## Install \n\n### Use pip\nIf `pip` is installed, politenessr could be installed directly from it:\n\n    pip install politenessr\n\n### Dependencies\n\tpython>=3.6.0\n\ttorch>=0.4.1\n\tnumpy\n\tpandas\n\tunidecode\n\tpytorch-pretrained-bert\n\tpytorch-transformers\n\n\n\n## Usage and Example\n\n### Notes: During your first usage, the package will download a model file automatically, which is about 400MB.\n\n### `predict`\n`predict` is the core method of this package, \nwhich takes a single text of a list of texts, and returns a list of raw values in `[1,5]` (higher means more politeness, while lower means less).\n\n### Simplest usage\n\nYou may directly import `politenessr` and use the default predict method, e.g.:\n\n    >>> import politenessr\n    >>> politenessr.predict([\"I am totally agree with you\"])\n    [4.3568916]\n\n### Construct from class\nAlternatively, you may also construct the object from class, where you could customize the model path and device:\n\n\t>>> from politenessr import Politenessr\n\t>>> pr = Politenessr()\n\n\t# Predict a single text\n\t>>> pr.predict([\"I am totally agree with you\"])\n\t[3.5638056]\n\n\t# Predict a list of texts\n\t>>> preds = pr.predict(['I am totally agree with you','I hate you'])\n    >>> f\"Raw values are {preds}\"\n    [3.5638053 2.2007465]\n\n\n\nMore detail on how to construct the object is available in docstrings.\n\n### Model using multiprocessing when preprocessing a large dataset into BERT input features \nIf you want to use several cpu cores via multiprocessing while preprocessing a large dataset, you may construct the object via\n\n    >>> pr = Politenessr(CPU_COUNT=cpu_cpunt, CHUNKSIZE=chunksize)\n\nIf you want to faster the code through multi gpus, you may construct the object via\n\n    >>> pr = Politenessr(is_paralleled=True, BATCH_SIZE = batch_size)\n\n\n## Contact\nJunjie Wu (wujj38@mail2.sysu.edu.cn)\n\n\n",
        "description_content_type": "text/markdown",
        "docs_url": null,
        "download_url": "",
        "downloads": {
            "last_day": -1,
            "last_month": -1,
            "last_week": -1
        },
        "home_page": "",
        "keywords": "",
        "license": "",
        "maintainer": "",
        "maintainer_email": "",
        "name": "politenessr",
        "package_url": "https://pypi.org/project/politenessr/",
        "platform": "",
        "project_url": "https://pypi.org/project/politenessr/",
        "project_urls": null,
        "release_url": "https://pypi.org/project/politenessr/1.3/",
        "requires_dist": null,
        "requires_python": ">=3.6",
        "summary": "politenessr",
        "version": "1.3"
    },
    "last_serial": 5682427,
    "releases": {
        "1.0": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "1e9895cd5ec1dc2f27ee4e787a576b04",
                    "sha256": "3f749f121719f5780e77244fe36ee44533c920b4936d55a4b73beb450eae92d9"
                },
                "downloads": -1,
                "filename": "politenessr-1.0-py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "1e9895cd5ec1dc2f27ee4e787a576b04",
                "packagetype": "bdist_wheel",
                "python_version": "py3",
                "requires_python": ">=3.6",
                "size": 7988,
                "upload_time": "2019-08-14T20:13:47",
                "url": "https://files.pythonhosted.org/packages/e2/bd/2aa90418951b5879820d67539226263406fd7916f857cadee894ad2969d3/politenessr-1.0-py3-none-any.whl"
            },
            {
                "comment_text": "",
                "digests": {
                    "md5": "6cebf9b16a77e080f3ef181b93175613",
                    "sha256": "a7f766bc62ef7012845e74dec199ac5add20e1a83f5dba22977294456e6e5cb1"
                },
                "downloads": -1,
                "filename": "politenessr-1.0.tar.gz",
                "has_sig": false,
                "md5_digest": "6cebf9b16a77e080f3ef181b93175613",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": ">=3.6",
                "size": 6388,
                "upload_time": "2019-08-14T20:13:49",
                "url": "https://files.pythonhosted.org/packages/7a/21/a71112ee77114c004079ad8d62780577b7ef08942d9199aa0d27ad380c88/politenessr-1.0.tar.gz"
            }
        ],
        "1.1": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "30484af0d7afb0e3bcee74d32d165968",
                    "sha256": "4fd4ed17e6dbdea760c731c359a50d54c161740bd4bd7f14ad68e4ab10fe4a7b"
                },
                "downloads": -1,
                "filename": "politenessr-1.1-py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "30484af0d7afb0e3bcee74d32d165968",
                "packagetype": "bdist_wheel",
                "python_version": "py3",
                "requires_python": ">=3.6",
                "size": 7988,
                "upload_time": "2019-08-14T20:47:34",
                "url": "https://files.pythonhosted.org/packages/88/de/ce5b437ac7a1be964da783fc10f69d26cca935806b376a090ab9a1fe1103/politenessr-1.1-py3-none-any.whl"
            },
            {
                "comment_text": "",
                "digests": {
                    "md5": "39815d99cadfcc80151e6613a57343c2",
                    "sha256": "2b6324cd24c7bd529cc06b5ea1b1eb5aa3575c94180b6af8499408ed2f487505"
                },
                "downloads": -1,
                "filename": "politenessr-1.1.tar.gz",
                "has_sig": false,
                "md5_digest": "39815d99cadfcc80151e6613a57343c2",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": ">=3.6",
                "size": 6391,
                "upload_time": "2019-08-14T20:47:35",
                "url": "https://files.pythonhosted.org/packages/86/86/b585605413715369dd1664623882501425a5f508fc90d6968ebd223383b6/politenessr-1.1.tar.gz"
            }
        ],
        "1.2": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "91244fb4637ac924639cf24f95e08b84",
                    "sha256": "d37eb8ac16b3bb2ffbb6a89751f923048bb2c9d2e0b7e0ea811111d63525ab3f"
                },
                "downloads": -1,
                "filename": "politenessr-1.2-py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "91244fb4637ac924639cf24f95e08b84",
                "packagetype": "bdist_wheel",
                "python_version": "py3",
                "requires_python": ">=3.6",
                "size": 7987,
                "upload_time": "2019-08-14T22:10:19",
                "url": "https://files.pythonhosted.org/packages/c2/78/9edbb582935c1cf8381f2e6adfecc81e985946a4a5997eeaf462d29aeafa/politenessr-1.2-py3-none-any.whl"
            },
            {
                "comment_text": "",
                "digests": {
                    "md5": "aa2433c7b3917467cf20414833521627",
                    "sha256": "5cabe2c11f4c994734073a8aa05b7761deadc100ed6a4253675fc8a0282660b9"
                },
                "downloads": -1,
                "filename": "politenessr-1.2.tar.gz",
                "has_sig": false,
                "md5_digest": "aa2433c7b3917467cf20414833521627",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": ">=3.6",
                "size": 6397,
                "upload_time": "2019-08-14T22:10:21",
                "url": "https://files.pythonhosted.org/packages/b1/60/c7f82376a84a06bf2b59c56ccaa3b594ec97a91300ee3da79cdccb1a5fb6/politenessr-1.2.tar.gz"
            }
        ],
        "1.3": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "9917987639c3bc18607463982c3f5eeb",
                    "sha256": "79b4572ee7e8bd340dadf4c556fb69755b34ed2f9923d4a35a4606776328210e"
                },
                "downloads": -1,
                "filename": "politenessr-1.3-py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "9917987639c3bc18607463982c3f5eeb",
                "packagetype": "bdist_wheel",
                "python_version": "py3",
                "requires_python": ">=3.6",
                "size": 7987,
                "upload_time": "2019-08-15T14:13:46",
                "url": "https://files.pythonhosted.org/packages/5e/20/3f1cdb65d30e34d32bc48b9ead81bf564c67f890e26b25698c22524619d3/politenessr-1.3-py3-none-any.whl"
            },
            {
                "comment_text": "",
                "digests": {
                    "md5": "f33e704653e76a8676bd7aaa52da2419",
                    "sha256": "1f0ff4efa78ab66433f22f592a0aa01fa6dc068412ecd3d13cc2edd5b6846ace"
                },
                "downloads": -1,
                "filename": "politenessr-1.3.tar.gz",
                "has_sig": false,
                "md5_digest": "f33e704653e76a8676bd7aaa52da2419",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": ">=3.6",
                "size": 6394,
                "upload_time": "2019-08-15T14:13:47",
                "url": "https://files.pythonhosted.org/packages/20/c1/2aafedfb4af833412c2593e589bf7633481cfcceaaef553c50a275eb6ea0/politenessr-1.3.tar.gz"
            }
        ]
    },
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "md5": "9917987639c3bc18607463982c3f5eeb",
                "sha256": "79b4572ee7e8bd340dadf4c556fb69755b34ed2f9923d4a35a4606776328210e"
            },
            "downloads": -1,
            "filename": "politenessr-1.3-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "9917987639c3bc18607463982c3f5eeb",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.6",
            "size": 7987,
            "upload_time": "2019-08-15T14:13:46",
            "url": "https://files.pythonhosted.org/packages/5e/20/3f1cdb65d30e34d32bc48b9ead81bf564c67f890e26b25698c22524619d3/politenessr-1.3-py3-none-any.whl"
        },
        {
            "comment_text": "",
            "digests": {
                "md5": "f33e704653e76a8676bd7aaa52da2419",
                "sha256": "1f0ff4efa78ab66433f22f592a0aa01fa6dc068412ecd3d13cc2edd5b6846ace"
            },
            "downloads": -1,
            "filename": "politenessr-1.3.tar.gz",
            "has_sig": false,
            "md5_digest": "f33e704653e76a8676bd7aaa52da2419",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.6",
            "size": 6394,
            "upload_time": "2019-08-15T14:13:47",
            "url": "https://files.pythonhosted.org/packages/20/c1/2aafedfb4af833412c2593e589bf7633481cfcceaaef553c50a275eb6ea0/politenessr-1.3.tar.gz"
        }
    ]
}