[doc][core] turn on api policy check for core

Signed-off-by: can <[email protected]>
ray-project · Jul 31, 2024 · c127e7b · c127e7b
1 parent dfa2cb7
commit c127e7b
Show file tree

Hide file tree

Showing 3 changed files with 21 additions and 0 deletions.
diff --git 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
@@ -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
@@ -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