[State Observability] pre-alpha documentation #26560

rkooo567 · 2022-07-14T13:55:01Z

Adds

Documentation for state APIs
API reference

Related issue number

Checks

I've run scripts/format.sh to lint the changes in this PR.
I've included any doc changes needed for https://docs.ray.io/en/master/.
I've made sure the tests are passing. Note that there might be a few flaky tests, see the recent failures at https://flakey-tests.ray.io/
Testing Strategy
- Unit tests
- Release tests
- This PR is not tested :(

python/ray/experimental/state/custom_types.py

python/ray/scripts/scripts.py

python/ray/experimental/state/state_cli.py

python/ray/experimental/state/common.py

rickyyx

Could I see the generated docs hosted somewhere? Or I need to manually build the doc on this PR to see it?

dashboard/memory_utils.py

python/ray/experimental/state/custom_types.py

python/ray/experimental/state/common.py

rickyyx · 2022-07-14T17:46:13Z

python/ray/experimental/state/state_cli.py

+
+ - When the API queries more than 1 component, if some of them fail,
+ the API will return the partial result (with a suppressable warning).
+ - When the API returns too many entries (10K), the API


We probably want to embed constant values here or reference the exact consts or remember to change it once we figure out the fixed system upperbound for this.

Actually I originally tried embeding the constant, but f string docsting didn't work for some reasons. Let me retry..

python/ray/experimental/state/state_cli.py

python/ray/scripts/scripts.py

rkooo567 · 2022-07-14T22:31:43Z

@rickyyx you can see it from here! Looks like there's a bug..

rkooo567 · 2022-07-14T22:31:57Z

maybe because Literal is not available in the lower pytohn version. I will fix this

rkooo567 · 2022-07-21T15:52:34Z

The doc will be also added to this PR. will be ready by tomorrow

rkooo567 · 2022-07-22T16:50:30Z

@rickyyx @scv119 I also added a documentation here. Please take a look at https://ray--26560.org.readthedocs.build/en/26560/ray-observability/state/ray-state-api-reference.html and state-api.rst

python/ray/experimental/state/state_cli.py

doc/source/ray-observability/state/state-api.rst

rickyyx

This looks really great!

For the filterable and detail options, I wonder if we could embed the filterable/detail info into each column's doc, rather than have a separate section? The generated doc looks a bit verbose imo.

doc/source/ray-observability/state/state-api.rst

python/ray/experimental/state/custom_types.py

rkooo567

Addressed all comments. For Python APIs, I will leave it to @rickyyx to update!

Issue tracked: #26949

doc/source/ray-observability/state/state-api.rst

rkooo567 · 2022-07-25T02:55:20Z

cc @richardliaw can you take a look at this PR? I need approval from a code owner

edoakes

codeowner stamp

Adds Documentation for state APIs API reference Signed-off-by: klwuibm <[email protected]>

Adds Documentation for state APIs API reference Signed-off-by: Catch-Bull <[email protected]>

Adds Documentation for state APIs API reference Signed-off-by: Rohan138 <[email protected]>

Adds Documentation for state APIs API reference Signed-off-by: Frank Luan <[email protected]>

Adds Documentation for state APIs API reference Signed-off-by: Scott Graham <[email protected]>

Adds Documentation for state APIs API reference

Adds Documentation for state APIs API reference Signed-off-by: Stefan van der Kleij <[email protected]>

rkooo567 added 2 commits July 14, 2022 06:51

Completed.

8855b48

Add more description.

af664ee

rkooo567 requested review from maxpumperla, pcmoritz, richardliaw, edoakes, simon-mo and ericl as code owners July 14, 2022 13:55

rkooo567 assigned scv119 and rickyyx Jul 14, 2022

rkooo567 commented Jul 14, 2022

View reviewed changes

python/ray/experimental/state/custom_types.py Show resolved Hide resolved

scv119 reviewed Jul 14, 2022

View reviewed changes

python/ray/scripts/scripts.py Outdated Show resolved Hide resolved

python/ray/experimental/state/state_cli.py Show resolved Hide resolved

python/ray/experimental/state/common.py Show resolved Hide resolved

rickyyx approved these changes Jul 14, 2022

View reviewed changes

scv119 approved these changes Jul 18, 2022

View reviewed changes

rkooo567 added the @author-action-required The PR author is responsible for the next step. Remove tag to send back to the reviewer. label Jul 21, 2022

rkooo567 added 2 commits July 22, 2022 07:52

Merge branch 'master' into api-doc

4db3189

Finished writing a doc.

719684b

rkooo567 removed the @author-action-required The PR author is responsible for the next step. Remove tag to send back to the reviewer. label Jul 22, 2022

rkooo567 changed the title ~~[State Observability] pre-alpha API documentation~~ [State Observability] pre-alpha documentation Jul 22, 2022

rkooo567 commented Jul 22, 2022

View reviewed changes

python/ray/experimental/state/state_cli.py Show resolved Hide resolved

scv119 reviewed Jul 22, 2022

View reviewed changes

doc/source/ray-observability/state/state-api.rst Outdated Show resolved Hide resolved

scv119 reviewed Jul 22, 2022

View reviewed changes

doc/source/ray-observability/state/state-api.rst Outdated Show resolved Hide resolved

doc/source/ray-observability/state/state-api.rst Outdated Show resolved Hide resolved

rickyyx approved these changes Jul 22, 2022

View reviewed changes

Merge branch 'master' into api-doc

9d402ca

rkooo567 added the @author-action-required The PR author is responsible for the next step. Remove tag to send back to the reviewer. label Jul 24, 2022

rkooo567 commented Jul 24, 2022

View reviewed changes

rkooo567 added 4 commits July 23, 2022 23:17

Addressed all comments.

b5ef6b7

Fix an issue that literal type cannot be used with isinstance

8f10567

Merge branch 'master' into api-doc

68b0c45

Fix a broken test.

bca1cea

rkooo567 assigned richardliaw Jul 25, 2022

rickyyx removed the @author-action-required The PR author is responsible for the next step. Remove tag to send back to the reviewer. label Jul 25, 2022

Merge branch 'master' into api-doc

4aa8438

edoakes approved these changes Jul 25, 2022

View reviewed changes

Merge branch 'master' into api-doc

b0a20a3

rkooo567 merged commit 39b9c44 into ray-project:master Jul 26, 2022

klwuibm pushed a commit to yuanchi2807/ray that referenced this pull request Jul 27, 2022

[State Observability] pre-alpha documentation (ray-project#26560)

7ecd032

Adds Documentation for state APIs API reference Signed-off-by: klwuibm <[email protected]>

Catch-Bull pushed a commit to alipay/ant-ray that referenced this pull request Jul 27, 2022

[State Observability] pre-alpha documentation (ray-project#26560)

158c2d3

Adds Documentation for state APIs API reference Signed-off-by: Catch-Bull <[email protected]>

Rohan138 pushed a commit to Rohan138/ray that referenced this pull request Jul 28, 2022

[State Observability] pre-alpha documentation (ray-project#26560)

7e926ba

Adds Documentation for state APIs API reference Signed-off-by: Rohan138 <[email protected]>

franklsf95 pushed a commit to franklsf95/ray that referenced this pull request Aug 2, 2022

[State Observability] pre-alpha documentation (ray-project#26560)

9f91268

Adds Documentation for state APIs API reference Signed-off-by: Frank Luan <[email protected]>

gramhagen pushed a commit to gramhagen/ray that referenced this pull request Aug 15, 2022

[State Observability] pre-alpha documentation (ray-project#26560)

833e331

Adds Documentation for state APIs API reference Signed-off-by: Scott Graham <[email protected]>

gramhagen pushed a commit to gramhagen/ray that referenced this pull request Aug 15, 2022

[State Observability] pre-alpha documentation (ray-project#26560)

e3fc98a

Adds Documentation for state APIs API reference

Stefan-1313 pushed a commit to Stefan-1313/ray_mod that referenced this pull request Aug 18, 2022

[State Observability] pre-alpha documentation (ray-project#26560)

0d773f9

Adds Documentation for state APIs API reference Signed-off-by: Stefan van der Kleij <[email protected]>

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[State Observability] pre-alpha documentation #26560

[State Observability] pre-alpha documentation #26560

rkooo567 commented Jul 14, 2022 •

edited

Loading

rickyyx left a comment

rickyyx Jul 14, 2022

rkooo567 Jul 22, 2022

rkooo567 commented Jul 14, 2022

rkooo567 commented Jul 14, 2022

rkooo567 commented Jul 21, 2022

rkooo567 commented Jul 22, 2022 •

edited

Loading

rickyyx left a comment

rkooo567 left a comment •

edited by rickyyx

Loading

rkooo567 commented Jul 25, 2022

edoakes left a comment

[State Observability] pre-alpha documentation #26560

[State Observability] pre-alpha documentation #26560

Conversation

rkooo567 commented Jul 14, 2022 • edited Loading

Related issue number

Checks

rickyyx left a comment

Choose a reason for hiding this comment

rickyyx Jul 14, 2022

Choose a reason for hiding this comment

rkooo567 Jul 22, 2022

Choose a reason for hiding this comment

rkooo567 commented Jul 14, 2022

rkooo567 commented Jul 14, 2022

rkooo567 commented Jul 21, 2022

rkooo567 commented Jul 22, 2022 • edited Loading

rickyyx left a comment

Choose a reason for hiding this comment

rkooo567 left a comment • edited by rickyyx Loading

Choose a reason for hiding this comment

rkooo567 commented Jul 25, 2022

edoakes left a comment

Choose a reason for hiding this comment

rkooo567 commented Jul 14, 2022 •

edited

Loading

rkooo567 commented Jul 22, 2022 •

edited

Loading

rkooo567 left a comment •

edited by rickyyx

Loading