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.

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

[rllib] annotate public vs developer vs private APIs #3757

Closed
ericl opened this issue Jan 12, 2019 · 0 comments
Closed

[rllib] annotate public vs developer vs private APIs #3757

ericl opened this issue Jan 12, 2019 · 0 comments
Assignees

Comments

@ericl
Copy link
Contributor

ericl commented Jan 12, 2019

Describe the problem

Based on user feedback I got, it would be helpful to annotate methods to describe their API stability.

For example, @PublicAPI could be used for very stable APIs (e.g., model), which have basically never been broken. @DeveloperAPI could be used for best-effort stable internal APIs that are exposed for custom algorithms, and no annotation would mean the API is subject to change.
We could also have @Experimental for public APIs that aren't quite ready for commitment to stability yet.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant