Skip to content

Commit 2ab8188

Browse files
authored
Add README for _common directory (#51335)
Signed-off-by: Edward Oakes <ed.nmi.oakes@gmail.com>
1 parent f9e2ab0 commit 2ab8188

File tree

1 file changed

+7
-0
lines changed

1 file changed

+7
-0
lines changed

python/ray/_common/README.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# Common Utilities Shared Across the Libraries
2+
3+
This directory contains logic shared across Ray Core and the native libraries.
4+
5+
- All dependencies by the libraries on non-public APIs in the repo should live here. Libraries should _not_ depend on `ray._private`.
6+
- Interfaces exposed in this directory should be treated similarly to a "developer API."
7+
- End users and external libraries not inside the Ray repo should not depend on any code in `ray._common` (the same as `ray._private`).

0 commit comments

Comments
 (0)