zhangyiss/mlx
1
0
Fork 0
mirror of https://github.com/ml-explore/mlx.git synced 2025-10-19 00:04:41 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity

Ring docs (#1829)

Browse Source
This commit is contained in:
Angelos Katharopoulos
2025-02-28 11:34:21 -08:00
committed by GitHub
parent 607181644f
commit 5d68082881
6 changed files with 378 additions and 74 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
python/src/distributed.cpp
View File

@@ -68,19 +68,21 @@ void init_distributed(nb::module_& parent_module) {
Example:
import mlx.core as mx
.. code:: python
group = mx.distributed.init(backend="ring")
import mlx.core as mx
group = mx.distributed.init(backend="ring")
Args:
strict (bool, optional): If set to False it returns a singleton group
in case ``mx.distributed.is_available()`` returns False otherwise
it throws a runtime error. Default: ``False``
backend (str, optional): Select a specific distributed backend to
initialize. If set to ``any`` then try all available backends and
return the first one that succeeds. Subsequent calls will return
the first backend that was initialized. Default: ``any``
backend (str, optional): Which distributed backend to initialize.
Possible values ``mpi``, ``ring``, ``any``. If set to ``any`` all
available backends are tried and the first one that succeeds
becomes the global group which will be returned in subsequent
calls. Default: ``any``
Returns:
Group: The group representing all the launched processes.