docs: mark ipc wrapper as deprecated (#378)

Signed-off-by: Keming <[email protected]>

Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "mosec"
-version = "0.6.7"
+version = "0.7.0"
 authors = ["Keming <[email protected]>", "Zichen <[email protected]>"]
 edition = "2021"
 license = "Apache-2.0"

docs/source/examples/ipc.md

@@ -4,7 +4,7 @@ This is an example demonstrating how you can enable the plasma shared memory sto
 
 Mosec's multi-stage pipeline requires the output data from the previous stage to be transferred to the next stage across python processes. This is coordinated via Unix domain socket between every Python worker process from all stages and the Rust controller process.
 
-By default, we serialize the data and directly transfer the bytes over the socket. However, users may find wrapping this IPC useful or more efficient for specific use cases. Therefore, we provide an example implementation `PlasmaShmIPCMixin` based on [`pyarrow.plasma`](https://arrow.apache.org/docs/11.0/python/plasma.html) and `RedisShmIPCMixin` based on [`redis`](https://pypi.org/project/redis). We recommand using `RedisShmWrapper` for better performance and longer-lasting updates.
+By default, we serialize the data and directly transfer the bytes over the socket. However, users may find wrapping this IPC useful or more efficient for specific use cases. Therefore, we provide an example implementation `PlasmaShmIPCMixin` based on [`pyarrow.plasma`](https://arrow.apache.org/docs/11.0/python/plasma.html) and `RedisShmIPCMixin` based on [`redis`](https://pypi.org/project/redis). We recommend using `RedisShmWrapper` for better performance and longer-lasting updates.
 
 ```{warning}
 `plasma` is deprecated. Please use Redis instead.

license.json

@@ -19,7 +19,7 @@
   },
   {
     "name": "axum",
-    "version": "0.6.17",
+    "version": "0.6.18",
     "authors": null,
     "repository": "https://github.com/tokio-rs/axum",
     "license": "MIT",
@@ -55,7 +55,7 @@
   },
   {
     "name": "mosec",
-    "version": "0.6.6",
+    "version": "0.7.0",
     "authors": "Keming <[email protected]>|Zichen <[email protected]>",
     "repository": "https://github.com/mosecorg/mosec",
     "license": "Apache-2.0",
@@ -64,7 +64,7 @@
   },
   {
     "name": "once_cell",
-    "version": "1.17.1",
+    "version": "1.17.2",
     "authors": "Aleksey Kladov <[email protected]>",
     "repository": "https://github.com/matklad/once_cell",
     "license": "Apache-2.0 OR MIT",
@@ -73,7 +73,7 @@
   },
   {
     "name": "prometheus-client",
-    "version": "0.20.0",
+    "version": "0.21.1",
     "authors": "Max Inden <[email protected]>",
     "repository": "https://github.com/prometheus/client_rust",
     "license": "Apache-2.0 OR MIT",
@@ -82,7 +82,7 @@
   },
   {
     "name": "tokio",
-    "version": "1.28.0",
+    "version": "1.28.2",
     "authors": "Tokio Contributors <[email protected]>",
     "repository": "https://github.com/tokio-rs/tokio",
     "license": "MIT",

mosec/ipc.py

@@ -15,6 +15,11 @@
 """Wrapper layer for IPC between workers.
 
 This will be called before sending data or after receiving data through the Protocol.
+
+
+.. warning::
+    This implementation is deprecated. Please use
+    :py:mod:`PlasmaShmIPCMixin <mosec.mixin.PlasmaShmIPCMixin>`
 """
 
 import abc

mosec/plugins/plasma_shm.py

@@ -59,6 +59,10 @@ def __init__(self, shm_path: str) -> None:
         Args:
             shm_path (str): path of the plasma server.
         """
+        warnings.warn(
+            "PlasmaShmWrapper is deprecated, please use RedisShmIPCMixin.",
+            DeprecationWarning,
+        )
         self.client = plasma.connect(shm_path)
 
     def _put_plasma(self, data: List[bytes]) -> List[plasma.ObjectID]:

mosec/server.py

@@ -18,25 +18,18 @@
 model serving.
 
 Dynamic Batching
-================
+----------------
 
     The user may enable the dynamic batching feature for any stage when the
     corresponding worker is appended, by setting the
     :py:meth:`append_worker(max_batch_size) <Server.append_worker>`.
 
 Multiprocess
-============
+------------
 
     The user may spawn multiple processes for any stage when the
     corresponding worker is appended, by setting the
     :py:meth:`append_worker(num) <Server.append_worker>`.
-
-IPC Wrapper
-===========
-
-    The user may wrap the inter-process communication to use shared memory,
-    e.g. pyarrow plasma, by providing the :py:mod:`IPC Wrapper <mosec.ipc.IPCWrapper>`
-    for the server.
 """
 
 import multiprocessing as mp
@@ -78,7 +71,7 @@ def __init__(
         """Initialize a MOSEC Server.
 
         Args:
-            ipc_wrapper: wrapper function (before and after) IPC
+            ipc_wrapper: (deprecated) wrapper function (before and after) IPC
             endpoint: path to route inference
         """
         self.ipc_wrapper = ipc_wrapper