load("@py_deps_py310//:requirements.bzl", ci_require = "requirement") load("@rules_python//python:defs.bzl", "py_test") load("//bazel:python.bzl", "doctest", "doctest_each", "py_test_run_all_notebooks", "py_test_run_all_subdirectory") exports_files(["test_myst_doc.py"]) # -------------------------------------------------------------------- # Tests from the doc directory. # Please keep these sorted alphabetically, but start with the # root directory. # -------------------------------------------------------------------- py_test( name = "highly_parallel", size = "medium", srcs = ["test_myst_doc.py"], args = [ "--path", "doc/source/ray-core/examples/highly_parallel.ipynb", ], data = ["//doc/source/ray-core/examples:core_examples"], main = "test_myst_doc.py", tags = [ "exclusive", "highly_parallel", "team:ml", ], ) py_test( name = "plot_hyperparameter", size = "small", srcs = ["test_myst_doc.py"], args = [ "--path", "doc/source/ray-core/examples/plot_hyperparameter.ipynb", ], data = ["//doc/source/ray-core/examples:core_examples"], main = "test_myst_doc.py", tags = [ "exclusive", "team:ml", ], ) py_test( name = "batch_prediction", size = "medium", srcs = ["test_myst_doc.py"], args = [ "--path", "doc/source/ray-core/examples/batch_prediction.ipynb", ], data = ["//doc/source/ray-core/examples:core_examples"], main = "test_myst_doc.py", tags = [ "exclusive", "team:ml", ], ) py_test( name = "plot_parameter_server", size = "medium", srcs = ["test_myst_doc.py"], args = [ "--path", "doc/source/ray-core/examples/plot_parameter_server.ipynb", ], data = ["//doc/source/ray-core/examples:core_examples"], main = "test_myst_doc.py", tags = [ "exclusive", "team:ml", ], ) py_test( name = "plot_pong_example", size = "large", srcs = ["test_myst_doc.py"], args = [ "--path", "doc/source/ray-core/examples/plot_pong_example.ipynb", ], data = ["//doc/source/ray-core/examples:core_examples"], main = "test_myst_doc.py", tags = [ "exclusive", "team:ml", ], ) py_test( name = "gentle_walkthrough", size = "medium", srcs = ["test_myst_doc.py"], args = [ "--path", "doc/source/ray-core/examples/gentle_walkthrough.ipynb", ], data = ["//doc/source/ray-core/examples:core_examples"], main = "test_myst_doc.py", tags = [ "exclusive", "team:core", ], ) py_test( name = "map_reduce", size = "medium", srcs = ["test_myst_doc.py"], args = [ "--path", "doc/source/ray-core/examples/map_reduce.ipynb", ], data = ["//doc/source/ray-core/examples:core_examples"], main = "test_myst_doc.py", tags = [ "exclusive", "team:core", ], ) py_test( name = "web_crawler", size = "medium", srcs = ["test_myst_doc.py"], args = [ "--path", "doc/source/ray-core/examples/web_crawler.ipynb", ], data = ["//doc/source/ray-core/examples:core_examples"], main = "test_myst_doc.py", tags = [ "exclusive", "team:core", ], ) # -------------------------------------------------------------------- # Test all doc/source/ray-observability/doc_code code included in rst/md files. # -------------------------------------------------------------------- py_test_run_all_subdirectory( size = "medium", include = ["source/ray-observability/doc_code/*.py"], exclude = ["source/ray-observability/doc_code/ray-distributed-debugger.py"], extra_srcs = [], tags = [ "exclusive", "team:core", ], ) # -------------------------------------------------------------------- # Test all doc/source/ray-core/doc_code code included in rst/md files. # -------------------------------------------------------------------- py_test( name = "doc_code_runtime_env_example", size = "small", srcs = ["source/ray-core/doc_code/runtime_env_example.py"], main = "source/ray-core/doc_code/runtime_env_example.py", tags = [ "exclusive", "post_wheel_build", "custom_setup", "team:core", ], ) py_test( name = "doc_code_ray_oom_prevention", size = "medium", srcs = ["source/ray-core/doc_code/ray_oom_prevention.py"], main = "source/ray-core/doc_code/ray_oom_prevention.py", tags = [ "exclusive", "mem_pressure", "custom_setup", "team:core", ], ) py_test( name = "doc_code_cgraph_profiling", size = "small", srcs = ["source/ray-core/doc_code/cgraph_profiling.py"], main = "source/ray-core/doc_code/cgraph_profiling.py", tags = [ "exclusive", "multi_gpu", "custom_setup", "team:core", ], ) py_test( name = "doc_code_cgraph_nccl", size = "small", srcs = ["source/ray-core/doc_code/cgraph_nccl.py"], main = "source/ray-core/doc_code/cgraph_nccl.py", tags = [ "exclusive", "multi_gpu", "custom_setup", "team:core", ], ) py_test( name = "doc_code_cgraph_overlap", size = "small", srcs = ["source/ray-core/doc_code/cgraph_overlap.py"], main = "source/ray-core/doc_code/cgraph_overlap.py", tags = [ "exclusive", "multi_gpu", "custom_setup", "team:core", ], ) py_test( name = "doc_code_direct_transport_gloo", size = "small", srcs = ["source/ray-core/doc_code/direct_transport_gloo.py"], main = "source/ray-core/doc_code/direct_transport_gloo.py", tags = [ "exclusive", "team:core", ], ) py_test( name = "doc_code_direct_transport_nccl", size = "small", srcs = ["source/ray-core/doc_code/direct_transport_nccl.py"], main = "source/ray-core/doc_code/direct_transport_nccl.py", tags = [ "exclusive", "multi_gpu", "custom_setup", "team:core", ], ) py_test( name = "doc_code_direct_transport_nixl", size = "small", srcs = ["source/ray-core/doc_code/direct_transport_nixl.py"], main = "source/ray-core/doc_code/direct_transport_nixl.py", tags = [ "exclusive", "multi_gpu", "custom_setup", "team:core", ], ) py_test_run_all_subdirectory( size = "medium", include = ["source/ray-core/doc_code/*.py"], exclude = [ "source/ray-core/doc_code/runtime_env_example.py", "source/ray-core/doc_code/cross_language.py", "source/ray-core/doc_code/ray_oom_prevention.py", "source/ray-core/doc_code/cgraph_profiling.py", "source/ray-core/doc_code/cgraph_nccl.py", "source/ray-core/doc_code/cgraph_overlap.py", # not testing this as it purposefully segfaults "source/ray-core/doc_code/cgraph_troubleshooting.py", "source/ray-core/doc_code/direct_transport_nccl.py", "source/ray-core/doc_code/direct_transport_nixl.py", ], extra_srcs = [], tags = [ "exclusive", "team:core", ], ) # -------------------------------------------------------------------- # Test all doc/source/serve/doc_code code included in rst/md files. # -------------------------------------------------------------------- py_test_run_all_subdirectory( size = "medium", include = ["source/serve/doc_code/**/*.py"], exclude = [ "source/serve/doc_code/aws_neuron_core_inference_serve.py", "source/serve/doc_code/aws_neuron_core_inference_serve_stable_diffusion.py", "source/serve/doc_code/intel_gaudi_inference_serve.py", "source/serve/doc_code/intel_gaudi_inference_serve_deepspeed.py", "source/serve/doc_code/intel_gaudi_inference_client.py", "source/serve/doc_code/distilbert.py", "source/serve/doc_code/stable_diffusion.py", "source/serve/doc_code/object_detection.py", "source/serve/doc_code/vllm_example.py", "source/serve/doc_code/cross_node_parallelism_example.py", "source/serve/doc_code/llm/llm_yaml_config_example.py", "source/serve/doc_code/llm/qwen_example.py", "source/serve/doc_code/capacity_queue_request_router_app.py", ], extra_srcs = [], tags = [ "exclusive", "team:serve", ], ) py_test_run_all_subdirectory( size = "medium", include = [ "source/serve/doc_code/distilbert.py", "source/serve/doc_code/stable_diffusion.py", "source/serve/doc_code/object_detection.py", ], env = {"RAY_SERVE_PROXY_READY_CHECK_TIMEOUT_S": "60"}, exclude = [ "source/serve/doc_code/aws_neuron_core_inference_serve.py", "source/serve/doc_code/aws_neuron_core_inference_serve_stable_diffusion.py", "source/serve/doc_code/intel_gaudi_inference_serve.py", "source/serve/doc_code/intel_gaudi_inference_serve_deepspeed.py", "source/serve/doc_code/intel_gaudi_inference_client.py", ], extra_srcs = [], tags = [ "exclusive", "gpu", "team:serve", ], ) # -------------------------------------------------------------------- # Test all doc/source/llm/doc_code/serve code included in rst/md files. # -------------------------------------------------------------------- filegroup( name = "serve_llm_examples", srcs = glob(["source/llm/doc_code/serve/**/*.py"]), visibility = ["//doc:__subpackages__"], ) # GPU Tests (standard GPU tests) py_test_run_all_subdirectory( size = "large", include = ["source/llm/doc_code/serve/**/*.py"], exclude = [ "source/llm/doc_code/serve/direct_streaming/**/*.py", "source/llm/doc_code/serve/multi_gpu/**/*.py", "source/llm/doc_code/serve/sglang/**/*.py", # custom_vllm runs in its own direct-streaming target below. "source/llm/doc_code/serve/custom_vllm/**/*.py", ], extra_srcs = [], data = ["source/llm/doc_code/serve/qwen/llm_config_example.yaml"], tags = [ "exclusive", "gpu", "team:llm", ], ) # Custom vLLM model (Qwen3 reward model) GPU tests py_test_run_all_subdirectory( size = "large", include = ["source/llm/doc_code/serve/custom_vllm/**/*.py"], exclude = [ "source/llm/doc_code/serve/custom_vllm/qwen3_reward_plugin/**/*.py", # setup.py packages the plugin; it is not a runnable example. "source/llm/doc_code/serve/custom_vllm/setup.py", ], extra_srcs = [], data = ["source/llm/doc_code/serve/custom_vllm/custom_vllm_config.yaml"], env = { "RAY_SERVE_LLM_ENABLE_DIRECT_STREAMING": "1", "RAY_SERVE_ENABLE_HA_PROXY": "1", }, tags = [ "exclusive", "gpu", "custom_vllm_plugin", "team:llm", ], ) # Direct streaming GPU Tests. Isolated into their own target so they run with # the direct streaming flags set, which exercises the real direct streaming # path. The flags can't go on the shared target above because they would force # every other serve example into direct streaming mode, and build_openai_app # rejects multi-config apps (such as the qwen example) under direct streaming. py_test_run_all_subdirectory( size = "large", include = ["source/llm/doc_code/serve/direct_streaming/**/*.py"], exclude = [], extra_srcs = [], data = ["source/llm/doc_code/serve/direct_streaming/direct_streaming_config.yaml"], env = { "RAY_SERVE_LLM_ENABLE_DIRECT_STREAMING": "1", # Direct streaming wires LLMRouter as the ingress_request_router, # which build_app.py rejects unless HAProxy is enabled. "RAY_SERVE_ENABLE_HA_PROXY": "1", }, tags = [ "exclusive", "gpu", "team:llm", ], ) # Multi-GPU Tests (4+ GPUs) py_test_run_all_subdirectory( size = "large", include = ["source/llm/doc_code/serve/multi_gpu/**/*.py"], exclude = [], extra_srcs = [], tags = [ "exclusive", "gpu", "multi_gpu_4", "team:llm", ], ) # -------------------------------------------------------------------- # Test all doc/source/data/doc_code/working-with-llms code included in rst/md files. # -------------------------------------------------------------------- filegroup( name = "data_llm_examples", srcs = glob(["source/data/doc_code/working-with-llms/**/*.py"]), visibility = ["//doc:__subpackages__"], ) # GPU Tests py_test_run_all_subdirectory( size = "large", include = ["source/data/doc_code/working-with-llms/**/*.py"], exclude = [], extra_srcs = [], tags = [ "exclusive", "gpu", "team:llm" ], ) # -------------------------------------------------------------------- # Test all doc/source/tune/doc_code code included in rst/md files. # -------------------------------------------------------------------- py_test_run_all_subdirectory( size = "medium", include = ["source/tune/doc_code/*.py"], exclude = [], extra_srcs = [], tags = [ "exclusive", "team:ml", ], env = {"RAY_TRAIN_V2_ENABLED": "1"}, ) # -------------------------------------------------------------------- # Test all doc/source/rllib/doc_code code included in rst/md files. # -------------------------------------------------------------------- py_test_run_all_subdirectory( size = "medium", include = ["source/rllib/doc_code/*.py"], exclude = [], extra_srcs = [], tags = [ "exclusive", "team:rllib", ], ) # -------------------------------------------------------------------- # Test all doc/source/train/doc_code code included in rst/md files. # -------------------------------------------------------------------- py_test_run_all_subdirectory( size = "large", env = {"RAY_TRAIN_V2_ENABLED": "1"}, include = ["source/train/doc_code/*.py"], exclude = [ "source/train/doc_code/hvd_trainer.py", # CI do not have Horovod "source/train/doc_code/asynchronous_validation.py", # pseudocode snippets, not runnable ], extra_srcs = [], tags = [ "exclusive", "team:ml", ], ) # -------------------------------------------------------------------- # Test all doc/source/data/doc_code code included in rst/md files. # -------------------------------------------------------------------- py_test_run_all_subdirectory( size = "large", include = ["source/data/doc_code/*.py"], exclude = [], extra_srcs = [], tags = [ "exclusive", "team:data", ], ) # -------------------------------------------------------------------- # Test all doc/source/ray-more-libs/doc_code code included in rst/md files. # -------------------------------------------------------------------- py_test_run_all_subdirectory( size = "large", include = ["source/ray-more-libs/doc_code/dask_on_ray_*.py"], exclude = [], extra_srcs = [], tags = [ "dask", "custom_setup", "exclusive", "team:data", ], ) # -------------- # Run GPU tests # -------------- py_test( name = "pytorch_resnet_finetune", size = "large", srcs = ["test_myst_doc.py"], args = [ "--path", "doc/source/train/examples/pytorch/pytorch_resnet_finetune.ipynb", ], data = ["//doc/source/train/examples/pytorch:train_pytorch_examples"], main = "test_myst_doc.py", tags = [ "exclusive", "gpu", "ray_air", "team:ml", ], ) # -------------------------------------------------------------------- # Test all doc/external code # -------------------------------------------------------------------- # py_test_run_all_subdirectory( # size = "enormous", # include = ["external/*.py"], # exclude = ["external/test_hashes.py"], # extra_srcs = [], # tags = [ # "exclusive", # "external", # "team:ml", # ], # ) py_test( name = "test_external_hashes", srcs = ["external/test_hashes.py"], data = glob( ["external/*.py"], exclude = ["external/test_hashes.py"], ), exec_compatible_with = ["//bazel:py3"], main = "external/test_hashes.py", tags = ["team:ml"], deps = [ ci_require("pytest"), ci_require("bazel-runfiles"), ], ) # -------------------------------------------------------------------- # Tests code snippets in user guides. # -------------------------------------------------------------------- doctest( size = "large", files = glob( include = [ "source/**/*.md", "source/**/*.rst", ], exclude = [ "source/ray-contribute/getting-involved.md", "source/ray-contribute/testing-tips.md", "source/ray-contribute/writing-code-snippets.md", "source/ray-observability/user-guides/ray-tracing.rst", "source/ray-observability/user-guides/cli-sdk.rst", "source/templates/04_finetuning_llms_with_deepspeed/README.md", "source/ray-core/**/*.md", "source/ray-core/**/*.rst", "source/data/**/*.md", "source/data/**/*.rst", "source/rllib/**/*.md", "source/rllib/**/*.rst", "source/serve/**/*.md", "source/serve/**/*.rst", "source/train/**/*.md", "source/train/**/*.rst", "source/tune/**/*.md", "source/tune/**/*.rst", ], ), tags = ["team:none"], # NOTE(edoakes): the global glossary and some tutorials use Ray Data, # so we use its pytest plugin file (which is a superset of the default). pytest_plugin_file = "//python/ray/data:tests/doctest_pytest_plugin.py", ) doctest( name = "doctest[core]", size = "large", files = glob( include = [ "source/ray-core/**/*.md", "source/ray-core/**/*.rst", ], exclude = [ "source/ray-core/handling-dependencies.rst", # The `doc_code/` snippet for `nested-tasks.rst` is tested. "source/ray-core/tasks/nested-tasks.rst", ], ), tags = ["team:core"], ) doctest_each( files = glob( include = [ "source/data/**/*.md", "source/data/**/*.rst", ], exclude = [ # These tests run on GPU (see below). "source/data/batch_inference.rst", "source/data/transforming-data.rst", # These don't contain code snippets. "source/data/api/**/*.rst", ], ), pytest_plugin_file = "//python/ray/data:tests/doctest_pytest_plugin.py", tags = ["team:data"], # Adding to use keras 2 & tensorflow >= 2.16 (https://keras.io/getting_started) env = {"TF_USE_LEGACY_KERAS": "1"}, ) doctest( name = "doctest[data-gpu]", files = [ "source/data/batch_inference.rst", "source/data/transforming-data.rst", ], pytest_plugin_file = "//python/ray/data:tests/doctest_pytest_plugin.py", tags = ["team:data"], gpu = True, ) doctest( name = "doctest[rllib]", size = "large", data = ["//rllib:cartpole-v1_large"], files = glob( include = [ "source/rllib/**/*.md", "source/rllib/**/*.rst", ], exclude = [ "source/rllib/getting-started.rst", ], ), tags = ["team:rllib"], ) doctest( name = "doctest[rllib2]", size = "enormous", files = glob( include = [ "source/rllib/getting-started.rst", ], ), # TODO(elliot-barn): Re-enable once getting-started.rst doctest hang is fixed. tags = ["manual", "team:rllib"], ) doctest( name = "doctest[serve]", files = glob( include = [ "source/serve/**/*.md", "source/serve/**/*.rst", ], exclude = [ "source/serve/advanced-guides/inplace-updates.md", "source/serve/deploy-many-models/multi-app.md", "source/serve/production-guide/deploy-vm.md", "source/serve/production-guide/fault-tolerance.md", ], ), tags = ["team:serve"], ) doctest( name = "doctest[train]", # TODO: [V2] Migrate env = { "RAY_TRAIN_V2_ENABLED": "0", "TF_USE_LEGACY_KERAS": "1", }, files = glob( include = [ "source/train/**/*.md", "source/train/**/*.rst", ], exclude = [ # CI does not have Horovod installed. "source/train/horovod.rst", # These tests run on GPU (see below). "source/train/user-guides/data-loading-preprocessing.rst", "source/train/user-guides/using-accelerators.rst", ], ), tags = ["team:ml"], ) doctest( name = "doctest[train-gpu]", files = [ "source/train/user-guides/data-loading-preprocessing.rst", "source/train/user-guides/using-accelerators.rst", ], env = {"RAY_TRAIN_V2_ENABLED": "0"}, tags = ["team:ml"], gpu = True, ) doctest( name = "doctest[tune]", files = [ "source/tune/**/*.md", "source/tune/**/*.rst", ], tags = ["team:ml"], env = {"RAY_TRAIN_V2_ENABLED": "1"}, ) # -------------------------------------------------------------------- # Discover the Anyscale Jobs compute configs .yaml for release tests in CI # -------------------------------------------------------------------- # Comprehensive filegroup that aggregates all CI compute configs from across the docs. # This includes a general glob pattern + references to filegroups in existing child BUILD.bazel # Following the standard structure: doc/source//my_example/ci/{aws,gce}.yaml filegroup( name = "all_examples_ci_configs", srcs = glob([ "source/ray-overview/examples/**/ci/aws.yaml", "source/ray-overview/examples/**/ci/gce.yaml", "source/serve/tutorials/**/ci/aws.yaml", "source/serve/tutorials/**/ci/gce.yaml", ]) + [ "//doc/source/data/examples:data_examples_ci_configs", "//doc/source/tune/examples:tune_examples_ci_configs", "//doc/source/ray-core/examples:core_examples_ci_configs", "//doc/source/train/examples:train_examples_ci_configs", ], visibility = ["//release:__pkg__"], )