diff --git a/.buildkite/lint.rayci.yml b/.buildkite/lint.rayci.yml index 86c420d712d60..4928799a856ea 100644 --- a/.buildkite/lint.rayci.yml +++ b/.buildkite/lint.rayci.yml @@ -32,6 +32,7 @@ steps: - ./ci/lint/lint.sh {{matrix}} matrix: - api_annotations + - api_policy_check core - api_policy_check serve - api_policy_check data diff --git a/ci/ray_ci/doc/cmd_check_api_discrepancy.py b/ci/ray_ci/doc/cmd_check_api_discrepancy.py index 5e0d09dfaef71..86847c70a8875 100644 --- a/ci/ray_ci/doc/cmd_check_api_discrepancy.py +++ b/ci/ray_ci/doc/cmd_check_api_discrepancy.py @@ -23,6 +23,25 @@ "head_doc_file": "doc/source/serve/api/index.md", "white_list_apis": {}, }, + "core": { + "head_modules": {"ray"}, + "head_doc_file": "doc/source/ray-core/api/index.rst", + "white_list_apis": { + # These APIs will be documented in near future + "ray.util.scheduling_strategies.DoesNotExist", + "ray.util.scheduling_strategies.Exists", + "ray.util.scheduling_strategies.NodeLabelSchedulingStrategy", + "ray.util.scheduling_strategies.In", + "ray.util.scheduling_strategies.NotIn", + # TODO(jjyao): document or deprecate these APIs + "ray.experimental.compiled_dag_ref.CompiledDAGFuture", + "ray.experimental.compiled_dag_ref.CompiledDAGRef", + "ray.cross_language.cpp_actor_class", + "ray.cross_language.cpp_function", + "ray.client_builder.ClientContext", + "ray.remote_function.RemoteFunction", + }, + }, } diff --git a/doc/source/ray-core/api/exceptions.rst b/doc/source/ray-core/api/exceptions.rst index 3f3e52ca1c33a..b7b2e85d2aeb8 100644 --- a/doc/source/ray-core/api/exceptions.rst +++ b/doc/source/ray-core/api/exceptions.rst @@ -33,6 +33,7 @@ Exceptions ray.exceptions.ObjectReconstructionFailedMaxAttemptsExceededError ray.exceptions.ObjectReconstructionFailedLineageEvictedError ray.exceptions.RayChannelError + ray.exceptions.RayChannelTimeoutError ray.exceptions.RuntimeEnvSetupError ray.exceptions.CrossLanguageError ray.exceptions.RaySystemError