flake8_tensors
==============
[](https://pypi.org/project/flake8_tensors/)
[](https://github.com/dvolgyes/flake8_tensors/raw/master/LICENSE.txt)
flake8 plugin which recommends some tricks for machine learning codes.
## Installation
The plugin requires python3.8+.
Install the stable version:
`pip install flake8_tensors --upgrade`
Or with pipx:
`pipx install flake8`
`pipx inject flake8 flake8_tensors`
## Usage
After the code is installed, call flake8 on your project.
The plugin emits warning messages with "WT" prefix, e.g. WT100.
The messages meant to refer my opinionated best practices, or cool projects,
like [einops](https://github.com/arogozhnikov/einops), [opt_einsum](https://github.com/dgasmith/opt_einsum),
[Adabelief](https://juntang-zhuang.github.io/adabelief/), etc.
If you don't understand a warning, open a ticket, and i will clarify it.
If you have suggestions, let me know. And of course, if you find
a false positive, share the problematic snippet.
(False positives are absolutely possible, actually, quite easy to make one.
But assuming reasonable developer practices, like not calling your variable
as "BatchNorm3d", the false positive rate should be low.)
Raw data
{
"_id": null,
"home_page": "https://github.com/dvolgyes/flake8_tensors",
"name": "flake8-tensors",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0.0,>=3.8.1",
"maintainer_email": null,
"keywords": "flake8, deep learning, pytorch, numpy",
"author": "David V\u00f6lgyes",
"author_email": "david.volgyes@ieee.org",
"download_url": "https://files.pythonhosted.org/packages/20/8b/a4239416533f4e77d6bba90bc53cad16c9725ae19ecf9d793711bbd05dd2/flake8_tensors-1.2.0.tar.gz",
"platform": null,
"description": "flake8_tensors\n==============\n\n[](https://pypi.org/project/flake8_tensors/)\n[](https://github.com/dvolgyes/flake8_tensors/raw/master/LICENSE.txt)\n\nflake8 plugin which recommends some tricks for machine learning codes.\n\n## Installation\n\nThe plugin requires python3.8+.\n\nInstall the stable version:\n`pip install flake8_tensors --upgrade`\n\nOr with pipx:\n`pipx install flake8`\n`pipx inject flake8 flake8_tensors`\n\n## Usage\n\nAfter the code is installed, call flake8 on your project.\nThe plugin emits warning messages with \"WT\" prefix, e.g. WT100.\n\nThe messages meant to refer my opinionated best practices, or cool projects,\nlike [einops](https://github.com/arogozhnikov/einops), [opt_einsum](https://github.com/dgasmith/opt_einsum),\n[Adabelief](https://juntang-zhuang.github.io/adabelief/), etc.\n\nIf you don't understand a warning, open a ticket, and i will clarify it.\nIf you have suggestions, let me know. And of course, if you find\na false positive, share the problematic snippet.\n(False positives are absolutely possible, actually, quite easy to make one.\nBut assuming reasonable developer practices, like not calling your variable\nas \"BatchNorm3d\", the false positive rate should be low.)\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "flake8_tensors - flake8 plugin for deep learning codes",
"version": "1.2.0",
"project_urls": {
"Homepage": "https://github.com/dvolgyes/flake8_tensors",
"Repository": "https://github.com/dvolgyes/flake8_tensors"
},
"split_keywords": [
"flake8",
" deep learning",
" pytorch",
" numpy"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "0d651254dcf06470dc349703dced05515370df8e904c77e79802dcfe21aebc23",
"md5": "9298359cc22f9a58e6598e5f68b56e16",
"sha256": "bb371617bf648723f6c77079186d50a46e40bbcb6ae657f9d0c07bf018917968"
},
"downloads": -1,
"filename": "flake8_tensors-1.2.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "9298359cc22f9a58e6598e5f68b56e16",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0.0,>=3.8.1",
"size": 6896,
"upload_time": "2024-12-01T21:37:04",
"upload_time_iso_8601": "2024-12-01T21:37:04.532149Z",
"url": "https://files.pythonhosted.org/packages/0d/65/1254dcf06470dc349703dced05515370df8e904c77e79802dcfe21aebc23/flake8_tensors-1.2.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "208ba4239416533f4e77d6bba90bc53cad16c9725ae19ecf9d793711bbd05dd2",
"md5": "cfbc56575441cd3ba710314c615ff5ec",
"sha256": "38a73df77359c07a2f6b0ec46820dda20a94451369ad12b0e02221d5b8b1c00e"
},
"downloads": -1,
"filename": "flake8_tensors-1.2.0.tar.gz",
"has_sig": false,
"md5_digest": "cfbc56575441cd3ba710314c615ff5ec",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0.0,>=3.8.1",
"size": 5656,
"upload_time": "2024-12-01T21:37:05",
"upload_time_iso_8601": "2024-12-01T21:37:05.579200Z",
"url": "https://files.pythonhosted.org/packages/20/8b/a4239416533f4e77d6bba90bc53cad16c9725ae19ecf9d793711bbd05dd2/flake8_tensors-1.2.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-12-01 21:37:05",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "dvolgyes",
"github_project": "flake8_tensors",
"travis_ci": true,
"coveralls": false,
"github_actions": false,
"appveyor": true,
"tox": true,
"lcname": "flake8-tensors"
}
JSON
