From c565cbf6244e1e207981e4dbc8e970acf9b71890 Mon Sep 17 00:00:00 2001 From: Matthew Rocklin Date: Sun, 25 Mar 2018 09:22:46 -0400 Subject: [PATCH] Add content to api page --- docs/source/api.rst | 22 +++++++++++++--------- 1 file changed, 13 insertions(+), 9 deletions(-) diff --git a/docs/source/api.rst b/docs/source/api.rst index 99749bf0790..4ebee909588 100644 --- a/docs/source/api.rst +++ b/docs/source/api.rst @@ -1,14 +1,18 @@ -Base API -======== +API +=== -This page includes API that is common across all Dask operation. -Note that the individual APIs have their own separate API pages available here: +Dask APIs generally follow from upstream APIs: -- :doc:`Arrays ` -- :doc:`Bags ` -- :doc:`Dataframes ` -- :doc:`Delayed ` -- :doc:`Futures ` +- The :doc:`Dask Array API ` follows the Numpy API +- The :doc:`Dask Dataframe API ` follows the Pandas API +- The `Dask-ML API `_ follows the Scikit-Learn API and other related machine learning libraries +- The :doc:`Dask Bag API ` follows the map/filter/groupby/reduce API common in PySpark, PyToolz, and the Python standard library +- The :doc:`Dask Delayed API ` wraps general Python code +- The :doc:`Real-time Futures API ` follows the `concurrent.futures `_ API from the standard library. + +Additionally, Dask has its own functions to start computations, persist data in +memory, check progress, and so forth that complement the APIs above. +These more general Dask functions are described below: .. currentmodule:: dask