diff --git a/doc/source/_toc.yml b/doc/source/_toc.yml index b26ff2da4cb5c..d948399f5aa8e 100644 --- a/doc/source/_toc.yml +++ b/doc/source/_toc.yml @@ -96,7 +96,7 @@ parts: - file: data/getting-started - file: data/key-concepts - file: data/user-guide - - file: data/examples + - file: data/examples/index - file: data/faq - file: data/api/api diff --git a/doc/source/conf.py b/doc/source/conf.py index 185aaad9b6380..4ae357e1c5360 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -188,14 +188,6 @@ "ray-references/api/ray-observability/state/doc/ray.*", "ray-observability/reference/doc/ray.*", "cluster/running-applications/doc/ray.*", - "data/examples/batch_inference_object_detection.ipynb", - "data/examples/batch_training.ipynb", - "data/examples/custom-datasource.rst", - "data/examples/huggingface_vit_batch_prediction.ipynb", - "data/examples/nyc_taxi_basic_processing.ipynb", - "data/examples/ocr_example.ipynb", - "data/examples/pytorch_resnet_batch_prediction.ipynb", - "data/examples/random-access.rst", "ray-core/runtime_env_auth.md", ] diff --git a/doc/source/data/data_examples.rst b/doc/source/data/examples/index.rst similarity index 67% rename from doc/source/data/data_examples.rst rename to doc/source/data/examples/index.rst index 0915f85ae50bb..3a7163e5de59b 100644 --- a/doc/source/data/data_examples.rst +++ b/doc/source/data/examples/index.rst @@ -4,6 +4,23 @@ Ray Data Examples ================= +.. + Include all examples in a hidden toctree so Sphinx build does not complain. + +.. toctree:: + :hidden: + + huggingface_vit_batch_prediction + pytorch_resnet_batch_prediction + batch_inference_object_detection + nyc_taxi_basic_processing + batch_training + ocr_example + random-access + custom-datasource + + + .. tip:: Check out the Datasets :ref:`User Guide ` to learn more about Dataset features in-depth. @@ -21,21 +38,21 @@ Computer Vision .. grid-item-card:: - .. button-ref:: examples/huggingface_vit_batch_prediction + .. button-ref:: huggingface_vit_batch_prediction Image Classification Batch Inference with Huggingface Vision Transformer .. grid-item-card:: - .. button-ref:: examples/pytorch_resnet_batch_prediction + .. button-ref:: pytorch_resnet_batch_prediction Image Classification Batch Inference with PyTorch ResNet18 .. grid-item-card:: - .. button-ref:: examples/batch_inference_object_detection + .. button-ref:: batch_inference_object_detection Object Detection Batch Inference with PyTorch FasterRCNN_ResNet50 @@ -49,19 +66,19 @@ Simple Data Processing .. grid-item-card:: - .. button-ref:: examples/nyc_taxi_basic_processing + .. button-ref:: nyc_taxi_basic_processing Processing the NYC taxi dataset .. grid-item-card:: - .. button-ref:: examples/batch_training + .. button-ref:: batch_training Batch Training with Ray Data .. grid-item-card:: - .. button-ref:: examples/ocr_example + .. button-ref:: ocr_example Scaling OCR with Ray Data @@ -77,12 +94,12 @@ Other Examples .. grid-item-card:: - .. button-ref:: examples/random-access + .. button-ref:: random-access Random Data Access (Experimental) .. grid-item-card:: - .. button-ref:: examples/custom-datasource + .. button-ref:: custom-datasource Implementing a Custom Datasource