From 9dacc067bd8eba10003caffd3aae0988f149e4da Mon Sep 17 00:00:00 2001 From: Jacob Marks Date: Fri, 12 Jan 2024 14:07:11 -0800 Subject: [PATCH] reorg for integrations --- .../integrations/{ => annotation}/cvat.rst | 0 docs/source/integrations/annotation/index.rst | 77 +++++++++++++++ .../{ => annotation}/labelbox.rst | 0 .../{ => annotation}/labelstudio.rst | 0 .../integrations/{ => annotation}/v7.rst | 0 .../{ => datasets}/activitynet.rst | 0 .../integrations/{ => datasets}/coco.rst | 0 docs/source/integrations/datasets/index.rst | 69 ++++++++++++++ .../{ => datasets}/open_images.rst | 0 docs/source/integrations/index.rst | 52 ++++------- docs/source/integrations/models/index.rst | 71 ++++++++++++++ .../{ => models}/lightning_flash.rst | 0 .../integrations/{ => models}/pytorch_hub.rst | 0 .../integrations/{ => models}/ultralytics.rst | 0 .../integrations/vector_search/index.rst | 93 +++++++++++++++++++ .../{ => vector_search}/lancedb.rst | 0 .../{ => vector_search}/milvus.rst | 0 .../{ => vector_search}/mongodb.rst | 0 .../{ => vector_search}/pinecone.rst | 0 .../{ => vector_search}/qdrant.rst | 0 .../{ => vector_search}/redis.rst | 0 21 files changed, 330 insertions(+), 32 deletions(-) rename docs/source/integrations/{ => annotation}/cvat.rst (100%) create mode 100644 docs/source/integrations/annotation/index.rst rename docs/source/integrations/{ => annotation}/labelbox.rst (100%) rename docs/source/integrations/{ => annotation}/labelstudio.rst (100%) rename docs/source/integrations/{ => annotation}/v7.rst (100%) rename docs/source/integrations/{ => datasets}/activitynet.rst (100%) rename docs/source/integrations/{ => datasets}/coco.rst (100%) create mode 100644 docs/source/integrations/datasets/index.rst rename docs/source/integrations/{ => datasets}/open_images.rst (100%) create mode 100644 docs/source/integrations/models/index.rst rename docs/source/integrations/{ => models}/lightning_flash.rst (100%) rename docs/source/integrations/{ => models}/pytorch_hub.rst (100%) rename docs/source/integrations/{ => models}/ultralytics.rst (100%) create mode 100644 docs/source/integrations/vector_search/index.rst rename docs/source/integrations/{ => vector_search}/lancedb.rst (100%) rename docs/source/integrations/{ => vector_search}/milvus.rst (100%) rename docs/source/integrations/{ => vector_search}/mongodb.rst (100%) rename docs/source/integrations/{ => vector_search}/pinecone.rst (100%) rename docs/source/integrations/{ => vector_search}/qdrant.rst (100%) rename docs/source/integrations/{ => vector_search}/redis.rst (100%) diff --git a/docs/source/integrations/cvat.rst b/docs/source/integrations/annotation/cvat.rst similarity index 100% rename from docs/source/integrations/cvat.rst rename to docs/source/integrations/annotation/cvat.rst diff --git a/docs/source/integrations/annotation/index.rst b/docs/source/integrations/annotation/index.rst new file mode 100644 index 0000000000..f9861b1bcf --- /dev/null +++ b/docs/source/integrations/annotation/index.rst @@ -0,0 +1,77 @@ + +.. _annotation-integrations: + +FiftyOne Annotation Integrations +================================ + +.. default-role:: code + +FiftyOne integrates naturally with annotation tools that you know and love, +enabling you to easily send labeling tasks, QA annotations, and more. Click on +the cards below to see how! + +.. Integrations cards section ----------------------------------------------------- + +.. raw:: html + +
+ +
+ +
+ +
+
+ +.. Add tutorial cards below + +.. customcarditem:: + :header: CVAT + :description: Use our CVAT integration to easily annotate and edit your FiftyOne datasets. + :link: cvat.html + :image: ../../_static/images/integrations/cvat.png + :tags: Annotation + +.. customcarditem:: + :header: Label Studio + :description: Annotate and edit your FiftyOne datasets in Label Studio through our integration. + :link: labelstudio.html + :image: ../../_static/images/integrations/labelstudio.png + :tags: Annotation + +.. customcarditem:: + :header: V7 + :description: Use our V7 integration to easily annotate and edit your FiftyOne datasets. + :link: v7.html + :image: ../../_static/images/integrations/v7.jpg + :tags: Annotation + +.. customcarditem:: + :header: Labelbox + :description: Use our Labelbox integration to get your FiftyOne datasets annotated. + :link: labelbox.html + :image: ../../_static/images/integrations/labelbox.jpeg + :tags: Annotation + +.. End of integrations cards + +.. raw:: html + +
+ + + +
+ +
+ +.. End integrations cards section ------------------------------------------------- + +.. toctree:: + :maxdepth: 1 + :hidden: + + CVAT + Labelbox + Label Studio + V7 \ No newline at end of file diff --git a/docs/source/integrations/labelbox.rst b/docs/source/integrations/annotation/labelbox.rst similarity index 100% rename from docs/source/integrations/labelbox.rst rename to docs/source/integrations/annotation/labelbox.rst diff --git a/docs/source/integrations/labelstudio.rst b/docs/source/integrations/annotation/labelstudio.rst similarity index 100% rename from docs/source/integrations/labelstudio.rst rename to docs/source/integrations/annotation/labelstudio.rst diff --git a/docs/source/integrations/v7.rst b/docs/source/integrations/annotation/v7.rst similarity index 100% rename from docs/source/integrations/v7.rst rename to docs/source/integrations/annotation/v7.rst diff --git a/docs/source/integrations/activitynet.rst b/docs/source/integrations/datasets/activitynet.rst similarity index 100% rename from docs/source/integrations/activitynet.rst rename to docs/source/integrations/datasets/activitynet.rst diff --git a/docs/source/integrations/coco.rst b/docs/source/integrations/datasets/coco.rst similarity index 100% rename from docs/source/integrations/coco.rst rename to docs/source/integrations/datasets/coco.rst diff --git a/docs/source/integrations/datasets/index.rst b/docs/source/integrations/datasets/index.rst new file mode 100644 index 0000000000..333a1b466c --- /dev/null +++ b/docs/source/integrations/datasets/index.rst @@ -0,0 +1,69 @@ + +.. _dataset-integrations: + +FiftyOne Dataset Integrations +============================= + +.. default-role:: code + +FiftyOne integrates naturally with datasets that you know and love. Click +on the cards below to see how! + +.. Integrations cards section ----------------------------------------------------- + +.. raw:: html + +
+ +
+ +
+ +
+
+ +.. Add tutorial cards below + + +.. customcarditem:: + :header: COCO Dataset + :description: See how FiftyOne makes downloading, visualizing, and evaluating on the COCO dataset (or your own COCO-formatted data) a breeze. + :link: coco.html + :image: ../../_static/images/integrations/coco.png + :tags: Datasets,Model-Evaluation + +.. customcarditem:: + :header: Open Images Dataset + :description: See why FiftyOne is a recommended tool for downloading, visualizing, and evaluating on Google's Open Images Dataset. + :link: open_images.html + :image: ../../_static/images/integrations/open_images.png + :tags: Datasets,Model-Evaluation + +.. customcarditem:: + :header: ActivityNet Dataset + :description: See how to use FiftyOne to download, visualize, and evaluate on the ActivityNet dataset with ease. + :link: activitynet.html + :image: ../../_static/images/integrations/activitynet.png + :tags: Datasets,Model-Evaluation + +.. End of integrations cards + +.. raw:: html + +
+ + + +
+ +
+ +.. End integrations cards section ------------------------------------------------- + +.. toctree:: + :maxdepth: 1 + :hidden: + + ActivityNet + COCO + Open Images \ No newline at end of file diff --git a/docs/source/integrations/open_images.rst b/docs/source/integrations/datasets/open_images.rst similarity index 100% rename from docs/source/integrations/open_images.rst rename to docs/source/integrations/datasets/open_images.rst diff --git a/docs/source/integrations/index.rst b/docs/source/integrations/index.rst index 480a372987..e8b957ac47 100644 --- a/docs/source/integrations/index.rst +++ b/docs/source/integrations/index.rst @@ -37,112 +37,112 @@ on the cards below to see how! .. customcarditem:: :header: COCO Dataset :description: See how FiftyOne makes downloading, visualizing, and evaluating on the COCO dataset (or your own COCO-formatted data) a breeze. - :link: coco.html + :link: datasets/coco.html :image: ../_static/images/integrations/coco.png :tags: Datasets,Model-Evaluation .. customcarditem:: :header: Open Images Dataset :description: See why FiftyOne is a recommended tool for downloading, visualizing, and evaluating on Google's Open Images Dataset. - :link: open_images.html + :link: datasets/open_images.html :image: ../_static/images/integrations/open_images.png :tags: Datasets,Model-Evaluation .. customcarditem:: :header: ActivityNet Dataset :description: See how to use FiftyOne to download, visualize, and evaluate on the ActivityNet dataset with ease. - :link: activitynet.html + :link: datasets/activitynet.html :image: ../_static/images/integrations/activitynet.png :tags: Datasets,Model-Evaluation .. customcarditem:: :header: CVAT :description: Use our CVAT integration to easily annotate and edit your FiftyOne datasets. - :link: cvat.html + :link: annotation/cvat.html :image: ../_static/images/integrations/cvat.png :tags: Annotation .. customcarditem:: :header: Label Studio :description: Annotate and edit your FiftyOne datasets in Label Studio through our integration. - :link: labelstudio.html + :link: annotation/labelstudio.html :image: ../_static/images/integrations/labelstudio.png :tags: Annotation .. customcarditem:: :header: V7 :description: Use our V7 integration to easily annotate and edit your FiftyOne datasets. - :link: v7.html + :link: annotation/v7.html :image: ../_static/images/integrations/v7.jpg :tags: Annotation .. customcarditem:: :header: Labelbox :description: Use our Labelbox integration to get your FiftyOne datasets annotated. - :link: labelbox.html + :link: annotation/labelbox.html :image: ../_static/images/integrations/labelbox.jpeg :tags: Annotation .. customcarditem:: :header: Qdrant :description: Use our Qdrant integration to enable vector search and query your FiftyOne datasets at scale. - :link: qdrant.html + :link: vector_search/qdrant.html :image: ../_static/images/integrations/qdrant.png :tags: Brain,Embeddings,Filtering .. customcarditem:: :header: Redis :description: Use our Redis vector search integration to index your FiftyOne datasets and perform embeddings queries at scale. - :link: redis.html + :link: vector_search/redis.html :image: ../_static/images/integrations/redis.jpg :tags: Brain,Embeddings,Filtering .. customcarditem:: :header: Pinecone :description: Use our Pinecone integration to index your FiftyOne datasets and perform embeddings queries at scale. - :link: pinecone.html + :link: vector_search/pinecone.html :image: ../_static/images/integrations/pinecone.png :tags: Brain,Embeddings,Filtering .. customcarditem:: :header: MongoDB :description: Use our MongoDB vector search integration to index your FiftyOne datasets and perform embeddings queries at scale. - :link: mongodb.html + :link: vector_search/mongodb.html :image: ../_static/images/integrations/mongodb.jpg :tags: Brain,Embeddings,Filtering .. customcarditem:: :header: Milvus :description: Use our Milvus integration to index your FiftyOne datasets and perform embeddings queries at scale. - :link: milvus.html + :link: vector_search/milvus.html :image: ../_static/images/integrations/milvus.png :tags: Brain,Embeddings,Filtering .. customcarditem:: :header: LanceDB :description: Use our LancedDB integration to index your datasets and perform embeddings queries at scale without the need for a cloud service. - :link: lancedb.html + :link: vector_search/lancedb.html :image: ../_static/images/integrations/lancedb.png :tags: Brain,Embeddings,Filtering .. customcarditem:: :header: Ultralytics :description: Load, fine-tune, and run inference with Ultralytics models on your FiftyOne datasets with just a few lines of code. - :link: ultralytics.html + :link: models/ultralytics.html :image: ../_static/images/integrations/ultralytics.jpg :tags: Model-Training,Model-Evaluation .. customcarditem:: :header: PyTorch Hub :description: Did you know? You can load any model from the PyTorch Hub and run inference on your FiftyOne datasets with just a few lines of code. - :link: pytorch_hub.html + :link: models/pytorch_hub.html :image: ../_static/images/integrations/pytorch.png :tags: Model-Zoo,Model-Evaluation .. customcarditem:: :header: Lightning Flash :description: Train Flash models on FiftyOne datasets and use the FiftyOne App to visualize and improve your Flash models, all with just a few lines of code. - :link: lightning_flash.html + :link: models/lightning_flash.html :image: ../_static/images/integrations/lightning_flash.png :tags: Model-Training,Model-Evaluation @@ -164,19 +164,7 @@ on the cards below to see how! :maxdepth: 1 :hidden: - COCO - Open Images - ActivityNet - CVAT - Label Studio - V7 - Labelbox - Qdrant - Redis - Pinecone - MongoDB - Milvus - LanceDB - Ultralytics - PyTorch Hub - Lightning Flash + Annotation + Datasets + Models + Vector Search \ No newline at end of file diff --git a/docs/source/integrations/models/index.rst b/docs/source/integrations/models/index.rst new file mode 100644 index 0000000000..dad930b08c --- /dev/null +++ b/docs/source/integrations/models/index.rst @@ -0,0 +1,71 @@ + +.. _model-integrations: + +FiftyOne Model Integrations +================================ + +.. default-role:: code + +FiftyOne integrates naturally with your favorite model training and inference +frameworks, enabling you to easily visualize and analyze your models' results +in FiftyOne. Click on the cards below to see how! + +.. Integrations cards section ----------------------------------------------------- + +.. raw:: html + +
+ +
+ +
+ +
+
+ +.. Add tutorial cards below + +.. customcarditem:: + :header: Ultralytics + :description: Load, fine-tune, and run inference with Ultralytics models on your FiftyOne datasets with just a few lines of code. + :link: ultralytics.html + :image: ../../_static/images/integrations/ultralytics.jpg + :tags: Model-Training,Model-Evaluation + +.. customcarditem:: + :header: PyTorch Hub + :description: Did you know? You can load any model from the PyTorch Hub and run inference on your FiftyOne datasets with just a few lines of code. + :link: pytorch_hub.html + :image: ../../_static/images/integrations/pytorch.png + :tags: Model-Zoo,Model-Evaluation + +.. customcarditem:: + :header: Lightning Flash + :description: Train Flash models on FiftyOne datasets and use the FiftyOne App to visualize and improve your Flash models, all with just a few lines of code. + :link: lightning_flash.html + :image: ../../_static/images/integrations/lightning_flash.png + :tags: Model-Training,Model-Evaluation + +.. End of integrations cards + +.. raw:: html + +
+ + + +
+ +
+ +.. End integrations cards section ------------------------------------------------- + +.. toctree:: + :maxdepth: 1 + :hidden: + + Lightning Flash + PyTorch Hub + Ultralytics + + \ No newline at end of file diff --git a/docs/source/integrations/lightning_flash.rst b/docs/source/integrations/models/lightning_flash.rst similarity index 100% rename from docs/source/integrations/lightning_flash.rst rename to docs/source/integrations/models/lightning_flash.rst diff --git a/docs/source/integrations/pytorch_hub.rst b/docs/source/integrations/models/pytorch_hub.rst similarity index 100% rename from docs/source/integrations/pytorch_hub.rst rename to docs/source/integrations/models/pytorch_hub.rst diff --git a/docs/source/integrations/ultralytics.rst b/docs/source/integrations/models/ultralytics.rst similarity index 100% rename from docs/source/integrations/ultralytics.rst rename to docs/source/integrations/models/ultralytics.rst diff --git a/docs/source/integrations/vector_search/index.rst b/docs/source/integrations/vector_search/index.rst new file mode 100644 index 0000000000..228e699a45 --- /dev/null +++ b/docs/source/integrations/vector_search/index.rst @@ -0,0 +1,93 @@ + +.. _vector-search-integrations: + +FiftyOne Vector Search Integrations +=================================== + +.. default-role:: code + +FiftyOne integrates naturally with vector search engines to enable you to +quickly and easily search your datasets for similar images, objects, and more. +Click on the cards below to see how! + +.. Integrations cards section ----------------------------------------------------- + +.. raw:: html + +
+ +
+ +
+ +
+
+ +.. Add tutorial cards below + +.. customcarditem:: + :header: Qdrant + :description: Use our Qdrant integration to enable vector search and query your FiftyOne datasets at scale. + :link: qdrant.html + :image: ../../_static/images/integrations/qdrant.png + :tags: Brain,Embeddings,Filtering + +.. customcarditem:: + :header: Redis + :description: Use our Redis vector search integration to index your FiftyOne datasets and perform embeddings queries at scale. + :link: redis.html + :image: ../../_static/images/integrations/redis.jpg + :tags: Brain,Embeddings,Filtering + +.. customcarditem:: + :header: Pinecone + :description: Use our Pinecone integration to index your FiftyOne datasets and perform embeddings queries at scale. + :link: pinecone.html + :image: ../../_static/images/integrations/pinecone.png + :tags: Brain,Embeddings,Filtering + +.. customcarditem:: + :header: MongoDB + :description: Use our MongoDB vector search integration to index your FiftyOne datasets and perform embeddings queries at scale. + :link: mongodb.html + :image: ../../_static/images/integrations/mongodb.jpg + :tags: Brain,Embeddings,Filtering + +.. customcarditem:: + :header: Milvus + :description: Use our Milvus integration to index your FiftyOne datasets and perform embeddings queries at scale. + :link: milvus.html + :image: ../../_static/images/integrations/milvus.png + :tags: Brain,Embeddings,Filtering + +.. customcarditem:: + :header: LanceDB + :description: Use our LancedDB integration to index your datasets and perform embeddings queries at scale without the need for a cloud service. + :link: lancedb.html + :image: ../../_static/images/integrations/lancedb.png + :tags: Brain,Embeddings,Filtering + +.. End of integrations cards + +.. raw:: html + +
+ + + +
+ +
+ +.. End integrations cards section ------------------------------------------------- + +.. toctree:: + :maxdepth: 1 + :hidden: + + LanceDB + Milvus + MongoDB + Pinecone + Qdrant + Redis \ No newline at end of file diff --git a/docs/source/integrations/lancedb.rst b/docs/source/integrations/vector_search/lancedb.rst similarity index 100% rename from docs/source/integrations/lancedb.rst rename to docs/source/integrations/vector_search/lancedb.rst diff --git a/docs/source/integrations/milvus.rst b/docs/source/integrations/vector_search/milvus.rst similarity index 100% rename from docs/source/integrations/milvus.rst rename to docs/source/integrations/vector_search/milvus.rst diff --git a/docs/source/integrations/mongodb.rst b/docs/source/integrations/vector_search/mongodb.rst similarity index 100% rename from docs/source/integrations/mongodb.rst rename to docs/source/integrations/vector_search/mongodb.rst diff --git a/docs/source/integrations/pinecone.rst b/docs/source/integrations/vector_search/pinecone.rst similarity index 100% rename from docs/source/integrations/pinecone.rst rename to docs/source/integrations/vector_search/pinecone.rst diff --git a/docs/source/integrations/qdrant.rst b/docs/source/integrations/vector_search/qdrant.rst similarity index 100% rename from docs/source/integrations/qdrant.rst rename to docs/source/integrations/vector_search/qdrant.rst diff --git a/docs/source/integrations/redis.rst b/docs/source/integrations/vector_search/redis.rst similarity index 100% rename from docs/source/integrations/redis.rst rename to docs/source/integrations/vector_search/redis.rst