Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Updated the setup guide for developing locally to install the fork instead of Ivy repo #22014

Merged
merged 3 commits into from
Aug 17, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 13 additions & 4 deletions docs/overview/contributing/setting_up.rst
Original file line number Diff line number Diff line change
Expand Up @@ -116,11 +116,11 @@ Using miniconda

conda activate ivy_dev

#. Now install ivy package from GitHub by running:
#. Now install ivy package for development by running the command below:

.. code-block:: none

pip install git+https://github.com/unifyai/ivy.git
pip install e .

#. Setup the interpreter by:

Expand Down Expand Up @@ -185,11 +185,11 @@ This is a builtin package and doesn't require explicit installation.

(on Mac/Linux)

#. Now install ivy package from GitHub by running:
#. Now install ivy package for development by running the command below:

.. code-block:: none

pip install git+https://github.com/unifyai/ivy.git
pip install -e .

#. Setup the interpreter by:

Expand Down Expand Up @@ -244,6 +244,15 @@ This is a builtin package and doesn't require explicit installation.
Here are the visual guides for setting up a `virtualenv environment <https://www.jetbrains.com/help/pycharm/creating-virtual-environment.html#0>`_ OR `conda environment <https://www.jetbrains.com/help/pycharm/conda-support-creating-conda-virtual-environment.html>`_ in pycharm from JetBrains.
For VSCode, you can follow the instructions `virtual environments <https://code.visualstudio.com/docs/python/environments#_creating-environments>`_.

**Installing Ivy from source**

You can also install Ivy from source if you want to take advantage of the latest changes, but we can't ensure everything will work as expected. All the steps will remain the same for miniconda and venv as described above, only the command for point 4 for venv and point 5 for miniconda will change, everything else will remain the same. You have to run the following instead:

.. code-block:: none

pip install git+https://github.com/unifyai/ivy.git


Docker Interpreter with PyCharm
-------------------------------

Expand Down
8 changes: 8 additions & 0 deletions docs/overview/deep_dive/array_api_tests.rst
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,14 @@ Instead, the change must be made to the array-api repository directly and then o
# pulls changes from upstream remote repo and merges them
git submodule update --recursive --remote --merge

Sometimes you will face strange behaviour when staging changes from Ivy main repo which includes submodule updates.
And this is being caused by your submodule being out of date because we update the submodule iteratively. You can get around this by running the following command:

.. code-block:: none

# Updating your submodule to the latest commit
git submodule update --remote

and only *then* can changes to the submodule be pushed to ivy-main, i.e. only when these changes exist in the source array-api repository.
See the `git website`_ for further information on working with submodules.

Expand Down
Loading