Skip to content

Commit

Permalink
docs: remove mention of applied libraries (ivy-llc#23191)
Browse files Browse the repository at this point in the history
  • Loading branch information
KareemMAX authored Sep 7, 2023
1 parent 35965c6 commit 0c008da
Show file tree
Hide file tree
Showing 7 changed files with 8 additions and 218 deletions.
57 changes: 0 additions & 57 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -322,63 +322,6 @@ The model\'s output can be visualized as follows:
<img width="50%" class="dark-light" src="https://raw.githubusercontent.com/unifyai/unifyai.github.io/main/img/regressor_lq.gif">
</div>

Last but not least, we are also working on specific extensions totally
written in Ivy and therefore usable within any framework, covering
topics like [Mechanics](https://github.com/unifyai/mech), [Computer
Vision](https://github.com/unifyai/vision),
[Robotics](https://github.com/unifyai/robot), a [Reinforcement Learning
Gym](https://github.com/unifyai/gym),
[Memory](https://github.com/unifyai/memory) and implementation of
various [Models](https://github.com/unifyai/models) or [Builder
tools](https://github.com/unifyai/builder) with trainers, data loaders
and more!

<br/>
<div align="center">
<a class="only-dark" href="https://github.com/unifyai/mech#gh-dark-mode-only">
<img class="only-dark" width="12.5%" style="padding-right: 4px; padding-bottom: 4px;" src="https://raw.githubusercontent.com/unifyai/unifyai.github.io/main/img/externally_linked/logos/ivy_mech_dark.png#gh-dark-mode-only">
</a>
<a class="only-light" href="https://github.com/unifyai/mech#gh-light-mode-only">
<img class="only-dark" width="12.5%" style="padding-right: 4px; padding-bottom: 4px;" src="https://raw.githubusercontent.com/unifyai/unifyai.github.io/main/img/externally_linked/logos/ivy_mech.png#gh-light-mode-only">
</a>
<a class="only-dark" href="https://github.com/unifyai/vision#gh-dark-mode-only">
<img class="only-dark" width="12.5%" style="padding-right: 4px; padding-bottom: 4px;" src="https://raw.githubusercontent.com/unifyai/unifyai.github.io/main/img/externally_linked/logos/ivy_vision_dark.png#gh-dark-mode-only">
</a>
<a class="only-light" href="https://github.com/unifyai/vision#gh-light-mode-only">
<img class="only-dark" width="12.5%" style="padding-right: 4px; padding-bottom: 4px;" src="https://raw.githubusercontent.com/unifyai/unifyai.github.io/main/img/externally_linked/logos/ivy_vision.png#gh-light-mode-only">
</a>
<a class="only-dark" href="https://github.com/unifyai/robot#gh-dark-mode-only">
<img class="only-dark" width="12.5%" style="padding-right: 4px; padding-bottom: 4px;" src="https://raw.githubusercontent.com/unifyai/unifyai.github.io/main/img/externally_linked/logos/ivy_robot_dark.png#gh-dark-mode-only">
</a>
<a class="only-light" href="https://github.com/unifyai/robot#gh-light-mode-only">
<img class="only-dark" width="12.5%" style="padding-right: 4px; padding-bottom: 4px;" src="https://raw.githubusercontent.com/unifyai/unifyai.github.io/main/img/externally_linked/logos/ivy_robot.png#gh-light-mode-only">
</a>
<a class="only-dark" href="https://github.com/unifyai/gym#gh-dark-mode-only">
<img class="only-dark" width="12.5%" style="padding-right: 4px; padding-bottom: 4px;" src="https://raw.githubusercontent.com/unifyai/unifyai.github.io/main/img/externally_linked/logos/ivy_gym_dark.png#gh-dark-mode-only">
</a>
<a class="only-light" href="https://github.com/unifyai/gym#gh-light-mode-only">
<img class="only-dark" width="12.5%" style="padding-right: 4px; padding-bottom: 4px;" src="https://raw.githubusercontent.com/unifyai/unifyai.github.io/main/img/externally_linked/logos/ivy_gym.png#gh-light-mode-only">
</a>
<a class="only-dark" href="https://github.com/unifyai/memory#gh-dark-mode-only">
<img class="only-dark" width="12.5%" style="padding-right: 4px; padding-bottom: 4px;" src="https://raw.githubusercontent.com/unifyai/unifyai.github.io/main/img/externally_linked/logos/ivy_memory_dark.png#gh-dark-mode-only">
</a>
<a class="only-light" href="https://github.com/unifyai/memory#gh-light-mode-only">
<img class="only-dark" width="12.5%" style="padding-right: 4px; padding-bottom: 4px;" src="https://raw.githubusercontent.com/unifyai/unifyai.github.io/main/img/externally_linked/logos/ivy_memory.png#gh-light-mode-only">
</a>
<a class="only-dark" href="https://github.com/unifyai/builder#gh-dark-mode-only">
<img class="only-dark" width="12.5%" style="padding-right: 4px; padding-bottom: 4px;" src="https://raw.githubusercontent.com/unifyai/unifyai.github.io/main/img/externally_linked/logos/ivy_builder_dark.png#gh-dark-mode-only">
</a>
<a class="only-light" href="https://github.com/unifyai/builder#gh-light-mode-only">
<img class="only-dark" width="12.5%" style="padding-right: 4px; padding-bottom: 4px;" src="https://raw.githubusercontent.com/unifyai/unifyai.github.io/main/img/externally_linked/logos/ivy_builder.png#gh-light-mode-only">
</a>
<a class="only-dark" href="https://github.com/unifyai/models#gh-dark-mode-only">
<img class="only-dark" width="12.5%" style="padding-right: 4px; padding-bottom: 4px;" src="https://raw.githubusercontent.com/unifyai/unifyai.github.io/main/img/externally_linked/logos/ivy_models_dark.png#gh-dark-mode-only">
</a>
<a class="only-light" href="https://github.com/unifyai/models#gh-light-mode-only">
<img class="only-dark" width="12.5%" style="padding-right: 4px; padding-bottom: 4px;" src="https://raw.githubusercontent.com/unifyai/unifyai.github.io/main/img/externally_linked/logos/ivy_models.png#gh-light-mode-only">
</a>
</div>
<br clear="all" />

As always, you can find more information about [Ivy as a framework in
the
Expand Down
6 changes: 1 addition & 5 deletions docs/overview/contributing.rst
Original file line number Diff line number Diff line change
Expand Up @@ -30,10 +30,7 @@ The contributor guide is split into the sections below, it's best to go from sta
| (e) `Open Tasks <contributing/open_tasks.rst>`_
| See where you can help us out! 🙋
|
| (f) `Applied Libraries <contributing/applied_libraries.rst>`_
| Getting started with our applied libraries! 📚
|
| (g) `Helpful Resources <contributing/helpful_resources.rst>`_
| (f) `Helpful Resources <contributing/helpful_resources.rst>`_
| Resources you would find useful when learning Ivy 📖
|
| (g) `Error Handling <contributing/error_handling.rst>`_
Expand All @@ -49,7 +46,6 @@ The contributor guide is split into the sections below, it's best to go from sta
contributing/building_the_docs.rst
Deep Dive <https://unify.ai/docs/ivy/overview/deep_dive.html>
contributing/open_tasks.rst
contributing/applied_libraries.rst
contributing/helpful_resources.rst
contributing/error_handling.rst

Expand Down
142 changes: 0 additions & 142 deletions docs/overview/contributing/applied_libraries.rst

This file was deleted.

12 changes: 6 additions & 6 deletions docs/overview/contributing/building_the_docs.rst
Original file line number Diff line number Diff line change
Expand Up @@ -25,18 +25,18 @@ Using existing image on Docker Hub

You can also use the ``unifyai/doc-builder`` image hosted on
`Docker Hub <https://hub.docker.com/r/unifyai/doc-builder>`_ to build the
docs. This will be helpful if you want to build the docs for Ivy applied libraries.
docs.

Run ``docker run`` to build the docs. The following command will build the docs for
the project in the current directory and output them to ``docs/build``.

.. code-block:: bash
cd <ivy directory or applied library directory>
cd <ivy directory>
docker run --rm -v $(pwd):/project unifyai/doc-builder
This command will mount the module directory to ``/project`` in the container, the
current directory can be the root of ``ivy`` or any applied library such as ``mech``.
current directory should be the root of ``ivy``.

Building the image locally
~~~~~~~~~~~~~~~~~~~~~~~~~~
Expand Down Expand Up @@ -87,8 +87,8 @@ Then, run the following command to build the docs:
.. code-block:: bash
cd doc-builder
./make_docs_without_docker.sh <ivy directory or applied library directory>
./make_docs_without_docker.sh <ivy directory>
The script will install the required dependencies for `sphinx <https://www.sphinx-doc.org>`_
which is used to build the docs, as well as dependencies required by Ivy or the Ivy
applied library. Then it will build the docs for Ivy and store it in ``docs/build``.
which is used to build the docs, as well as dependencies required by Ivy. Then it will
build the docs for Ivy and store it in ``docs/build``.
2 changes: 0 additions & 2 deletions docs/overview/faq.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@ FAQ
.. _`dex`: https://github.com/dexidp/dex
.. _`API for distributed training`: https://github.com/unifyai/ivy/blob/a2f37b1bae232b7ba5257e59f8b46a0374cca9f1/ivy/functional/ivy/device.py#L660
.. _`fully support these`: https://pytorch.org/tutorials/prototype/vmap_recipe.html
.. _`Ivy Builder`: https://github.com/unifyai/builder
.. _`README`: https://github.com/unifyai/ivy

These are some of the most common technical questions that continue to arise when we're discussing Ivy with developers in the community.
Expand Down Expand Up @@ -156,7 +155,6 @@ The Pipeline

**A:** We are not advocating to replace all code with Ivy.
We would encourage users to continue using whatever data loaders they want to, and perhaps just use an Ivy model, or use Ivy to convert a model, or even just a single function from a library.
If users want to use Ivy more deeply, then they can use `Ivy Builder`_, which includes framework-agnostic abstract data loaders, trainers, and other higher level classes for composing full training pipelines.

State
-----
Expand Down
6 changes: 0 additions & 6 deletions docs/overview/glossary.rst
Original file line number Diff line number Diff line change
Expand Up @@ -45,12 +45,6 @@ All of these new words can get confusing! We've created a glossary to help nail
Automatic Code Conversions
Allows code to be converted from one framework to another whilst retaining its functional assets.

Applied Libraries
Suite of various machine learning libraries that have been built using the Ivy framework.

Ivy Builder
Helpful classes and functions for creating training workflows.

Primary Functions
Primary functions are the lowest level building blocks in Ivy and are generally implemented as light wrapping around an existing function in the backend framework, which serves a near-identical purpose.

Expand Down
1 change: 1 addition & 0 deletions docs/partial_conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,7 @@
from docs.conf import html_theme_options

html_theme_options["switcher"]["json_url"] = "https://unify.ai/docs/versions/ivy.json"
html_sidebars = {"**": ["custom-toc-tree"]}

repo_name = "ivy"

Expand Down

0 comments on commit 0c008da

Please sign in to comment.