pintel 0.3.0.dev0__tar.gz

pintel-0.3.0.dev0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021 Astariul
+
+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.

pintel-0.3.0.dev0/PKG-INFO

@@ -0,0 +1,230 @@
+Metadata-Version: 2.4
+Name: pintel
+Version: 0.3.0.dev0
+Summary: Scale your ML workers asynchronously across processes and machines
+Home-page: https://github.com/astariul/pintel
+Author: Nicolas REMOND
+Author-email: remondnicola@gmail.com
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: pyzmq<27.0,>=22.3
+Requires-Dist: msgpack~=1.0
+Requires-Dist: loguru~=0.6
+Provides-Extra: test
+Requires-Dist: pytest~=8.0; extra == "test"
+Requires-Dist: pytest-asyncio~=0.18; extra == "test"
+Requires-Dist: pytest-cov~=3.0; extra == "test"
+Requires-Dist: coverage-badge~=1.0; extra == "test"
+Provides-Extra: hook
+Requires-Dist: pre-commit~=4.0; extra == "hook"
+Provides-Extra: lint
+Requires-Dist: isort~=5.9; extra == "lint"
+Requires-Dist: black~=24.1; extra == "lint"
+Requires-Dist: flake518~=1.2; extra == "lint"
+Requires-Dist: darglint~=1.8; extra == "lint"
+Provides-Extra: docs
+Requires-Dist: mkdocs-material~=9.0; extra == "docs"
+Requires-Dist: mkdocstrings[python]~=0.18; extra == "docs"
+Requires-Dist: mike~=2.0; extra == "docs"
+Provides-Extra: ex
+Requires-Dist: fastapi~=0.75; extra == "ex"
+Requires-Dist: uvicorn~=0.17; extra == "ex"
+Requires-Dist: requests~=2.27; extra == "ex"
+Requires-Dist: transformers~=4.17; extra == "ex"
+Provides-Extra: all
+Requires-Dist: pytest~=8.0; extra == "all"
+Requires-Dist: pytest-asyncio~=0.18; extra == "all"
+Requires-Dist: pytest-cov~=3.0; extra == "all"
+Requires-Dist: coverage-badge~=1.0; extra == "all"
+Requires-Dist: pre-commit~=4.0; extra == "all"
+Requires-Dist: isort~=5.9; extra == "all"
+Requires-Dist: black~=24.1; extra == "all"
+Requires-Dist: flake518~=1.2; extra == "all"
+Requires-Dist: darglint~=1.8; extra == "all"
+Requires-Dist: mkdocs-material~=9.0; extra == "all"
+Requires-Dist: mkdocstrings[python]~=0.18; extra == "all"
+Requires-Dist: mike~=2.0; extra == "all"
+Requires-Dist: fastapi~=0.75; extra == "all"
+Requires-Dist: uvicorn~=0.17; extra == "all"
+Requires-Dist: requests~=2.27; extra == "all"
+Requires-Dist: transformers~=4.17; extra == "all"
+Provides-Extra: dev
+Requires-Dist: pytest~=8.0; extra == "dev"
+Requires-Dist: pytest-asyncio~=0.18; extra == "dev"
+Requires-Dist: pytest-cov~=3.0; extra == "dev"
+Requires-Dist: coverage-badge~=1.0; extra == "dev"
+Requires-Dist: pre-commit~=4.0; extra == "dev"
+Requires-Dist: isort~=5.9; extra == "dev"
+Requires-Dist: black~=24.1; extra == "dev"
+Requires-Dist: flake518~=1.2; extra == "dev"
+Requires-Dist: darglint~=1.8; extra == "dev"
+Requires-Dist: mkdocs-material~=9.0; extra == "dev"
+Requires-Dist: mkdocstrings[python]~=0.18; extra == "dev"
+Requires-Dist: mike~=2.0; extra == "dev"
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: license-file
+Dynamic: provides-extra
+Dynamic: requires-dist
+Dynamic: requires-python
+Dynamic: summary
+
+<h1 align="center">pintel</h1>
+<p align="center">
+Scale your ML workers asynchronously across processes and machines
+</p>
+
+<p align="center">
+    <a href="https://github.com/astariul/pintel/releases"><img src="https://img.shields.io/github/release/astariul/pintel.svg" alt="GitHub release" /></a>
+    <a href="https://github.com/astariul/pintel/actions/workflows/pytest.yaml"><img src="https://github.com/astariul/pintel/actions/workflows/pytest.yaml/badge.svg" alt="Test status" /></a>
+    <a href="https://github.com/astariul/pintel/actions/workflows/lint.yaml"><img src="https://github.com/astariul/pintel/actions/workflows/lint.yaml/badge.svg" alt="Lint status" /></a>
+    <img src=".github/badges/coverage.svg" alt="Coverage status" />
+    <a href="https://astariul.github.io/pintel"><img src="https://img.shields.io/website?down_message=failing&label=docs&up_color=green&up_message=passing&url=https%3A%2F%2Fastariul.github.io%2Fpintel" alt="Docs" /></a>
+    <a href="https://github.com/astariul/pintel/blob/main/LICENSE"><img src="https://img.shields.io/badge/License-MIT-yellow.svg" alt="licence" /></a>
+</p>
+
+<p align="center">
+  <a href="#description">Description</a> •
+  <a href="#install">Install</a> •
+  <a href="#usage">Usage</a> •
+  <a href="#faq">FAQ</a> •
+  <a href="#contribute">Contribute</a>
+  <br>
+  <a href="https://astariul.github.io/pintel/" target="_blank">Documentation</a>
+</p>
+
+
+<h2 align="center">Description</h2>
+
+**`pintel`** is a python package that helps you scale your ML workers (or any python code) across processes and machines, asynchronously.
+
+`pintel` is :
+
+* ⚡️ Highly performant
+* 🔀 Asynchronous
+* 🐥 Easy-to-use
+
+
+<h2 align="center">Install</h2>
+
+Install `pintel` by running :
+
+
+```
+pip install pintel
+```
+
+
+<h2 align="center">Usage</h2>
+
+After defining your awesome model :
+
+```python
+import time
+
+class MyAwesomeModel:
+    def __init__(self, wait_time=0.25):
+        super().__init__()
+        self.w = wait_time
+
+    def __call__(self, x):
+        time.sleep(self.w)
+        return x**2
+```
+
+You can simply start a few workers serving the model :
+
+```python
+from pintel import Worker
+
+for _ in range(4):
+    Worker(MyAwesomeModel).start()
+```
+
+And send requests through the Hub :
+
+```python
+from pintel import Hub
+
+hub = Hub()
+
+# In an async function
+await hub.request(34)
+```
+
+And that's it !
+
+---
+
+Make sure to check the [documentation](https://astariul.github.io/pintel/usage/) for a more detailed explanation.
+
+Or you can run some examples from the `examples/` folder.
+
+
+<h2 align="center">FAQ</h2>
+
+#### ❓ **How `pintel` works ?**
+
+`pintel` simply run your model code in separate processes, and send requests to the right process to ensure requests are treated in parallel.
+
+`pintel` uses a modified form of [the Paranoid Pirate Pattern from the zmq guide](https://zguide.zeromq.org/docs/chapter4/#Robust-Reliable-Queuing-Paranoid-Pirate-Pattern).
+
+#### ❓ **Why the name "pintel" ?**
+
+Pintel is one of the pirates of Captain Barbossa's crew on the Black Pearl.  
+Since we are using the Paranoid Pirate Pattern, we needed a pirate name !
+
+<h2 align="center">Contribute</h2>
+
+To contribute, install the package locally, create your own branch, add your code (and tests, and documentation), and open a PR !
+
+### Pre-commit hooks
+
+Pre-commit hooks are set to check the code added whenever you commit something.
+
+If you never ran the hooks before, install it with :
+
+```bash
+pre-commit install
+```
+
+---
+
+Then you can just try to commit your code. If you code does not meet the quality required by linters, it will not be committed. You can just fix your code and try to commit again !
+
+---
+
+You can manually run the pre-commit hooks with :
+
+```bash
+pre-commit run --all-files
+```
+
+### Tests
+
+When you contribute, you need to make sure all the unit-tests pass. You should also add tests if necessary !
+
+You can run the tests with :
+
+```bash
+pytest
+```
+
+---
+
+Pre-commit hooks will not run the tests, but it will automatically update the coverage badge !
+
+### Documentation
+
+The documentation should be kept up-to-date. You can visualize the documentation locally by running :
+
+```bash
+mkdocs serve
+```

pintel-0.3.0.dev0/README.md

@@ -0,0 +1,152 @@
+<h1 align="center">pintel</h1>
+<p align="center">
+Scale your ML workers asynchronously across processes and machines
+</p>
+
+<p align="center">
+    <a href="https://github.com/astariul/pintel/releases"><img src="https://img.shields.io/github/release/astariul/pintel.svg" alt="GitHub release" /></a>
+    <a href="https://github.com/astariul/pintel/actions/workflows/pytest.yaml"><img src="https://github.com/astariul/pintel/actions/workflows/pytest.yaml/badge.svg" alt="Test status" /></a>
+    <a href="https://github.com/astariul/pintel/actions/workflows/lint.yaml"><img src="https://github.com/astariul/pintel/actions/workflows/lint.yaml/badge.svg" alt="Lint status" /></a>
+    <img src=".github/badges/coverage.svg" alt="Coverage status" />
+    <a href="https://astariul.github.io/pintel"><img src="https://img.shields.io/website?down_message=failing&label=docs&up_color=green&up_message=passing&url=https%3A%2F%2Fastariul.github.io%2Fpintel" alt="Docs" /></a>
+    <a href="https://github.com/astariul/pintel/blob/main/LICENSE"><img src="https://img.shields.io/badge/License-MIT-yellow.svg" alt="licence" /></a>
+</p>
+
+<p align="center">
+  <a href="#description">Description</a> •
+  <a href="#install">Install</a> •
+  <a href="#usage">Usage</a> •
+  <a href="#faq">FAQ</a> •
+  <a href="#contribute">Contribute</a>
+  <br>
+  <a href="https://astariul.github.io/pintel/" target="_blank">Documentation</a>
+</p>
+
+
+<h2 align="center">Description</h2>
+
+**`pintel`** is a python package that helps you scale your ML workers (or any python code) across processes and machines, asynchronously.
+
+`pintel` is :
+
+* ⚡️ Highly performant
+* 🔀 Asynchronous
+* 🐥 Easy-to-use
+
+
+<h2 align="center">Install</h2>
+
+Install `pintel` by running :
+
+
+```
+pip install pintel
+```
+
+
+<h2 align="center">Usage</h2>
+
+After defining your awesome model :
+
+```python
+import time
+
+class MyAwesomeModel:
+    def __init__(self, wait_time=0.25):
+        super().__init__()
+        self.w = wait_time
+
+    def __call__(self, x):
+        time.sleep(self.w)
+        return x**2
+```
+
+You can simply start a few workers serving the model :
+
+```python
+from pintel import Worker
+
+for _ in range(4):
+    Worker(MyAwesomeModel).start()
+```
+
+And send requests through the Hub :
+
+```python
+from pintel import Hub
+
+hub = Hub()
+
+# In an async function
+await hub.request(34)
+```
+
+And that's it !
+
+---
+
+Make sure to check the [documentation](https://astariul.github.io/pintel/usage/) for a more detailed explanation.
+
+Or you can run some examples from the `examples/` folder.
+
+
+<h2 align="center">FAQ</h2>
+
+#### ❓ **How `pintel` works ?**
+
+`pintel` simply run your model code in separate processes, and send requests to the right process to ensure requests are treated in parallel.
+
+`pintel` uses a modified form of [the Paranoid Pirate Pattern from the zmq guide](https://zguide.zeromq.org/docs/chapter4/#Robust-Reliable-Queuing-Paranoid-Pirate-Pattern).
+
+#### ❓ **Why the name "pintel" ?**
+
+Pintel is one of the pirates of Captain Barbossa's crew on the Black Pearl.  
+Since we are using the Paranoid Pirate Pattern, we needed a pirate name !
+
+<h2 align="center">Contribute</h2>
+
+To contribute, install the package locally, create your own branch, add your code (and tests, and documentation), and open a PR !
+
+### Pre-commit hooks
+
+Pre-commit hooks are set to check the code added whenever you commit something.
+
+If you never ran the hooks before, install it with :
+
+```bash
+pre-commit install
+```
+
+---
+
+Then you can just try to commit your code. If you code does not meet the quality required by linters, it will not be committed. You can just fix your code and try to commit again !
+
+---
+
+You can manually run the pre-commit hooks with :
+
+```bash
+pre-commit run --all-files
+```
+
+### Tests
+
+When you contribute, you need to make sure all the unit-tests pass. You should also add tests if necessary !
+
+You can run the tests with :
+
+```bash
+pytest
+```
+
+---
+
+Pre-commit hooks will not run the tests, but it will automatically update the coverage badge !
+
+### Documentation
+
+The documentation should be kept up-to-date. You can visualize the documentation locally by running :
+
+```bash
+mkdocs serve
+```

pintel-0.3.0.dev0/pintel/__init__.py

@@ -0,0 +1,7 @@
+from loguru import logger
+
+from .hub import Hub, UserCodeException
+from .worker import Worker
+
+
+logger.disable("pintel")