Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

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

Merged
merged 1 commit into from
Aug 1, 2024
Merged

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

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .buildkite/lint.rayci.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
19 changes: 19 additions & 0 deletions ci/ray_ci/doc/cmd_check_api_discrepancy.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@jjyao leave this to your team to decide when you have more time ;)

"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",
},
},
}


Expand Down
1 change: 1 addition & 0 deletions doc/source/ray-core/api/exceptions.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,7 @@ Exceptions
ray.exceptions.ObjectReconstructionFailedMaxAttemptsExceededError
ray.exceptions.ObjectReconstructionFailedLineageEvictedError
ray.exceptions.RayChannelError
ray.exceptions.RayChannelTimeoutError
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

i missed this in the previous PRs

ray.exceptions.RuntimeEnvSetupError
ray.exceptions.CrossLanguageError
ray.exceptions.RaySystemError
Expand Down
Loading