Skip to content

Commit

Permalink
[docs] Polish community integrations docs (#10780)
Browse files Browse the repository at this point in the history
  • Loading branch information
ericl authored Sep 14, 2020
1 parent 017737b commit daabe6b
Show file tree
Hide file tree
Showing 18 changed files with 109 additions and 58 deletions.
12 changes: 10 additions & 2 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -15,10 +15,19 @@ Ray is packaged with the following libraries for accelerating machine learning w
- `RaySGD <https://docs.ray.io/en/latest/raysgd/raysgd.html>`__: Distributed Training Wrappers
- `Ray Serve`_: Scalable and Programmable Serving

There are also many `community integrations <https://docs.ray.io/en/master/oss-users.html>`_ with Ray, including `Dask`_, `MARS`_, `Modin`_, `Horovod`_, `Hugging Face`_, `Scikit-learn`_, and others. Check out the `full list of Ray distributed libraries here <https://docs.ray.io/en/master/oss-users.html>`_.

Install Ray with: ``pip install ray``. For nightly wheels, see the
`Installation page <https://docs.ray.io/en/latest/installation.html>`__.

**NOTE:** As of Ray 0.8.1, Python 2 is no longer supported.
.. _`Modin`: https://github.com/modin-project/modin
.. _`Hugging Face`: https://huggingface.co/transformers/main_classes/trainer.html#transformers.Trainer.hyperparameter_search
.. _`MARS`: mars-on-ray.html
.. _`Dask`: dask-on-ray.html
.. _`Horovod`: https://horovod.readthedocs.io/en/stable/ray_include.html
.. _`Scikit-learn`: joblib.html



Quick Start
-----------
Expand Down Expand Up @@ -254,7 +263,6 @@ This example runs serves a scikit-learn gradient boosting classifier.
.. _`Ray Serve`: https://docs.ray.io/en/latest/serve/index.html


More Information
----------------

Expand Down
1 change: 1 addition & 0 deletions doc/requirements-rtd.txt
Original file line number Diff line number Diff line change
Expand Up @@ -8,3 +8,4 @@ commonmark==0.8.1
recommonmark==0.5.0
sphinx<2
readthedocs-sphinx-ext<1.1
sphinx-book-theme
Binary file added doc/source/images/classyvision.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added doc/source/images/dask.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added doc/source/images/flambe.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added doc/source/images/horovod.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added doc/source/images/hugging.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added doc/source/images/mars.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added doc/source/images/modin.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added doc/source/images/pycaret.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added doc/source/images/seldon.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added doc/source/images/spacy.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added doc/source/images/zoo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
5 changes: 2 additions & 3 deletions doc/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -195,7 +195,6 @@ Papers
ray-overview/index.rst
installation.rst
oss-users.rst
.. toctree::
:hidden:
Expand Down Expand Up @@ -276,14 +275,14 @@ Papers
.. toctree::
:hidden:
:maxdepth: -1
:caption: Community Libraries
:caption: More Libraries
multiprocessing.rst
joblib.rst
iter.rst
pandas_on_ray.rst
dask-on-ray.rst
mars-on-ray.rst
oss-users.rst
.. toctree::
:hidden:
Expand Down
2 changes: 2 additions & 0 deletions doc/source/multiprocessing.rst
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
.. _ray-multiprocessing:

Distributed multiprocessing.Pool
================================

Expand Down
131 changes: 90 additions & 41 deletions doc/source/oss-users.rst
Original file line number Diff line number Diff line change
@@ -1,79 +1,128 @@
.. _ray-oss-list:

Community libraries that integrate with Ray
===========================================
Community Integrations
======================

This page lists libraries that integrate with Ray for distributed execution. If you'd like to add your project to this list, feel free to file a pull request or open an issue on GitHub.
This page lists libraries that have integrations with Ray for distributed execution. If you'd like to add your project to this list, feel free to file a pull request or open an issue on GitHub.

ClassyVision |classyvision|
---------------------------

Horovod
-------
Classy Vision is a new end-to-end, PyTorch-based framework for large-scale training of state-of-the-art image and video classification models. The library features a modular, flexible design that allows anyone to train machine learning models on top of PyTorch using very simple abstractions.

Horovod is a distributed deep learning training framework for TensorFlow, Keras, PyTorch, and Apache MXNet. The goal of Horovod is to make distributed deep learning fast and easy to use.

[`Link to integration <https://horovod.readthedocs.io/en/stable/ray_include.html>`__]
[`Link to integration <https://classyvision.ai/tutorials/ray_aws>`__]

MARS
----
Dask |dask|
-----------

Mars is a tensor-based unified framework for large-scale data computation which scales Numpy, Pandas and Scikit-learn.
Dask provides advanced parallelism for analytics, enabling performance at scale for the tools you love. Dask uses existing Python APIs and data structures to make it easy to switch between Numpy, Pandas, Scikit-learn to their Dask-powered equivalents.

[:ref:`Link to integration <mars-on-ray>`]
[`Link to integration <dask-on-ray>`__]

Spacy
-----
spaCy is a library for advanced Natural Language Processing in Python and Cython. It's built on the very latest research, and was designed from day one to be used in real products.
Flambe |flambe|
---------------

[`Link to integration <https://pypi.org/project/spacy-ray/>`__]
Flambé is a machine learning experimentation framework built to accelerate the entire research life cycle. Flambé’s main objective is to provide a unified interface for prototyping models, running experiments containing complex pipelines, monitoring those experiments in real-time, reporting results, and deploying a final model for inference.

Github: `https://github.com/asappresearch/flambe <https://github.com/asappresearch/flambe>`_

Hugging Face Transformers
-------------------------
MARS |mars|
-----------

State-of-the-art Natural Language Processing for Pytorch and TensorFlow 2.0.
Mars is a tensor-based unified framework for large-scale data computation which scales Numpy, Pandas and Scikit-learn. Mars can scale in to a single machine, and scale out to a cluster with thousands of machines.

[`Link to integration <https://huggingface.co/transformers/master/main_classes/trainer.html#transformers.Trainer.hyperparameter_search>`__]

Seldon Alibi
------------
[`Link to integration <mars-on-ray>`__]

Alibi is an open source Python library aimed at machine learning model inspection and interpretation. The focus of the library is to provide high-quality implementations of black-box, white-box, local and global explanation methods for classification and regression models.
Modin |modin|
-------------

Github: `https://github.com/SeldonIO/alibi <https://github.com/SeldonIO/alibi>`__
Scale your pandas workflows by changing one line of code. Modin transparently distributes the data and computation so that all you need to do is continue using the pandas API as you were before installing Modin.

GitHub: `https://github.com/modin-project/modin <https://github.com/modin-project/modin>`_

Horovod |horovod|
-----------------

Horovod is a distributed deep learning training framework for TensorFlow, Keras, PyTorch, and Apache MXNet. The goal of Horovod is to make distributed deep learning fast and easy to use.

[`Link to integration <https://horovod.readthedocs.io/en/stable/ray_include.html>`__]

Hugging Face Transformers |hugging|
-----------------------------------

State-of-the-art Natural Language Processing for Pytorch and TensorFlow 2.0.

Intel Analytics Zoo
-------------------
[`Link to integration <https://huggingface.co/transformers/master/main_classes/trainer.html#transformers.Trainer.hyperparameter_search>`__]

Intel Analytics Zoo |zoo|
-------------------------

Analytics Zoo seamless scales TensorFlow, Keras and PyTorch to distributed big data (using Spark, Flink & Ray).

[`Link to integration <https://analytics-zoo.github.io/master/#ProgrammingGuide/rayonspark/>`__]

Modin
-----
PyCaret |pycaret|
-----------------

Scale your pandas workflows by changing one line of code.
PyCaret is an open source low-code machine learning library in Python that aims to reduce the hypothesis to insights cycle time in a ML experiment. It enables data scientists to perform end-to-end experiments quickly and efficiently.

Github: `https://github.com/modin-project/modin/ <https://github.com/modin-project/modin/>`__
Github: `https://github.com/pycaret/pycaret/ <https://github.com/pycaret/pycaret/>`_

Seldon Alibi |seldon|
---------------------

ClassyVision
------------
Alibi is an open source Python library aimed at machine learning model inspection and interpretation. The focus of the library is to provide high-quality implementations of black-box, white-box, local and global explanation methods for classification and regression models.

An end-to-end framework for image and video classification.
Github: `https://github.com/SeldonIO/alibi <https://github.com/SeldonIO/alibi>`__

[`Link to integration <https://classyvision.ai/tutorials/ray_aws>`__]
Spacy |spacy|
-------------
spaCy is a library for advanced Natural Language Processing in Python and Cython. It's built on the very latest research, and was designed from day one to be used in real products.

PyCaret
-------
[`Link to integration <https://pypi.org/project/spacy-ray/>`__]

An open-source, low-code machine learning library in Python.
.. |classyvision| image:: images/classyvision.png
:class: inline-figure
:height: 30

Github: `https://github.com/pycaret/pycaret/ <https://github.com/pycaret/pycaret/>`_
.. |dask| image:: images/dask.png
:class: inline-figure
:height: 30

Flambe
------
.. |flambe| image:: images/flambe.png
:class: inline-figure
:height: 30

Flambé is a machine learning experimentation framework built to accelerate the entire research life cycle. Flambé’s main objective is to provide a unified interface for prototyping models, running experiments containing complex pipelines, monitoring those experiments in real-time, reporting results, and deploying a final model for inference.
.. |mars| image:: images/mars.png
:class: inline-figure
:height: 30

Github: `https://github.com/asappresearch/flambe <https://github.com/asappresearch/flambe>`_
.. |modin| image:: images/modin.png
:class: inline-figure
:height: 30

.. |horovod| image:: images/horovod.png
:class: inline-figure
:height: 30

.. |hugging| image:: images/hugging.png
:class: inline-figure
:height: 30

.. |zoo| image:: images/zoo.png
:class: inline-figure
:height: 30

.. |pycaret| image:: images/pycaret.png
:class: inline-figure
:height: 30

.. |seldon| image:: images/seldon.png
:class: inline-figure
:height: 30

.. |spacy| image:: images/spacy.png
:class: inline-figure
:height: 30
9 changes: 0 additions & 9 deletions doc/source/pandas_on_ray.rst

This file was deleted.

7 changes: 4 additions & 3 deletions doc/source/ray-overview/basics.rst
Original file line number Diff line number Diff line change
Expand Up @@ -18,10 +18,11 @@ On top of **Ray Core** are several libraries for solving problems in machine lea
- :ref:`sgd-index`
- :ref:`rayserve`

There are also many :ref:`community libraries <ray-oss-list>` that integrate with Ray, including `Modin`_, `Hugging Face Transformers`_, :doc:`../dask-on-ray`, `MARS`_, `Horovod`_, and others.
Check out the :ref:`full list of Ray distributed libraries here <ray-oss-list>`.
There are also many :ref:`community integrations <ray-oss-list>` with Ray, including `Dask`_, `MARS`_, `Modin`_, `Horovod`_, `Hugging Face`_, `Scikit-learn`_, and others. Check out the :ref:`full list of Ray distributed libraries here <ray-oss-list>`.

.. _`Modin`: https://github.com/modin-project/modin
.. _`Hugging Face Transformers`: https://huggingface.co/transformers/main_classes/trainer.html#transformers.Trainer.hyperparameter_search
.. _`Hugging Face`: https://huggingface.co/transformers/main_classes/trainer.html#transformers.Trainer.hyperparameter_search
.. _`MARS`: mars-on-ray.html
.. _`Dask`: dask-on-ray.html
.. _`Horovod`: https://horovod.readthedocs.io/en/stable/ray_include.html
.. _`Scikit-learn`: joblib.html

0 comments on commit daabe6b

Please sign in to comment.