Skip to content

Commit

Permalink
FEAT-modin-project#7187: Change "master" branch to "main"
Browse files Browse the repository at this point in the history
Signed-off-by: Igoshev, Iaroslav <[email protected]>
  • Loading branch information
YarShev committed Apr 16, 2024
1 parent 6d64e08 commit 13e27cc
Show file tree
Hide file tree
Showing 27 changed files with 86 additions and 86 deletions.
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/bug-report.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ body:
required: true
- label: >
I have confirmed this bug exists on the main branch of Modin. (In order to do this you
can follow [this guide](https://modin.readthedocs.io/en/stable/getting_started/installation.html#installing-from-the-github-master-branch).)
can follow [this guide](https://modin.readthedocs.io/en/stable/getting_started/installation.html#installing-from-the-github-main-branch).)
- type: textarea
id: example
attributes:
Expand Down
8 changes: 4 additions & 4 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ on:
# fuzzydata Github Actions in .github/workflows/fuzzydata-test.yml
- .github/workflows/**
- .github/actions/**
- '!.github/workflows/push-to-master.yml'
- '!.github/workflows/push-to-main.yml'
- asv_bench/**
- modin/**
- requirements/**
Expand Down Expand Up @@ -234,10 +234,10 @@ jobs:
run: |
git remote add upstream https://github.com/modin-project/modin.git
git fetch upstream
if git diff upstream/master --name-only | grep -q "^asv_bench/"; then
if git diff upstream/main --name-only | grep -q "^asv_bench/"; then
# ASV correctly creates environments for testing only from the branch
# with `master` name
git checkout -b master
# with `main` name
git checkout -b main
cd asv_bench
asv check -v
Expand Down
4 changes: 2 additions & 2 deletions .github/workflows/codeql.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@ name: "CodeQL"

on:
push:
branches: [ "master" ]
branches: [ "main" ]
pull_request:
branches: [ "master" ]
branches: [ "main" ]

concurrency:
# Cancel other jobs in the same branch. We don't care whether CI passes
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/fuzzydata-test.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ on:
# NOTE: keep these paths in sync with the paths that trigger the CI Github
# Actions in .github/workflows/ci.yml
- .github/workflows/**
- '!.github/workflows/push-to-master.yml'
- '!.github/workflows/push-to-main.yml'
- asv_bench/**
- modin/**
- requirements/**
Expand Down
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
name: push-to-master
name: push-to-main
on:
push:
branches:
- master
- main
concurrency:
# Cancel other jobs in the same branch. We don't care whether CI passes
# on old commits.
Expand Down
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,9 +11,9 @@

<p align="center">
<a href="https://pepy.tech/project/modin"><img src="https://static.pepy.tech/personalized-badge/modin?period=total&units=international_system&left_color=black&right_color=blue&left_text=Downloads" align="center"></a>
<a href="https://codecov.io/gh/modin-project/modin"><img src="https://codecov.io/gh/modin-project/modin/branch/master/graph/badge.svg" align="center"/></a>
<a href="https://github.com/modin-project/modin/actions"><img src="https://github.com/modin-project/modin/workflows/master/badge.svg" align="center"></a>
<a href="https://github.com/modin-project/modin/actions/workflows/ci.yml?query=event%3Apush"><img src="https://github.com/modin-project/modin/actions/workflows/ci.yml/badge.svg?branch=master" align="center"></a>
<a href="https://codecov.io/gh/modin-project/modin"><img src="https://codecov.io/gh/modin-project/modin/branch/main/graph/badge.svg" align="center"/></a>
<a href="https://github.com/modin-project/modin/actions"><img src="https://github.com/modin-project/modin/workflows/main/badge.svg" align="center"></a>
<a href="https://github.com/modin-project/modin/actions/workflows/ci.yml?query=event%3Apush"><img src="https://github.com/modin-project/modin/actions/workflows/ci.yml/badge.svg?branch=main" align="center"></a>
<a href="https://pypi.org/project/modin/"><img src="https://badge.fury.io/py/modin.svg" alt="PyPI version" align="center"></a>
<a href="https://modin.org/modin-bench/#/"><img src="https://img.shields.io/badge/benchmarked%20by-asv-blue.svg" align="center"></a>
</p>
Expand All @@ -29,7 +29,7 @@ to improve user experience.

By simply replacing the import statement, Modin offers users effortless speed and scale for their pandas workflows:

<img src="https://github.com/modin-project/modin/raw/master/docs/img/Import.gif" style="display: block;margin-left: auto;margin-right: auto;" width="100%"></img>
<img src="https://github.com/modin-project/modin/raw/main/docs/img/Import.gif" style="display: block;margin-left: auto;margin-right: auto;" width="100%"></img>

In the GIFs below, Modin (left) and pandas (right) perform *the same pandas operations* on a 2GB dataset. The only difference between the two notebook examples is the import statement.

Expand Down
6 changes: 3 additions & 3 deletions asv_bench/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

* Check the impact of the new patch on the performance of a certain set of operations:

`asv continuous -f 1.05 src/master HEAD -b TimeGroupBy --launch-method=spawn`
`asv continuous -f 1.05 src/main HEAD -b TimeGroupBy --launch-method=spawn`

* Check for presence of errors inside of benchmarks after changing them or writing new ones:

Expand Down Expand Up @@ -61,13 +61,13 @@ the hash in the corresponding result files.

Step 1: checking benchmarks for validity, runs in PRs CI.
During the test, the benchmarks are run once on small data.
The implementation can be found in `test-asv-benchmarks` job of [ci.yml](https://github.com/modin-project/modin/blob/master/.github/workflows/ci.yml)
The implementation can be found in `test-asv-benchmarks` job of [ci.yml](https://github.com/modin-project/modin/blob/main/.github/workflows/ci.yml)

Step 2: running benchmarks with saving the results in [modin-bench@master](https://github.com/modin-project/modin-bench).
The launch takes place on internal server using specific TeamCity configuration.
The description of the server can be found in the ["Benchmark list"](https://modin.org/modin-bench/#summarylist?sort=0&dir=asc) tab,
on the left when you hover the mouse over the machine name.
This step starts as scheduled (now every half hour), subject to the presence of new commits in the Modin `master` branch.
This step starts as scheduled (now every half hour), subject to the presence of new commits in the Modin `main` branch.
Command to run benchmarks: `asv run HASHFILE:hashfile.txt --show-stderr --machine xeon-e5 --launch-method=spawn`.
In the file `hashfile.txt` is the last modin commit hash.
Writing to a `modin-bench@master` triggers 3 step of the pipeline.
Expand Down
2 changes: 1 addition & 1 deletion codecov.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ coverage:
project:
default:
branches:
- master
- main
target: 85%
patch:
default:
Expand Down
4 changes: 2 additions & 2 deletions contributing/contributing.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,9 +19,9 @@ you should reopen your terminal to find "(base)" next to your prompt: ![](conda_
```
git fetch upstream
```
1. Set the default remote branch for your local master branch.
1. Set the default remote branch for your local main branch.
```
git branch --set-upstream-to=upstream/master master
git branch --set-upstream-to=upstream/main main
```
1. Install modin from local source code, and install all its dependencies:
```
Expand Down
4 changes: 2 additions & 2 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -122,8 +122,8 @@ def noop_decorator(*args, **kwargs):
# source_suffix = ['.rst', '.md']
source_suffix = ".rst"

# The master toctree document.
master_doc = "index"
# The main toctree document.
main_doc = "index"

# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
Expand Down
2 changes: 1 addition & 1 deletion docs/development/architecture.rst
Original file line number Diff line number Diff line change
Expand Up @@ -348,7 +348,7 @@ details. The documentation covers most modules, with more docs being added every
.. _Ray: https://github.com/ray-project/ray
.. _Unidist: https://github.com/modin-project/unidist
.. _MPI: https://www.mpi-forum.org/
.. _code: https://github.com/modin-project/modin/blob/master/modin/core/dataframe
.. _code: https://github.com/modin-project/modin/blob/main/modin/core/dataframe
.. _Dask: https://github.com/dask/dask
.. _Dask Futures: https://docs.dask.org/en/latest/futures.html
.. _issue: https://github.com/modin-project/modin/issues
Expand Down
6 changes: 3 additions & 3 deletions docs/development/contributing.rst
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ with this project or the open source license(s) involved."
Code without a proper signoff cannot be merged into the
master branch. Note: You must use your real name (sorry, no pseudonyms or anonymous
main branch. Note: You must use your real name (sorry, no pseudonyms or anonymous
contributions.)

The text can either be manually added to your commit body, or you can add either ``-s``
Expand Down Expand Up @@ -228,5 +228,5 @@ More docs on this coming soon...
.. _Asv: https://github.com/airspeed-velocity/asv#airspeed-velocity
.. _developer mailing list: https://groups.google.com/forum/#!forum/modin-dev
.. _Asv dashboard: https://modin.org/modin-bench/#/
.. _Asv readme: https://github.com/modin-project/modin/blob/master/asv_bench/README.md
.. _the contributing instructions on GitHub: https://github.com/modin-project/modin/blob/master/contributing/contributing.md
.. _Asv readme: https://github.com/modin-project/modin/blob/main/asv_bench/README.md
.. _the contributing instructions on GitHub: https://github.com/modin-project/modin/blob/main/contributing/contributing.md
20 changes: 10 additions & 10 deletions docs/getting_started/examples.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,26 +9,26 @@ Usage Examples

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/Modin_Taxi.ipynb>`__]
- Modin for Machine Learning with scikit-learn [`Source <https://github.com/modin-project/modin/blob/master/examples/modin-scikit-learn-example.ipynb>`__]
- Quickstart Guide to Modin [`Source <https://github.com/modin-project/modin/tree/main/examples/quickstart.ipynb>`__]
- Using Modin with the NYC Taxi Dataset [`Source <https://github.com/modin-project/modin/blob/main/examples/jupyter/Modin_Taxi.ipynb>`__]
- Modin for Machine Learning with scikit-learn [`Source <https://github.com/modin-project/modin/blob/main/examples/modin-scikit-learn-example.ipynb>`__]

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.

- Exercise 1: Introduction to Modin [`Source PandasOnRay <https://github.com/modin-project/modin/blob/master/examples/tutorial/jupyter/execution/pandas_on_ray/local/exercise_1.ipynb>`__, `Source PandasOnDask <https://github.com/modin-project/modin/blob/master/examples/tutorial/jupyter/execution/pandas_on_dask/local/exercise_1.ipynb>`__, `Source HdkOnNative <https://github.com/modin-project/modin/blob/master/examples/tutorial/jupyter/execution/hdk_on_native/local/exercise_1.ipynb>`__]
- Exercise 2: Speed Improvements with Modin [`Source PandasOnRay <https://github.com/modin-project/modin/blob/master/examples/tutorial/jupyter/execution/pandas_on_ray/local/exercise_2.ipynb>`__, `Source PandasOnDask <https://github.com/modin-project/modin/blob/master/examples/tutorial/jupyter/execution/pandas_on_dask/local/exercise_2.ipynb>`__, `Source HdkOnNative <https://github.com/modin-project/modin/blob/master/examples/tutorial/jupyter/execution/hdk_on_native/local/exercise_2.ipynb>`__]
- Exercise 3: Defaulting to pandas with Modin [`Source PandasOnRay <https://github.com/modin-project/modin/blob/master/examples/tutorial/jupyter/execution/pandas_on_ray/local/exercise_3.ipynb>`__, `Source PandasOnDask <https://github.com/modin-project/modin/blob/master/examples/tutorial/jupyter/execution/pandas_on_dask/local/exercise_3.ipynb>`__, `Source HdkOnNative <https://github.com/modin-project/modin/blob/master/examples/tutorial/jupyter/execution/hdk_on_native/local/exercise_3.ipynb>`__]
- Exercise 1: Introduction to Modin [`Source PandasOnRay <https://github.com/modin-project/modin/blob/main/examples/tutorial/jupyter/execution/pandas_on_ray/local/exercise_1.ipynb>`__, `Source PandasOnDask <https://github.com/modin-project/modin/blob/main/examples/tutorial/jupyter/execution/pandas_on_dask/local/exercise_1.ipynb>`__, `Source HdkOnNative <https://github.com/modin-project/modin/blob/main/examples/tutorial/jupyter/execution/hdk_on_native/local/exercise_1.ipynb>`__]
- Exercise 2: Speed Improvements with Modin [`Source PandasOnRay <https://github.com/modin-project/modin/blob/main/examples/tutorial/jupyter/execution/pandas_on_ray/local/exercise_2.ipynb>`__, `Source PandasOnDask <https://github.com/modin-project/modin/blob/main/examples/tutorial/jupyter/execution/pandas_on_dask/local/exercise_2.ipynb>`__, `Source HdkOnNative <https://github.com/modin-project/modin/blob/main/examples/tutorial/jupyter/execution/hdk_on_native/local/exercise_2.ipynb>`__]
- Exercise 3: Defaulting to pandas with Modin [`Source PandasOnRay <https://github.com/modin-project/modin/blob/main/examples/tutorial/jupyter/execution/pandas_on_ray/local/exercise_3.ipynb>`__, `Source PandasOnDask <https://github.com/modin-project/modin/blob/main/examples/tutorial/jupyter/execution/pandas_on_dask/local/exercise_3.ipynb>`__, `Source HdkOnNative <https://github.com/modin-project/modin/blob/main/examples/tutorial/jupyter/execution/hdk_on_native/local/exercise_3.ipynb>`__]

The following tutorials covers more advanced features in Modin:

- Exercise 4: Experimental Features in Modin (Spreadsheet, Progress Bar) [`Source PandasOnRay <https://github.com/modin-project/modin/blob/master/examples/tutorial/jupyter/execution/pandas_on_ray/local/exercise_4.ipynb>`__, `Source PandasOnDask <https://github.com/modin-project/modin/blob/master/examples/tutorial/jupyter/execution/pandas_on_dask/local/exercise_4.ipynb>`__]
- Exercise 5: Setting up Modin in a Cluster Environment [`Source PandasOnRay <https://github.com/modin-project/modin/blob/master/examples/tutorial/jupyter/execution/pandas_on_ray/cluster/exercise_5.ipynb>`__]
- Exercise 6: Running Modin in a Cluster Environment [`Source PandasOnRay <https://github.com/modin-project/modin/blob/master/examples/tutorial/jupyter/execution/pandas_on_ray/cluster/exercise_6.ipynb>`__]
- Exercise 4: Experimental Features in Modin (Spreadsheet, Progress Bar) [`Source PandasOnRay <https://github.com/modin-project/modin/blob/main/examples/tutorial/jupyter/execution/pandas_on_ray/local/exercise_4.ipynb>`__, `Source PandasOnDask <https://github.com/modin-project/modin/blob/main/examples/tutorial/jupyter/execution/pandas_on_dask/local/exercise_4.ipynb>`__]
- Exercise 5: Setting up Modin in a Cluster Environment [`Source PandasOnRay <https://github.com/modin-project/modin/blob/main/examples/tutorial/jupyter/execution/pandas_on_ray/cluster/exercise_5.ipynb>`__]
- Exercise 6: Running Modin in a Cluster Environment [`Source PandasOnRay <https://github.com/modin-project/modin/blob/main/examples/tutorial/jupyter/execution/pandas_on_ray/cluster/exercise_6.ipynb>`__]

How to get required dependencies for the tutorial notebooks and to run them please refer to the respective `README.md <https://github.com/modin-project/modin/tree/master/examples/tutorial/jupyter/README.md>`__ file.
How to get required dependencies for the tutorial notebooks and to run them please refer to the respective `README.md <https://github.com/modin-project/modin/tree/main/examples/tutorial/jupyter/README.md>`__ file.

Talks & Podcasts
''''''''''''''''
Expand Down
2 changes: 1 addition & 1 deletion docs/getting_started/faq.rst
Original file line number Diff line number Diff line change
Expand Up @@ -194,4 +194,4 @@ Also check out the `Github`_ to view open issues and make contributions.
.. _Unidist: https://github.com/modin-project/unidist
.. _papers: https://people.eecs.berkeley.edu/~totemtang/paper/Modin.pdf
.. _guide: https://modin.readthedocs.io/en/latest/getting_started/installation.html#installing-on-google-colab
.. _tutorial: https://github.com/modin-project/modin/tree/master/examples/tutorial
.. _tutorial: https://github.com/modin-project/modin/tree/main/examples/tutorial
12 changes: 6 additions & 6 deletions docs/getting_started/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,8 @@ Installation
| If you already installed Modin on your machine, you can skip this section.
There are several ways to install Modin. Most users will want to install with
``pip`` or using ``conda`` tool, but some users may want to build from the master branch
on the `GitHub repo`_. The master branch has the most recent patches, but may be less
``pip`` or using ``conda`` tool, but some users may want to build from the main branch
on the `GitHub repo`_. The main branch has the most recent patches, but may be less
stable than a release installed from ``pip`` or ``conda``.

Installing with pip
Expand Down Expand Up @@ -168,10 +168,10 @@ With ``conda`` it is also possible to install `Intel Distribution of Modin`_, a
that is part of Intel\ |reg| oneAPI AI Analytics Toolkit. This version of Modin is powered by :doc:`HDK</development/using_hdk>`
engine that contains a bunch of optimizations for Intel hardware. More details to get started can be found in the `Intel Distribution of Modin Getting Started`_ guide.

Installing from the GitHub master branch
----------------------------------------
Installing from the GitHub main branch
--------------------------------------

If you'd like to try Modin using the most recent updates from the master branch, you can
If you'd like to try Modin using the most recent updates from the main branch, you can
also use ``pip``.

.. code-block:: bash
Expand Down Expand Up @@ -219,7 +219,7 @@ Once cloned, ``cd`` into the ``modin`` directory and use ``pip`` to install:
pip install -e .
pip install -e ".[all]" # will install dependencies for all engines
.. _`GitHub repo`: https://github.com/modin-project/modin/tree/master
.. _`GitHub repo`: https://github.com/modin-project/modin/tree/main
.. _issue: https://github.com/modin-project/modin/issues
.. _WSL: https://docs.microsoft.com/en-us/windows/wsl/install-win10
.. _Ray: http://ray.readthedocs.io
Expand Down
4 changes: 2 additions & 2 deletions docs/getting_started/quickstart.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ Getting Started

.. note::
| *Estimated Reading Time: 10 minutes*
| You can follow along this tutorial in a Jupyter notebook `here <https://github.com/modin-project/modin/tree/master/examples/quickstart.ipynb>`_.
| You can follow along this tutorial in a Jupyter notebook `here <https://github.com/modin-project/modin/tree/main/examples/quickstart.ipynb>`_.
.. toctree::
:hidden:
Expand Down Expand Up @@ -182,5 +182,5 @@ provides.

Note that in this quickstart example, we've only shown ``read_csv``, ``concat``,
``apply``, but these are not the only pandas operations that Modin optimizes for. In
fact, Modin covers `more than 90\% of the pandas API <https://github.com/modin-project/modin/blob/master/README.md#pandas-api-coverage>`_, yielding considerable speedups for
fact, Modin covers `more than 90\% of the pandas API <https://github.com/modin-project/modin/blob/main/README.md#pandas-api-coverage>`_, yielding considerable speedups for
many common operations.
4 changes: 2 additions & 2 deletions docs/getting_started/using_modin/using_modin_cluster.rst
Original file line number Diff line number Diff line change
Expand Up @@ -122,9 +122,9 @@ Now that we have finished the computation, we need to shut down the cluster with
.. _`Ray's autoscaler options`: https://docs.ray.io/en/latest/cluster/vms/references/ray-cluster-configuration.html#cluster-config
.. _`Ray's cluster docs`: https://docs.ray.io/en/latest/cluster/getting-started.html
.. _`NYC Taxi dataset`: https://modin-datasets.intel.com/testing/yellow_tripdata_2015-01.csv
.. _`Modin's Ray cluster setup config`: https://github.com/modin-project/modin/blob/master/examples/tutorial/jupyter/execution/pandas_on_ray/cluster/modin-cluster.yaml
.. _`Modin's Ray cluster setup config`: https://github.com/modin-project/modin/blob/main/examples/tutorial/jupyter/execution/pandas_on_ray/cluster/modin-cluster.yaml
.. _`Amazon EC2 pricing`: https://aws.amazon.com/ec2/pricing/on-demand/
.. _`exercise_5.py`: https://github.com/modin-project/modin/blob/master/examples/tutorial/jupyter/execution/pandas_on_ray/cluster/exercise_5.py
.. _`exercise_5.py`: https://github.com/modin-project/modin/blob/main/examples/tutorial/jupyter/execution/pandas_on_ray/cluster/exercise_5.py
.. _`Ray client`: https://docs.ray.io/en/latest/cluster/running-applications/job-submission/ray-client.html
.. _`Ray CLI`: https://docs.ray.io/en/latest/cluster/vms/getting-started.html#running-applications-on-a-ray-cluster
.. _`AWS CLI environment variables`: https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-envvars.html
2 changes: 1 addition & 1 deletion docs/getting_started/using_modin/using_modin_locally.rst
Original file line number Diff line number Diff line change
Expand Up @@ -75,4 +75,4 @@ improve the performance (and might end up hurting the performance of the system)
Modin will opt for the default setting.


.. _`Jupyter notebook`: https://github.com/modin-project/modin/tree/master/examples/quickstart.ipynb
.. _`Jupyter notebook`: https://github.com/modin-project/modin/tree/main/examples/quickstart.ipynb
Loading

0 comments on commit 13e27cc

Please sign in to comment.