flow-toolkit


Nameflow-toolkit JSON
Version 0.0.1 PyPI version JSON
download
home_pageNone
SummaryCLI toolkit for Flow language, and integration with python.
upload_time2024-06-21 13:42:23
maintainerNone
docs_urlNone
authorNone
requires_python>=3.10
licenseMIT License Copyright (c) [2024] [StealthyPanda] Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
keywords flow ml dl
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # Flow toolkit
---

A simple development toolkit for streamlining ML and DL workflows.

## Getting started

### Installation

The base compiler can be installed via `pip`:
```bash
pip install flow-toolkit
```

Next, install a plugin for your intended output. For example:

```bash
flow -i https://github.com/StealthyPanda/
```


Any github repository can be used as a valid flow plugin, as long as it contains a `plugin.py` in its root directory, and contains a `main` function.


### Quick Start

A simple flow for a dense neural network would be:

```
// example.fl

flow linear(x) [weights, biases] {
    return
        (weights @ x) + biases;
}

flow NeuralNetwork (x) {
    let linear l1;
    let linear l2;

    y = l1(x);
    y = l2(y);

    return y;
}

build NeuralNetwork simple {
    x => 784;
    output => 10;
}
```

Build the flow to a pytorch model with:
```bash
flow -f example.fl -o example
```





            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "flow-toolkit",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.10",
    "maintainer_email": null,
    "keywords": "flow, ML, DL",
    "author": null,
    "author_email": "StealthyPanda <shaikm259@gmail.com>",
    "download_url": "https://files.pythonhosted.org/packages/54/72/859d3a04a0c14e3489c1ab53c9a77e37492fafe6f3cb1244db8e74f2a33a/flow_toolkit-0.0.1.tar.gz",
    "platform": null,
    "description": "# Flow toolkit\r\n---\r\n\r\nA simple development toolkit for streamlining ML and DL workflows.\r\n\r\n## Getting started\r\n\r\n### Installation\r\n\r\nThe base compiler can be installed via `pip`:\r\n```bash\r\npip install flow-toolkit\r\n```\r\n\r\nNext, install a plugin for your intended output. For example:\r\n\r\n```bash\r\nflow -i https://github.com/StealthyPanda/\r\n```\r\n\r\n\r\nAny github repository can be used as a valid flow plugin, as long as it contains a `plugin.py` in its root directory, and contains a `main` function.\r\n\r\n\r\n### Quick Start\r\n\r\nA simple flow for a dense neural network would be:\r\n\r\n```\r\n// example.fl\r\n\r\nflow linear(x) [weights, biases] {\r\n    return\r\n        (weights @ x) + biases;\r\n}\r\n\r\nflow NeuralNetwork (x) {\r\n    let linear l1;\r\n    let linear l2;\r\n\r\n    y = l1(x);\r\n    y = l2(y);\r\n\r\n    return y;\r\n}\r\n\r\nbuild NeuralNetwork simple {\r\n    x => 784;\r\n    output => 10;\r\n}\r\n```\r\n\r\nBuild the flow to a pytorch model with:\r\n```bash\r\nflow -f example.fl -o example\r\n```\r\n\r\n\r\n\r\n\r\n",
    "bugtrack_url": null,
    "license": "MIT License  Copyright (c) [2024] [StealthyPanda]  Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:  The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.  THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.",
    "summary": "CLI toolkit for Flow language, and integration with python.",
    "version": "0.0.1",
    "project_urls": null,
    "split_keywords": [
        "flow",
        " ml",
        " dl"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "209adc2660466094d404e869db06741f7c0ae72dde873291066b9fb75ceb9ec3",
                "md5": "0e510ae3f0f37bb7e9085fbd7616b584",
                "sha256": "e2003a5d23662987c739dcd3a5dfb75054adf39ab1e9680b01396c5c4ef6fe33"
            },
            "downloads": -1,
            "filename": "flow_toolkit-0.0.1-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "0e510ae3f0f37bb7e9085fbd7616b584",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.10",
            "size": 24554,
            "upload_time": "2024-06-21T13:42:22",
            "upload_time_iso_8601": "2024-06-21T13:42:22.547873Z",
            "url": "https://files.pythonhosted.org/packages/20/9a/dc2660466094d404e869db06741f7c0ae72dde873291066b9fb75ceb9ec3/flow_toolkit-0.0.1-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "5472859d3a04a0c14e3489c1ab53c9a77e37492fafe6f3cb1244db8e74f2a33a",
                "md5": "8dae433e121862fb82cb3630b76fad00",
                "sha256": "43e7ccc3dae866ad1f3b304cc325a4dd110fdf517aba7a55531f99a6f7f489fc"
            },
            "downloads": -1,
            "filename": "flow_toolkit-0.0.1.tar.gz",
            "has_sig": false,
            "md5_digest": "8dae433e121862fb82cb3630b76fad00",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.10",
            "size": 22022,
            "upload_time": "2024-06-21T13:42:23",
            "upload_time_iso_8601": "2024-06-21T13:42:23.698696Z",
            "url": "https://files.pythonhosted.org/packages/54/72/859d3a04a0c14e3489c1ab53c9a77e37492fafe6f3cb1244db8e74f2a33a/flow_toolkit-0.0.1.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-06-21 13:42:23",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "lcname": "flow-toolkit"
}
        
Elapsed time: 0.23929s