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

Migrating zoo/brain docs to top-level #4818

Merged
merged 3 commits into from
Sep 23, 2024
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
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -116,7 +116,7 @@ FiftyOne.

## Contributing to FiftyOne

FiftyOne and [FiftyOne-Brain](https://github.com/voxel51/fiftyone-brain) are
FiftyOne and [FiftyOne Brain](https://github.com/voxel51/fiftyone-brain) are
open source and community contributions are welcome!

Check out the
Expand Down
6 changes: 3 additions & 3 deletions docs/source/user_guide/brain.rst → docs/source/brain.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,9 @@ FiftyOne Brain

.. default-role:: code

The FiftyOne Brain provides powerful machine learning techniques that are
designed to transform how you curate your data from an art into a measurable
science.
The `FiftyOne Brain <https://github.com/voxel51/fiftyone-brain>` provides
powerful machine learning techniques that are designed to transform how you
curate your data from an art into a measurable science.

.. note::

Expand Down
72 changes: 70 additions & 2 deletions docs/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -351,7 +351,7 @@ models.

.. custombutton::
:button_text: Learn more about the Brain
:button_link: user_guide/brain.html
:button_link: brain.html

.. code-block:: python
:linenos:
Expand Down Expand Up @@ -380,6 +380,71 @@ that execute on a connected workflow orchestration tool like Apache Airflow.
:alt: fiftyone-plugins
:align: center

Dataset Zoo
-----------

The FiftyOne Dataset Zoo provides a powerful interface for downloading datasets
and loading them into FiftyOne.

It provides native access to dozens of popular benchmark datasets, and it als
supports downloading arbitrary public or private datasets whose
download/preparation methods are provided via GitHub repositories or URLs.

.. custombutton::
:button_text: Check out the Dataset Zoo
:button_link: dataset_zoo/index.html

.. code-block:: python
:linenos:

import fiftyone as fo
import fiftyone.zoo as foz

dataset = foz.load_zoo_dataset("coco-2017", split="validation")

session = fo.launch_app(dataset)

.. image:: images/dataset_zoo_coco_2017.png
:alt: dataset-zoo
:align: center

Model Zoo
---------

The FiftyOne Model Zoo provides a powerful interface for downloading models and
applying them to your FiftyOne datasets.

It provides native access to hundreds of pre-trained models, and it also
supports downloading arbitrary public or private models whose definitions are
provided via GitHub repositories or URLs.

.. custombutton::
:button_text: Check out the Model Zoo
:button_link: model_zoo/index.html

.. code-block:: python
:linenos:

import fiftyone as fo
import fiftyone.zoo as foz

dataset = foz.load_zoo_dataset(
"coco-2017",
split="validation",
max_samples=50,
shuffle=True,
)

model = foz.load_zoo_model(
"clip-vit-base32-torch",
text_prompt="A photo of a",
classes=["person", "dog", "cat", "bird", "car", "tree", "chair"],
)

dataset.apply_model(model, label_field="zero_shot_predictions")

session = fo.launch_app(dataset)

What's Next?
____________

Expand Down Expand Up @@ -407,13 +472,16 @@ us at support@voxel51.com.
:hidden:

Overview <self>
FiftyOne Teams 🚀<teams/index>
Installation <getting_started/install>
Environments <environments/index>
Tutorials <tutorials/index>
Recipes <recipes/index>
Cheat Sheets <cheat_sheets/index>
User Guide <user_guide/index>
FiftyOne Teams <teams/index>
Dataset Zoo <dataset_zoo/index>
Model Zoo <model_zoo/index>
FiftyOne Brain <brain>
Integrations <integrations/index>
Plugins <plugins/index>
CLI <cli/index>
Expand Down
4 changes: 2 additions & 2 deletions docs/source/integrations/albumentations.rst
Original file line number Diff line number Diff line change
Expand Up @@ -94,8 +94,8 @@ Next, install the
operator, selecting the Albumentations plugin from the community dropdown menu.

You will also need to load (and download if necessary) a dataset to apply the
augmentations to. For this guide, we'll use the the
`quickstart dataset <https://docs.voxel51.com/user_guide/dataset_zoo/datasets.html#quickstart>`_:
augmentations to. For this guide, we'll use the
:ref:`quickstart dataset <dataset-zoo-quickstart>`:

.. code-block:: python

Expand Down
File renamed without changes.
Loading
Loading