Skip to content

Commit

Permalink
DOCS-#3863: Add usage guide to documentation (#3864)
Browse files Browse the repository at this point in the history
Co-authored-by: Naren Krishna <92325366+naren-ponder@users.noreply.github.com>
Co-authored-by: Dmitry Chigarev <dmitry.chigarev@intel.com>
Co-authored-by: Aditya Parameswaran <adityagp@gmail.com>
Co-authored-by: Dmitry Chigarev <62142979+dchigarev@users.noreply.github.com>
Co-authored-by: Doris Lee <dorisjunglinlee@gmail.com>
Co-authored-by: Devin Petersohn <devin-petersohn@users.noreply.github.com>
Signed-off-by: Igoshev, Yaroslav <yaroslav.igoshev@intel.com>
  • Loading branch information
7 people committed Jan 26, 2022
1 parent 018515f commit 4511566
Show file tree
Hide file tree
Showing 18 changed files with 394 additions and 65 deletions.
2 changes: 1 addition & 1 deletion docs/development/architecture.rst
Original file line number Diff line number Diff line change
Expand Up @@ -354,4 +354,4 @@ details. The documentation covers most modules, with more docs being added every
.. _issue: https://github.com/modin-project/modin/issues
.. _Discourse: https://discuss.modin.org
.. _task parallel: https://en.wikipedia.org/wiki/Task_parallelism
.. _experimental features: /advanced_usage/index.html
.. _experimental features: /usage_guide/advanced_usage/index.html
12 changes: 7 additions & 5 deletions docs/flow/modin/config.rst
Original file line number Diff line number Diff line change
@@ -1,10 +1,12 @@
:orphan:

Config Module Overview
""""""""""""""""""""""
Modin Configuration Settings
""""""""""""""""""""""""""""

Using this module, the user can tune Modin's behavior. To see
all avaliable configs just run `python -m modin.config`, this command will print all
To adjust Modin's default behavior, you can set the value of Modin
configs by setting an environment variable or by using the
``modin.config`` API. To list all avaliable configs in Modin, please
run ``python -m modin.config`` to print all
Modin configs with descriptions.

Public API
Expand All @@ -28,7 +30,7 @@ Modin Configs List
Usage Guide
'''''''''''

See example of interation with Modin configs below, as it can be seen config
See example of interaction with Modin configs below, as it can be seen config
value can be set either by setting the environment variable or by using config
API.

Expand Down
4 changes: 2 additions & 2 deletions docs/flow/modin/distributed/dataframe/pandas.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
Pandas Partition API
====================
Pandas partitioning API
=======================

This page contains a description of the API to extract partitions from and build Modin Dataframes.

Expand Down
32 changes: 16 additions & 16 deletions docs/getting_started/examples.rst
Original file line number Diff line number Diff line change
@@ -1,20 +1,20 @@
Examples and Resources
Examples and Resources
======================

Here you can find additional resources to learn about Modin. To learn more about
advanced usage for Modin, please refer to :doc:`this section </advanced_usage/index>`.
Here you can find additional resources to learn about Modin. To learn more about
advanced usage for Modin, please refer to :doc:`this section </usage_guide/index>`.

Usage Examples
--------------

The following notebooks demonstrate how Modin can be used for scalable data science:
The following notebooks demonstrate how Modin can be used for scalable data science:

- Quickstart Guide to Modin [`Source <https://github.com/modin-project/modin/tree/master/examples/quickstart.ipynb>`_]
- Using Modin with the NYC Taxi Dataset [`Source <https://github.com/modin-project/modin/blob/master/examples/jupyter/NYC_Taxi.ipynb>`_]
- Using Experimental Modin in the cloud with the NYC Taxi Dataset on a AWS cluster [`Source <https://github.com/modin-project/modin/blob/master/examples/jupyter/NYC_Taxi_cloud.ipynb>`_]
- Modin for Machine Learning with scikit-learn [`Source <https://github.com/modin-project/modin/blob/master/examples/modin-scikit-learn-example.ipynb>`_]
- Using Modin with the NYC Taxi Dataset [`Source <https://github.com/modin-project/modin/blob/master/examples/jupyter/NYC_Taxi.ipynb>`_]
- Using Experimental Modin in the cloud with the NYC Taxi Dataset on a AWS cluster [`Source <https://github.com/modin-project/modin/blob/master/examples/jupyter/NYC_Taxi_cloud.ipynb>`_]
- Modin for Machine Learning with scikit-learn [`Source <https://github.com/modin-project/modin/blob/master/examples/modin-scikit-learn-example.ipynb>`_]

Tutorials
Tutorials
---------

The following tutorials cover the basic usage of Modin. `Here <https://www.youtube.com/watch?v=NglkafEmbhE>`_ is a one hour video tutorial that walks through these basic exercises.
Expand All @@ -24,7 +24,7 @@ The following tutorials cover the basic usage of Modin. `Here <https://www.youtu
- Exercise 3: Defaulting to pandas with Modin [`Source <https://github.com/modin-project/modin/blob/master/examples/tutorial/tutorial_notebooks/introduction/exercise_3.ipynb>`_]


The following tutorials covers more advanced features in Modin:
The following tutorials covers more advanced features in Modin:

- Exercise 4: Experimental Features in Modin (Spreadsheet, Progress Bar) [`Source <https://github.com/modin-project/modin/blob/721d2d2fe2a46d3b7442e1ab2c7b70ad3bff0712/examples/tutorial/tutorial_notebooks/introduction/exercise_4.ipynb>`_]
- Exercise 5: Setting up Modin in a Cluster Environment [`Source <https://github.com/modin-project/modin/blob/721d2d2fe2a46d3b7442e1ab2c7b70ad3bff0712/examples/tutorial/tutorial_notebooks/cluster/exercise_5.ipynb>`_]
Expand All @@ -33,14 +33,14 @@ The following tutorials covers more advanced features in Modin:
Talks & Podcasts
----------------

- `Scaling Interactive Data Science with Modin and Ray <https://www.youtube.com/watch?v=ycSf1IbBGWk>`_ (20 minute, Ray Summit 2021)
- `Unleash The Power Of Dataframes At Any Scale With Modin <https://www.pythonpodcast.com/modin-parallel-dataframe-episode-324/>`_ (40 minute, Python Podcast 2021)
- `Scaling Interactive Data Science with Modin and Ray <https://www.youtube.com/watch?v=ycSf1IbBGWk>`_ (20 minute, Ray Summit 2021)
- `Unleash The Power Of Dataframes At Any Scale With Modin <https://www.pythonpodcast.com/modin-parallel-dataframe-episode-324/>`_ (40 minute, Python Podcast 2021)
- `[Russian] Distributed Data Processing and XGBoost Training and Prediction with Modin <https://www.youtube.com/watch?v=oo_lxUjsFTM&t=1s>`_ (30 minute, PyCon Russia 2021)
- `[Russian] Efficient Data Science with Modin <https://www.youtube.com/watch?v=cOM82kHRwkM&t=6568s>`_ (30 minute, ISP RAS Open 2021)
- `Modin: Scaling the Capabilities of the Data Scientist, not the Machine <https://www.youtube.com/watch?v=NglkafEmbhE>`_ (1 hour, RISE Camp 2020)
- `Modin: Pandas Scalability with Devin Petersohn <https://softwareengineeringdaily.com/2020/07/23/modin-pandas-scalability-with-devin-petersohn/>`_ (1 hour, Software Engineering Daily Podcast 2020)
- `Introduction to the DataFrame and Modin <https://www.youtube.com/watch?v=_0eVVLXrtfY>`_ (20 minute, RISECamp 2019)
- `Scaling Interactive Pandas Workflows with Modin <hhttps://www.youtube.com/watch?v=-HjLd_3ahCw>`_ (40 minute, PyData NYC 2018)
- `Modin: Scaling the Capabilities of the Data Scientist, not the Machine <https://www.youtube.com/watch?v=NglkafEmbhE>`_ (1 hour, RISE Camp 2020)
- `Modin: Pandas Scalability with Devin Petersohn <https://softwareengineeringdaily.com/2020/07/23/modin-pandas-scalability-with-devin-petersohn/>`_ (1 hour, Software Engineering Daily Podcast 2020)
- `Introduction to the DataFrame and Modin <https://www.youtube.com/watch?v=_0eVVLXrtfY>`_ (20 minute, RISECamp 2019)
- `Scaling Interactive Pandas Workflows with Modin <hhttps://www.youtube.com/watch?v=-HjLd_3ahCw>`_ (40 minute, PyData NYC 2018)

Community contributions
-----------------------
Expand All @@ -57,7 +57,7 @@ Here are some blogposts and articles about Modin:
- `How To Accelerate Pandas With Just One Line Of Code by Analytics India <https://analyticsindiamag.com/how-to-accelerate-pandas-with-just-one-line-of-code-modin/>`_


Here are some articles contributed by the international community:
Here are some articles contributed by the international community:

- `[Chinese] 用 Modin 来提速 pandas 工作流程 by Python Chinese Community <https://blog.csdn.net/BF02jgtRS00XKtCx/article/details/90709222>`_
- `[German] Was ist Modin? by Dipl.-Ing. (FH) Stefan Luber <https://www.bigdata-insider.de/was-ist-modin-a-982826/>`_
Expand Down

0 comments on commit 4511566

Please sign in to comment.