| Name | nerdd-link JSON |
| Version |
0.4.0
JSON |
| download |
| home_page | None |
| Summary | Run a NERDD module as a service |
| upload_time | 2024-11-19 00:44:50 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | None |
| license | MIT License Copyright (c) 2023 Molecular Informatics Vienna 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 |
science
research
development
nerdd
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# NERDD-Link
Run a [NERDD module](https://github.com/molinfo-vienna/nerdd-module) as a
service that consumes input molecules and produces prediction tuples.
## Installation
```bash
pip install -U nerdd-link
```
## Usage
When a class inherits from ```nerdd_module.AbstractModel``` (see
[NERDD Module Github page](https://github.com/molinfo-vienna/nerdd-module)), it can be
used to create a Kafka service.
```bash
# run a Kafka service for NerddModel on localhost:9092
run_nerdd_server package.path.to.NerddModel
# modify broker url, input topic and batch size
run_nerdd_server package.path.to.NerddModel \
--broker-url my-cluster-kafka-bootstrap.kafka:9092 \
--input-topic examples \
--batch-size 10
# more information via --help
run_nerdd_server --help
```
If the model class is called ```ExamplePredictionModel```, the server will read input
tuples from the input topic ```example-prediction-inputs``` in batches of size 100
and write results to the ```results``` topic. The batch size specifies the number
of input tuples that are given to the model at once.
## Communication
Raw data
{
"_id": null,
"home_page": null,
"name": "nerdd-link",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": "Steffen Hirte <steffen.hirte@univie.ac.at>",
"keywords": "science, research, development, nerdd",
"author": null,
"author_email": "Steffen Hirte <steffen.hirte@univie.ac.at>",
"download_url": "https://files.pythonhosted.org/packages/f9/32/37001ce5986f905a6f889c491bc7e870993224490318b8dc5d0bf912710a/nerdd_link-0.4.0.tar.gz",
"platform": null,
"description": "# NERDD-Link\n\nRun a [NERDD module](https://github.com/molinfo-vienna/nerdd-module) as a \nservice that consumes input molecules and produces prediction tuples.\n\n\n## Installation\n\n```bash\npip install -U nerdd-link\n```\n \n## Usage\n\nWhen a class inherits from ```nerdd_module.AbstractModel``` (see \n[NERDD Module Github page](https://github.com/molinfo-vienna/nerdd-module)), it can be \nused to create a Kafka service. \n\n```bash \n# run a Kafka service for NerddModel on localhost:9092\nrun_nerdd_server package.path.to.NerddModel\n\n# modify broker url, input topic and batch size\nrun_nerdd_server package.path.to.NerddModel \\\n --broker-url my-cluster-kafka-bootstrap.kafka:9092 \\\n --input-topic examples \\\n --batch-size 10\n\n# more information via --help\nrun_nerdd_server --help\n```\n\nIf the model class is called ```ExamplePredictionModel```, the server will read input \ntuples from the input topic ```example-prediction-inputs``` in batches of size 100\nand write results to the ```results``` topic. The batch size specifies the number\nof input tuples that are given to the model at once.\n\n## Communication\n\n",
"bugtrack_url": null,
"license": "MIT License Copyright (c) 2023 Molecular Informatics Vienna 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": "Run a NERDD module as a service",
"version": "0.4.0",
"project_urls": {
"Repository": "https://github.com/molinfo-vienna/nerdd-link"
},
"split_keywords": [
"science",
" research",
" development",
" nerdd"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "971a6e6d6f445294ec2ab0b3db6dcbab63120008d4ceb39c001f822d5ec7ee9e",
"md5": "cc2b96decf3f2f013d8ff84b6ea77e9d",
"sha256": "adf6d7617cd7d89d3a1cb7de3fdb9b7dbf5185daa71843705afd1108f7cb6897"
},
"downloads": -1,
"filename": "nerdd_link-0.4.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "cc2b96decf3f2f013d8ff84b6ea77e9d",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 19865,
"upload_time": "2024-11-19T00:44:48",
"upload_time_iso_8601": "2024-11-19T00:44:48.723192Z",
"url": "https://files.pythonhosted.org/packages/97/1a/6e6d6f445294ec2ab0b3db6dcbab63120008d4ceb39c001f822d5ec7ee9e/nerdd_link-0.4.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "f93237001ce5986f905a6f889c491bc7e870993224490318b8dc5d0bf912710a",
"md5": "3437dac7c863772ca12d0f80349bd3c7",
"sha256": "32b75d6532ddfb3fb25bf4e0114217c286c93c157de651a8b7a36655ad4ca465"
},
"downloads": -1,
"filename": "nerdd_link-0.4.0.tar.gz",
"has_sig": false,
"md5_digest": "3437dac7c863772ca12d0f80349bd3c7",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 16964,
"upload_time": "2024-11-19T00:44:50",
"upload_time_iso_8601": "2024-11-19T00:44:50.746693Z",
"url": "https://files.pythonhosted.org/packages/f9/32/37001ce5986f905a6f889c491bc7e870993224490318b8dc5d0bf912710a/nerdd_link-0.4.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-19 00:44:50",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "molinfo-vienna",
"github_project": "nerdd-link",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "nerdd-link"
}
