From 7718af2d29a830535c0cc07b2f6c0bc7e968815c Mon Sep 17 00:00:00 2001 From: Amog Kamsetty Date: Thu, 8 Jun 2023 14:48:42 -0700 Subject: [PATCH] [Data] [Docs] Cleanup Examples section (#36124) Removes images from the gallery, since some of them are not very relevant (for example the taxi image doesn't provide much value). Make the Examples page non collapsable so it's not overloaded with many examples --------- Signed-off-by: amogkam --- doc/source/_toc.yml | 13 +------ .../data/{examples/index.rst => examples.rst} | 36 +++++++------------ 2 files changed, 14 insertions(+), 35 deletions(-) rename doc/source/data/{examples/index.rst => examples.rst} (60%) diff --git a/doc/source/_toc.yml b/doc/source/_toc.yml index 592e8fe0fcb43..b26ff2da4cb5c 100644 --- a/doc/source/_toc.yml +++ b/doc/source/_toc.yml @@ -96,18 +96,7 @@ parts: - file: data/getting-started - file: data/key-concepts - file: data/user-guide - - file: data/examples/index - sections: - - file: data/examples/nyc_taxi_basic_processing - title: Processing the NYC taxi dataset - - file: data/examples/batch_training - title: Batch Training with Ray Data - - file: data/examples/ocr_example - title: Scaling OCR with Ray Data - - file: data/examples/random-access - - file: data/examples/batch_inference_object_detection - title: Object Detection Batch Inference with PyTorch - - file: data/examples/custom-datasource + - file: data/examples - file: data/faq - file: data/api/api diff --git a/doc/source/data/examples/index.rst b/doc/source/data/examples.rst similarity index 60% rename from doc/source/data/examples/index.rst rename to doc/source/data/examples.rst index 73eea8d01eb72..0915f85ae50bb 100644 --- a/doc/source/data/examples/index.rst +++ b/doc/source/data/examples.rst @@ -1,8 +1,8 @@ .. _data-examples-ref: -======== -Examples -======== +================= +Ray Data Examples +================= .. tip:: Check out the Datasets :ref:`User Guide ` to learn more about Dataset features in-depth. @@ -15,27 +15,27 @@ processing with Ray Data on tabular data, text (coming soon), and images. Computer Vision --------------- -.. grid:: 1 2 3 3 - :gutter: 2 +.. grid:: 1 2 2 3 + :gutter: 1 :class-container: container pb-4 .. grid-item-card:: - .. button-ref:: huggingface_vit_batch_prediction + .. button-ref:: examples/huggingface_vit_batch_prediction Image Classification Batch Inference with Huggingface Vision Transformer .. grid-item-card:: - .. button-ref:: pytorch_resnet_batch_prediction + .. button-ref:: examples/pytorch_resnet_batch_prediction Image Classification Batch Inference with PyTorch ResNet18 .. grid-item-card:: - .. button-ref:: batch_inference_object_detection + .. button-ref:: examples/batch_inference_object_detection Object Detection Batch Inference with PyTorch FasterRCNN_ResNet50 @@ -48,26 +48,20 @@ Simple Data Processing :class-container: container pb-4 .. grid-item-card:: - :img-top: /images/taxi.png - :class-img-top: pt-5 w-75 d-block mx-auto - .. button-ref:: nyc_taxi_basic_processing + .. button-ref:: examples/nyc_taxi_basic_processing Processing the NYC taxi dataset .. grid-item-card:: - :img-top: /images/taxi.png - :class-img-top: pt-5 w-75 d-block mx-auto - .. button-ref:: batch_training + .. button-ref:: examples/batch_training Batch Training with Ray Data .. grid-item-card:: - :img-top: /images/ocr.jpg - :class-img-top: pt-5 w-75 d-block mx-auto - .. button-ref:: ocr_example + .. button-ref:: examples/ocr_example Scaling OCR with Ray Data @@ -82,17 +76,13 @@ Other Examples :class-container: container pb-4 .. grid-item-card:: - :img-top: ../images/dataset-arch.svg - :class-img-top: pt-5 w-75 d-block mx-auto - .. button-ref:: random-access + .. button-ref:: examples/random-access Random Data Access (Experimental) .. grid-item-card:: - :img-top: ../images/MongoDB_Logo.svg - :class-img-top: pt-5 w-75 d-block mx-auto - .. button-ref:: custom-datasource + .. button-ref:: examples/custom-datasource Implementing a Custom Datasource