xoscar 0.4.0__cp312-cp312-win_amd64.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,83 @@
+xoscar/__init__.py,sha256=dlwtB7dnDp5WME6CZVQY7d9lk1yJ9s___H5UxjGlAd4,1668
+xoscar/_utils.cp312-win_amd64.pyd,sha256=2kxLAVJ246mrUsVhU36FWzRZXyooxOtTJ75sKWxJkxo,114688
+xoscar/_utils.pxd,sha256=rlNbTg5lhXA-jCOLksqF4jhUlNn0xw2jx1HxdLa34pc,1193
+xoscar/_utils.pyx,sha256=5Wvind3AQ3JaMK7Zv9SjhiPO6LEol2hW7_fMncn69go,7300
+xoscar/_version.py,sha256=bsfCVAo_o9LkiP3AjPsP4SRRqhjuS0t4D1WGJPzbdls,24412
+xoscar/api.py,sha256=B5oXv4vgMxMteh1YNaBmNFDrUFmYa_dCdzfaWwwZnCo,13820
+xoscar/backend.py,sha256=8G5JwjoOT6Q2slb11eXNApxgcmvNQUCdQzkoIMDwLcQ,1917
+xoscar/batch.py,sha256=Jk5BSpvMFAV9DrRy0a9tgPvIo_dt8cbJReZBL0cnOPc,8128
+xoscar/constants.py,sha256=H9ntCahBz5nKO-A6rkrGKy4WB2kNaLZAytkDajKIXqM,780
+xoscar/context.cp312-win_amd64.pyd,sha256=lGfqxf2_x_v-ymWwAlVHipPGKeR2QKgeuXFs9frhmls,159232
+xoscar/context.pxd,sha256=6n6IAbmArSRq8EjcsbS6npW8xP1jI0qOoS1fF0oyj-o,746
+xoscar/context.pyx,sha256=FOJVerGOvxe2USryXEQA0rpaFX_ScxISH6QWKUcahY8,11310
+xoscar/core.cp312-win_amd64.pyd,sha256=fRLOesDn5KEUA185G24TLrUetGIfyv2MfneMbQ5cTik,329728
+xoscar/core.pxd,sha256=dGv62H92PFG98SVILuF641kY-NWFEt1FYqqOX3WY5RQ,1330
+xoscar/core.pyx,sha256=0YvJW2AHgymyfsAlPGvIFw65J5gTKO3PK2p1wl4VlJ0,22388
+xoscar/debug.py,sha256=hrmxIH6zvTKasQo6PUUgXu5mgEsR0g87Fvpw7CoHipg,5257
+xoscar/driver.py,sha256=EjZ7HkdSgwtE9pXGiJXXwgWfxaIn10eZyqKpBhelaoc,1414
+xoscar/errors.py,sha256=hfIAlYuSVfB3dAQYr8hTLAMmfy5en6Y8mihdtw1gTEE,1304
+xoscar/libcpp.pxd,sha256=XGy887HXdRsvF47s-A7PvHX6Gaf15d_azRscWJY0Hc8,1178
+xoscar/nvutils.py,sha256=z6RCVs0sgKFm55TTgAYG3qy5f_AKJzjcH2kcRB-wTJQ,21129
+xoscar/profiling.py,sha256=LUqkj6sSxaFj0ltS7Yk2kFsh5ieHY417xypTYHwQOb4,8275
+xoscar/utils.py,sha256=kLY5cp3tHM9CaEzFG82v7f8XepxC3YZXAUCg5o1uRJ0,16968
+xoscar/aio/__init__.py,sha256=ZLJlVJJH5EhItKD6tLTBri-4FV4kT1O2qdIfBC-df98,691
+xoscar/aio/base.py,sha256=ytknTCjTjNQbTM7l7QGXqPYYUkD7qq-zVBGVZ34L1Tc,2335
+xoscar/aio/file.py,sha256=x1wrvDgtTFMv-6gjSPpBU26jAO5uEAlXGGnFtx7uevQ,1545
+xoscar/aio/lru.py,sha256=KyUfrmqQ2ZkU07Reih-VvUKP1VOg1jmwprEAcZ8pdNE,6539
+xoscar/aio/parallelism.py,sha256=egpScbxggXzAdc_evLsNmUyHafuxu62JWAYS-2ISSuI,1332
+xoscar/backends/__init__.py,sha256=g9OllTquu9MRB5nySVoyiRv2z-_OSALWrOhwt7L9WXc,657
+xoscar/backends/allocate_strategy.py,sha256=DzvTlixwzTANURI2mDLHm3vcaugSPDxU6UQZb89KH0U,5005
+xoscar/backends/config.py,sha256=7nmvU_19zYR7n-bT8BNasbjntwmobmMiM7wN7O6Lujc,5129
+xoscar/backends/context.py,sha256=NukXzBwq9ZwuiN1y6RE1hfNGsW589hDtJAVwu-DV9E0,15874
+xoscar/backends/core.py,sha256=bVQxM1E4qMq1-SkfrZM1aolNg1WQv2sHcZxWI1ETyMM,7625
+xoscar/backends/message.cp312-win_amd64.pyd,sha256=TieEuIz34VImQb14kM_rSD3KU1bUGcBZMVShrrDZuUg,267776
+xoscar/backends/message.pyi,sha256=JMe3_gwmBCBVJPA2TpxY0ygLyYpTsizHE9-C8syjyIM,6351
+xoscar/backends/message.pyx,sha256=23j-fjxOVONPWY0-C5sfCOMbZCx4PTxN0GU8YfrLNeg,18529
+xoscar/backends/pool.py,sha256=DpOwcqXsAy-SJUbHKxsVrwRIzp3VSIqyy2uvM2Kt34A,61017
+xoscar/backends/router.py,sha256=GJpSV_LhzINHdTp5jtsMHfPNMkNb1KI-WlqGqhwApGU,7953
+xoscar/backends/communication/__init__.py,sha256=Z0_RJkPGwLJeapSNt-TiO9DvnpBPu8P4PCooLaAqjkk,1080
+xoscar/backends/communication/base.py,sha256=wmWTeE4lcB_ohqyJJ6MdzMGcrOqy2RSKRp8y-NDuFdY,7736
+xoscar/backends/communication/core.py,sha256=ZM_fU0yokoPzXcJ6j-89llp2r7J9pl3gE5iImn4b4bE,2199
+xoscar/backends/communication/dummy.py,sha256=apbkfFdVWqeqc8Cc1LInOw6ikVoFWixTwBN__djxgBY,8040
+xoscar/backends/communication/errors.py,sha256=-O6ZaKs6Gz7g_ZnKU2wrz8D9btowqaYuQ9u0zCYSLWo,743
+xoscar/backends/communication/socket.py,sha256=FAEU9wu-_VcSw0jBCtyBZ83XB5-Jg0qAyMUrf0zxZl4,13803
+xoscar/backends/communication/ucx.py,sha256=defQN2sirsu-KqvXox_I_wzAfWSq5LJkjKdzo0vtPgw,20234
+xoscar/backends/communication/utils.py,sha256=F-muF5_ow9JzAPAZ3d8XaGDiz3bRZOdWmWBDwQOVLe0,3761
+xoscar/backends/indigen/__init__.py,sha256=Khr2aGbaIw_04NIdY7QNhdljCKbmmzLb4NeAOM3LF8M,701
+xoscar/backends/indigen/backend.py,sha256=cCMkZDEKuRQlFb6v79JvWi5lfzsvAafznOeEWlw7CWY,1663
+xoscar/backends/indigen/driver.py,sha256=uLPBAxG7q8ds6yc-baeYUWu_m4K1gST3_BPqkfnlarw,978
+xoscar/backends/indigen/pool.py,sha256=8pk-FSO007Al2Qb6Ndqc8cMtG-F40tgoaDt095GGfYM,17321
+xoscar/backends/test/__init__.py,sha256=xgE4hbD3g46G1GDJEeozaXIk57XaahmFMNQsnRzRcrs,698
+xoscar/backends/test/backend.py,sha256=Q4C6TFQzZogjugGmPh3QZw4IigL8VGCFOJ5fKkE1Uvk,1301
+xoscar/backends/test/pool.py,sha256=Eg_P--ErTwd2EowpZZg9BMhAG9UBOfXEHVhEId3OqPw,7465
+xoscar/collective/__init__.py,sha256=3tTgFXALDbAwmEDtmBX7PN7N6ZrcPFC4evMXMIhBtsg,801
+xoscar/collective/common.py,sha256=9c7xq3IOUvfA0I9GnpalUqXZOzmF6IEILv4zL64BYVE,3663
+xoscar/collective/core.py,sha256=191aPxbUgWpjzrqyozndImDAQhZFmqoQdBkHFLDfXN0,24239
+xoscar/collective/process_group.py,sha256=kTPbrLMJSGhqbiWvTIiz-X3W0rZWd_CFn_zUIlXbOlM,23286
+xoscar/collective/utils.py,sha256=p3WEVtXvnVhkuO5mRgQBhBRFr1dKHcDKMjrbMyuiyfg,1219
+xoscar/collective/uv.dll,sha256=dax0ooxDvwjULfWekNHOCAXudXNt_J45FIbuZTSgoqc,620544
+xoscar/collective/xoscar_pygloo.cp312-win_amd64.pyd,sha256=TFlQMjPxFgffrmXiDh81jGPxwoSQfc6cnQsCZ3Y-bsc,831488
+xoscar/collective/xoscar_pygloo.pyi,sha256=6KRzElgNBBKWh-VivUw1b5Dolp17MgwA91hQo33EysU,7616
+xoscar/metrics/__init__.py,sha256=RjXuuYw4I2YYgD8UY2Z5yCZk0Z56xMJ1n40O80Dtxf8,726
+xoscar/metrics/api.py,sha256=dtJ4QrIqQNXhJedeqOPs4TXKgrRGZFFN50xAd9SCfec,9144
+xoscar/metrics/backends/__init__.py,sha256=ZHepfhCDRuK9yz4pAM7bjpWDvS3Ijp1YgyynoUFLeuU,594
+xoscar/metrics/backends/metric.py,sha256=WdQMtp_x4qasJ3_HLUDaZnoCwYca0mX2QfVrOwHpuDI,4595
+xoscar/metrics/backends/console/__init__.py,sha256=ZHepfhCDRuK9yz4pAM7bjpWDvS3Ijp1YgyynoUFLeuU,594
+xoscar/metrics/backends/console/console_metric.py,sha256=o6uGA65Kp3yvkMSGKrIilD2MAXKih-of1yEnOfE206I,2164
+xoscar/metrics/backends/prometheus/__init__.py,sha256=ZHepfhCDRuK9yz4pAM7bjpWDvS3Ijp1YgyynoUFLeuU,594
+xoscar/metrics/backends/prometheus/prometheus_metric.py,sha256=65hb8O3tmsEJ7jgOrIwl_suj9SE5Tmqcfjuk0urkLvE,2120
+xoscar/serialization/__init__.py,sha256=NOAn046vnHEkx--82BKNinV8EpyOfT5hqfRBGnKl56s,866
+xoscar/serialization/aio.py,sha256=bL31B2lwrEKA5nztRSeSgDyqsbBN6dCMr6rHwNDGAIk,4715
+xoscar/serialization/core.cp312-win_amd64.pyd,sha256=FQZbH-9dL0vYh6p_1RgbqnJdOhedFu14AzIC2-GMEN4,292352
+xoscar/serialization/core.pxd,sha256=X-47bqBM2Kzw5SkLqICdKD0gU6CpmLsBxC3kfW--wVk,1013
+xoscar/serialization/core.pyi,sha256=Zof9373qy2lmjenSuMznEiTSCNW6WQB7rmSXrRbjUo0,1931
+xoscar/serialization/core.pyx,sha256=ZKexLRnRwZXXn2045kR7xfM_szcoPNrDuouQCWtpFp8,30570
+xoscar/serialization/cuda.py,sha256=Fj4Cpr_YmkGceUCo0mQn8fRvmHP_5WcLdRx6epZ3RC0,3869
+xoscar/serialization/exception.py,sha256=t6yZn_Ate04UE1RbabNh7mu739sdtwarjuPXWhASx7c,1682
+xoscar/serialization/numpy.py,sha256=C6WVx-Sdl2OHBAvVY34DFjAKXlekMbpc2ni6bR8wxYo,3001
+xoscar/serialization/pyfury.py,sha256=3ucal29Hr7PX9_1SfB2x43FE2xw_C0rLkVv3foL7qwM,1200
+xoscar/serialization/scipy.py,sha256=9ph-yoRoNiwUZTwQrn35U60VPirWlncXNAg6EXvqMR4,2554
+xoscar-0.4.0.dist-info/METADATA,sha256=4q4G5TFvvYLHA9zH_ZTmgwu-7DwtRbiXsllkbuu-UPA,9265
+xoscar-0.4.0.dist-info/WHEEL,sha256=bkFTgQblV2VuwaX_c6St1wl4KjbN5AW_if3TQfQ0fhI,101
+xoscar-0.4.0.dist-info/top_level.txt,sha256=vYlqqY4Nys8Thm1hePIuUv8eQePdULVWMmt7lXtX_ZA,21
+xoscar-0.4.0.dist-info/RECORD,,

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-win_amd64
+

xoscar-0.4.0.dist-info/top_level.txt

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