xoscar 0.4.0__cp312-cp312-macosx_10_9_universal2.whl

xoscar-0.4.0.dist-info/METADATA

@@ -0,0 +1,223 @@
+Metadata-Version: 2.1
+Name: xoscar
+Version: 0.4.0
+Summary: Python actor framework for heterogeneous computing.
+Home-page: http://github.com/xorbitsai/xoscar
+Author: Qin Xuye
+Author-email: qinxuye@xprobe.io
+Maintainer: Qin Xuye
+Maintainer-email: qinxuye@xprobe.io
+License: Apache License 2.0
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: Implementation :: CPython
+Classifier: Topic :: Software Development :: Libraries
+Description-Content-Type: text/markdown
+Requires-Dist: numpy>=1.14.0
+Requires-Dist: pandas>=1.0.0
+Requires-Dist: cloudpickle>=1.5.0
+Requires-Dist: psutil>=5.9.0
+Requires-Dist: tblib>=1.7.0
+Requires-Dist: packaging
+Requires-Dist: uvloop>=0.14.0; sys_platform != "win32"
+Requires-Dist: scipy>=1.0.0; sys_platform != "win32" or python_version >= "3.10"
+Requires-Dist: scipy<=1.9.1,>=1.0.0; sys_platform == "win32" and python_version < "3.10"
+Provides-Extra: dev
+Requires-Dist: cython>=0.29; extra == "dev"
+Requires-Dist: pytest>=3.5.0; extra == "dev"
+Requires-Dist: pytest-cov>=2.5.0; extra == "dev"
+Requires-Dist: pytest-timeout>=1.2.0; extra == "dev"
+Requires-Dist: pytest-forked>=1.0; extra == "dev"
+Requires-Dist: pytest-asyncio>=0.14.0; extra == "dev"
+Requires-Dist: ipython>=6.5.0; extra == "dev"
+Requires-Dist: sphinx; extra == "dev"
+Requires-Dist: pydata-sphinx-theme>=0.3.0; extra == "dev"
+Requires-Dist: sphinx-intl>=0.9.9; extra == "dev"
+Requires-Dist: flake8>=3.8.0; extra == "dev"
+Requires-Dist: black; extra == "dev"
+Provides-Extra: doc
+Requires-Dist: ipython>=6.5.0; extra == "doc"
+Requires-Dist: sphinx; extra == "doc"
+Requires-Dist: pydata-sphinx-theme>=0.3.0; extra == "doc"
+Requires-Dist: sphinx-intl>=0.9.9; extra == "doc"
+Provides-Extra: extra
+Requires-Dist: pyarrow>=5.0.0; extra == "extra"
+Provides-Extra: kubernetes
+Requires-Dist: kubernetes>=10.0.0; extra == "kubernetes"
+Provides-Extra: ray
+Requires-Dist: xoscar-ray>=0.0.1; extra == "ray"
+
+<div align="center">
+  <img width="77%" alt="" src="https://raw.githubusercontent.com/xprobe-inc/xoscar/main/doc/source/_static/Xoscar.svg"><br>
+</div>
+
+# Python actor framework for heterogeneous computing.
+[![PyPI Latest Release](https://img.shields.io/pypi/v/xoscar.svg?style=for-the-badge)](https://pypi.org/project/xoscar/)
+[![Coverage](https://img.shields.io/codecov/c/github/xorbitsai/xoscar?style=for-the-badge)](https://codecov.io/gh/xorbitsai/xoscar)
+[![Build Status](https://img.shields.io/github/actions/workflow/status/xorbitsai/xoscar/python.yaml?branch=main&style=for-the-badge&label=GITHUB%20ACTIONS&logo=github)](https://actions-badge.atrox.dev/xorbitsai/xoscar/goto?ref=main)
+[![License](https://img.shields.io/pypi/l/xoscar.svg?style=for-the-badge)](https://github.com/xorbitsai/xoscar/blob/main/LICENSE)
+
+## What is actor
+Writing parallel and distributed programs is often challenging and requires a lot of time to deal with concurrency
+issues. Actor model provides a high-level, scalable and robust abstraction for building distributed applications. 
+It provides several benefits:
+- Scalability: Actors easily scale across nodes. The asynchronous, non-blocking nature of actors allows them to handle huge volumes of concurrent tasks efficiently.
+- Concurrency: The actor model abstracts over concurrency, allowing developers to avoid raw threads and locks.
+- Modularity: An actor system decomposes naturally into a collection of actors that can be understood independently. Actor logic is encapsulated within the actor itself.
+
+## Why Xoscar
+Xoscar implements the actor model in Python and provides user-friendly APIs that offer significant benefits for building 
+applications on heterogeneous hardware:
+- **Abstraction over low-level communication details**: Xoscar handles all communication between actors transparently,
+whether on CPUs, GPUs, or across nodes. Developers focus on application logic rather than managing hardware resources 
+and optimizing data transfer.
+- **Flexible actor models**: Xoscar supports both stateful and stateless actors. Stateful actors ensure thread safety for 
+concurrent systems while stateless actors can handle massive volumes of concurrent messages. Developers choose the 
+appropriate actor model for their needs.
+- **Batch method**: Xoscar provides a batch interface to significantly improve call efficiency when an actor interface is 
+invoked a large number of times.
+- **Advanced debugging support**: Xoscar can detect potential issues like deadlocks, long-running calls, and performance
+bottlenecks that would otherwise be nearly impossible to troubleshoot in a heterogeneous environment.
+- **Automated recovery**: If an actor fails for any reason, Xoscar will automatically restart it if you want. It can monitor 
+actors and restart them upon failure, enabling fault-tolerant systems.
+
+## Overview
+![architecture.png](doc/source/_static/architecture.png)
+Xoscar allows you to create multiple actor pools on each worker node, typically binding an actor pool to a CPU core or 
+a GPU card. Xoscar provides allocation policies so that whenever an actor is created, it will be instantiated in the
+appropriate pool based on the specified policy.
+
+When actors communicate, Xoscar will choose the optimal communication mechanism based on which pools the actors 
+belong to. This allows Xoscar to optimize communication in heterogeneous environments with multiple processing 
+units and accelerators.
+
+## Where to get it
+
+### PyPI
+Binary installers for the latest released version are available at the [Python
+Package Index (PyPI)](https://pypi.org/project/xoscar).
+
+```shell
+# PyPI
+pip install xoscar
+```
+
+### Build from source
+The source code is currently hosted on GitHub at: https://github.com/xorbitsai/xoscar .
+
+Building from source requires that you have cmake and gcc installed on your system.
+
+- cmake >= 3.11
+- gcc >= 8
+
+```shell
+# If you have never cloned xoscar before
+git clone --recursive https://github.com/xorbitsai/xoscar.git
+cd xoscar/python
+pip install -e .
+
+# If you have already cloned xoscar before
+cd xoscar
+git submodule init
+git submodule update
+cd python && pip install -e .
+```
+
+## APIs
+Here are basic APIs for Xoscar.
+#### Define an actor
+```python
+import xoscar as xo
+
+# stateful actor, for stateless actor, inherit from xo.StatelessActor
+class MyActor(xo.Actor):
+    def __init__(self, *args, **kwargs):
+        pass
+
+    async def __post_create__(self):
+        # called after created
+        pass
+
+    async def __pre_destroy__(self):
+        # called before destroy
+        pass
+
+    def method_a(self, arg_1, arg_2, **kw_1):  # user-defined function
+        pass
+
+    async def method_b(self, arg_1, arg_2, **kw_1):  # user-defined async function
+        pass
+```
+
+#### Create an actor
+```python
+import xoscar as xo
+
+actor_ref = await xo.create_actor(
+    MyActor, 1, 2, a=1, b=2,
+    address='<ip>:<port>', uid='UniqueActorName')
+```
+
+#### Get an actor reference
+```python
+import xoscar as xo
+
+actor_ref = await xo.actor_ref(address, actor_id)
+```
+
+#### Invoke a method
+```python
+# send
+await actor_ref.method_a.send(1, 2, a=1, b=2)
+# equivalent to actor_ref.method_a.send
+await actor_ref.method_a(1, 2, a=1, b=2)
+# tell, it sends a message asynchronously and does not wait for a response.
+await actor_ref.method_a.tell(1, 2, a=1, b=2)
+```
+### Batch method
+Xoscar provides a set of APIs to write batch methods. You can simply add a `@extensible` decorator to your actor method
+and create a batch version. All calls wrapped in a batch will be sent together, reducing possible RPC cost.
+#### Define a batch method
+```python
+import xoscar as xo
+
+class ExampleActor(xo.Actor):
+    @xo.extensible
+    async def batch_method(self, a, b=None):
+        pass
+```
+Xoscar also supports creating a batch version of the method:
+```python
+class ExampleActor(xo.Actor):
+    @xo.extensible
+    async def batch_method(self, a, b=None):
+        raise NotImplementedError  # this will redirect all requests to the batch version
+
+    @batch_method.batch
+    async def batch_method(self, args_list, kwargs_list):
+        results = []
+        for args, kwargs in zip(args_list, kwargs_list):
+            a, b = self.batch_method.bind(*args, **kwargs)
+            # process the request
+            results.append(result)
+        return results  # return a list of results
+```
+In a batch method, users can define how to more efficiently process a batch of requests.
+
+#### Invoke a batch method
+Calling batch methods is easy. You can use `<method_name>.delay` to make a batched call and use `<method_name>.batch` to send them:
+```python
+ref = await xo.actor_ref(uid='ExampleActor', address='127.0.0.1:13425')
+results = await ref.batch_method.batch(
+    ref.batch_method.delay(10, b=20),
+    ref.batch_method.delay(20),
+)
+```
+
+## License
+[Apache 2](LICENSE)

xoscar-0.4.0.dist-info/RECORD

@@ -0,0 +1,82 @@
+xoscar-0.4.0.dist-info/RECORD,,
+xoscar-0.4.0.dist-info/WHEEL,sha256=568ptz5j2bwL99nQYci4U3-KMfBlUpekfgY5tOLXYW8,114
+xoscar-0.4.0.dist-info/top_level.txt,sha256=vYlqqY4Nys8Thm1hePIuUv8eQePdULVWMmt7lXtX_ZA,21
+xoscar-0.4.0.dist-info/METADATA,sha256=xfdfy3u6wkQ-IEUMahgHm_ZjZWpKu-VQkoBojz7E8eU,9042
+xoscar/_utils.pyx,sha256=UR1FtYXAYKIdEWR9HulEpMbSOrkQWi6xGz63d4IQmG0,7059
+xoscar/backend.py,sha256=is436OPkZfSpQXaoqTRVta5eoye_pp45RFgCstAk2hU,1850
+xoscar/core.pxd,sha256=4lBq8J0kjcXcsGuvN7Kv4xcL5liHwTTFWlqyK7XAEnw,1280
+xoscar/_version.py,sha256=ClSPrUjgGRGHIkVMQV9XQnkQ-n0akJMnq_rh819nqFE,23719
+xoscar/context.pxd,sha256=qKa0OyDPZtVymftSh447m-RzFZgmz8rGqQBa7qlauvc,725
+xoscar/batch.py,sha256=DpArS0L3WYJ_HVPG-6hSYEwoAFY1mY2-mlC4Jp5M_Dw,7872
+xoscar/nvutils.py,sha256=qmW4mKLU0WB2yCs198ccQOgLL02zB7Fsa-AotO3NOmg,20412
+xoscar/constants.py,sha256=Yn59lRIOvE1VFwyuZB5G2-gxYIyhIZ1rVovbdFAR2NM,759
+xoscar/core.cpython-312-darwin.so,sha256=VSWbEk9PY564Is8U6LfFcuvLuYRZGtHphpm5US7JSV0,932560
+xoscar/__init__.py,sha256=0zX8kKaio3ZIrlzB79WybcravMJw1OxPWjDspTgJFyQ,1608
+xoscar/context.cpython-312-darwin.so,sha256=LKkdn2DiAKapUeDaSua5NrmZ706puxlIvB8p3_-7bgA,455856
+xoscar/api.py,sha256=3hztPoOxg8A_mlhWyWgVP7FMXG0PATA1TP4Rbaj7A-g,13327
+xoscar/utils.py,sha256=vAgTMpEyzBNKT4u05-ii9wg_5-7Iq5c8TthyMpz6M_M,16451
+xoscar/debug.py,sha256=9Z8SgE2WaKYQcyDo-5-DxEJQ533v7kWjrvCd28pSx3E,5069
+xoscar/libcpp.pxd,sha256=DJqBxLFOKL4iRr9Kale5UH3rbvPRD1x5bTSOPHFpz9I,1147
+xoscar/context.pyx,sha256=8CdgPnWcE9eOp3N600WgDQ03MCi8P73eUOGcfV7Zksg,10942
+xoscar/errors.py,sha256=wBlQOKsXf0Fc4skN39tDie0YZT-VIAuLNRgoDl2pZcA,1241
+xoscar/_utils.cpython-312-darwin.so,sha256=kWs_BdCiBkVm6uwEHD9QZU9tsckxgaJJsC3yMHL7wlM,347312
+xoscar/core.pyx,sha256=Aqc2i8Fetsd5wRAPF4kL0ddnBZn3E2HRNCvup79BbQc,21730
+xoscar/driver.py,sha256=498fowtJr6b3FE8FIOA_Tc1Vwx88nfZw7p0FxrML0h4,1372
+xoscar/profiling.py,sha256=BC5OF0HzSaXv8V7w-y-B8r5gV5DgxHFoTEIF6jCMioQ,8015
+xoscar/_utils.pxd,sha256=5KYAL3jfPdejsHnrGGT2s--ZUX5SXznQWpHVSno429k,1157
+xoscar/metrics/__init__.py,sha256=9Badi7rxYikGm2dQiNCrj9GgMRBxwuR3JaEKcFZmfak,705
+xoscar/metrics/api.py,sha256=BBlMIFvVAGVfrtpeJ1YlH9Tqhy9OzGavwvGyeHcQ0Tk,8856
+xoscar/metrics/backends/__init__.py,sha256=h_JgzSqV5lP6vQ6XX_17kE4IY4BRnvKta_7VLQAL1ms,581
+xoscar/metrics/backends/metric.py,sha256=aPhyc8JgH22L3rcHP8IjsmgrhSODjg6B5TZVnre97y8,4446
+xoscar/metrics/backends/prometheus/__init__.py,sha256=h_JgzSqV5lP6vQ6XX_17kE4IY4BRnvKta_7VLQAL1ms,581
+xoscar/metrics/backends/prometheus/prometheus_metric.py,sha256=MxoMvVrg0pOkKpkjJ0PcAuEaaEJR2FZljmPrLjQ1-oc,2050
+xoscar/metrics/backends/console/console_metric.py,sha256=y5CCtH33j3AqI5_Uhwi4mgOcAhyhb4cWv_YvR6fxcbQ,2082
+xoscar/metrics/backends/console/__init__.py,sha256=h_JgzSqV5lP6vQ6XX_17kE4IY4BRnvKta_7VLQAL1ms,581
+xoscar/collective/__init__.py,sha256=XsClIkO_3Jd8GDifYuAbZCmJLAo9ZqGvnjUn9iuogmU,774
+xoscar/collective/core.py,sha256=NVR-7Iaq3aDPCN6fgXcq9Ew6uFEszRwxYqmUG9FLcws,23502
+xoscar/collective/common.py,sha256=INAnISbfnRicbbbDHTqbSr9ITb89ZphH5BUkSpEdXXU,3561
+xoscar/collective/utils.py,sha256=3S4qF4JEnAUD3RiWVBUj-ZptL83CBSwGYyVZyIasAsE,1178
+xoscar/collective/xoscar_pygloo.cpython-312-darwin.so,sha256=kKSFHyKzHh_hA6OscrigvNKiVXfQl3hut2lLKPbyAaQ,2347600
+xoscar/collective/process_group.py,sha256=zy7LcIFnEcmrcxuECI89v0bQlUbSqQMkVyBw468WBnk,22599
+xoscar/collective/xoscar_pygloo.pyi,sha256=uM_jcyca3dpCZVQIdgj-KzMoXm-niL7mDu6HGS7kh1E,7377
+xoscar/serialization/exception.py,sha256=Jy8Lsk0z-VJyEUaWeuZIwkmxqaoB-nLKMa1D15Cl4js,1634
+xoscar/serialization/pyfury.py,sha256=sifOnVMYoS82PzZEkzkfxesmMHei23k5UAUUKUyoOYQ,1163
+xoscar/serialization/core.pxd,sha256=k4RoJgX5E5LGs4jdCQ7vvcn26MabXbrWoWhkO49X6YI,985
+xoscar/serialization/core.pyi,sha256=-pQARSj91rt3iU4ftWGFH6jYwsSKYCT_Ya7EJsaGEjg,1874
+xoscar/serialization/core.cpython-312-darwin.so,sha256=FMhsCFzUiSeIgTPTaMXlYoK45snFwmE007MtiaSgAKc,820976
+xoscar/serialization/__init__.py,sha256=5Y_C3cYbQJIZ09LRjeCf-jrkLma7mfN8I5bznHrdsbg,846
+xoscar/serialization/numpy.py,sha256=5Kem87CvpJmzUMp3QHk4WeHU30FoQWTJJP2SwIcaQG0,2919
+xoscar/serialization/cuda.py,sha256=iFUEnN4SiquBIhyieyOrfw3TnKnW-tU_vYgqOxO_DrA,3758
+xoscar/serialization/scipy.py,sha256=yOEi0NB8cqQ6e2UnCZ1w006RsB7T725tIL-DM_hNcsU,2482
+xoscar/serialization/aio.py,sha256=S9e3rHMBwqqKmJtDz7KzYAqWc8w9bttA0Dj83IBfEU0,4577
+xoscar/serialization/core.pyx,sha256=bjR-zXGm9qersk7kYPzpjpMIxDl_Auur4BCubRfKmfA,29626
+xoscar/backends/config.py,sha256=EG26f0GwX_f4dAhwTW77RBjiK9h8R_3JrD-rBF1bAq8,4984
+xoscar/backends/message.pyi,sha256=__2piPWLUQBmkDzx_nsHMOC2wHG53IKVGU_47zwgdKM,6112
+xoscar/backends/allocate_strategy.py,sha256=tC1Nbq2tJohahUwd-zoRYHEDX65wyuX8tmeY45uWj_w,4845
+xoscar/backends/__init__.py,sha256=VHEBQcUWM5bj027W8EUf9PiJUAP7JoMrRw3Tsvy5ySw,643
+xoscar/backends/core.py,sha256=aHb3mMZ9vJe6pxg0P8kSOKvjXF1IaqgOgyhKVhHpNLM,7432
+xoscar/backends/context.py,sha256=Vr_PibRxYCDQ_gYK7r-BOlw9TXw8VQbFsVTH7K7mHPk,15470
+xoscar/backends/router.py,sha256=mhSvM5KVfV882jricVcpyxAqHEvhS4zL6ivczC6fOTE,7746
+xoscar/backends/message.cpython-312-darwin.so,sha256=EpiSqBGnbJPqukQcWYXwPmwYGGqCelCdwb3H_m90S7Y,754848
+xoscar/backends/message.pyx,sha256=uyzilPc_7SqNwGUL4U-Zbfqku8bfZyRW_Lt_S3I_LEU,17930
+xoscar/backends/pool.py,sha256=itI9Ho6XjHjBY49-WPBu2absEUFOSCpQhgQ6OnUIm-4,59421
+xoscar/backends/indigen/backend.py,sha256=znl_fZzWGEtLH8hZ9j9Kkf0fva25jEem2_KO7I1RVvc,1612
+xoscar/backends/indigen/__init__.py,sha256=tKHP5ClzedBRBpZsLRVErR3EUNbbDm4CY4u0rCFJr44,685
+xoscar/backends/indigen/driver.py,sha256=VGzkacYKykegW5qhCuhx01gdgBZEKJjNIyfNCnA6Nm8,952
+xoscar/backends/indigen/pool.py,sha256=mWYkOP4VVoUsXFgfpwruPuWblF6Waan5vxit8B-9_oQ,16852
+xoscar/backends/test/backend.py,sha256=nv9WFhH5Bbq4Q1HB9yfpciZBaeHT4IQAtzugBWESrUY,1263
+xoscar/backends/test/__init__.py,sha256=j2ZfD6prD9WjUxRUDC7Eq5Z7N7TkL6fFr59oNyc_vY4,682
+xoscar/backends/test/pool.py,sha256=TW4X6J-92Pti66103poQBNDBznX6CBD3RLOc_zixjTo,7257
+xoscar/backends/communication/ucx.py,sha256=7GAKIzlbxy-NpaDE9VLPde90tKxeU8lVZH8c_3ByuZ0,19703
+xoscar/backends/communication/__init__.py,sha256=tB05BlK63iWQnfJgRzKt4mFKRtmWUki5hUGSZQwAotc,1050
+xoscar/backends/communication/core.py,sha256=sJeE3foRIqVPXldzYpFKHDSsabfAIFBU4JuXY4OyklY,2130
+xoscar/backends/communication/utils.py,sha256=AmovE-hmWLXNCPwHafYuaRjOk8m42BUyT3XBqfXQRVI,3664
+xoscar/backends/communication/errors.py,sha256=V3CdBe2xX9Rwv32f2dH2Msc84yaUhlyerZ42-739o1Q,723
+xoscar/backends/communication/socket.py,sha256=DXeYt8mFPnN5Cdg3BGFsmnJc0Ck4_OONveJwAGq44OM,13389
+xoscar/backends/communication/dummy.py,sha256=gaKPNiN4x2aGZV3IGaaa8eaweBVjRh8B19jU1B5t2yw,7798
+xoscar/backends/communication/base.py,sha256=0P4Tr35GSWpRp394e9jVWUUoKKa-gIk177eYPw1BnSU,7421
+xoscar/aio/__init__.py,sha256=kViDKR_kJe59VQViHITKEfBcIgN4ZJblUyd8zl0E3ZI,675
+xoscar/aio/file.py,sha256=PBtkLp-Q7XtYl-zk00s18TtgIrkNr60J3Itf66ctO1o,1486
+xoscar/aio/lru.py,sha256=rpXCqSLtPV5xnWtd6uDwQQFGgIPEgvmWEQDkPNUx9cM,6311
+xoscar/aio/parallelism.py,sha256=VSsjk8wP-Bw7tLeUsTyLVNgp91thjxEfE3pCrw_vF5Q,1293
+xoscar/aio/base.py,sha256=9j0f1piwfE5R5GIvV212vSD03ixdaeSzSSsO2kxJZVE,2249

xoscar-0.4.0.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (75.3.0)
+Root-Is-Purelib: false
+Tag: cp312-cp312-macosx_10_9_universal2
+

xoscar-0.4.0.dist-info/top_level.txt

@@ -0,0 +1,2 @@
+xoscar
+xoscar_pygloo