Doc: redis memory management / automatic flushing. #2344
Conversation
| @@ -0,0 +1,103 @@ | |||
| Redis Memory Management (EXPERIMENTAL) | |||
| ============================================== | |||
There was a problem hiding this comment.
the line of ==== should have the same length as the title (this applies in other places as well)
There was a problem hiding this comment.
Done, fascinating...
| Redis Memory Management (EXPERIMENTAL) | ||
| ============================================== | ||
|
|
||
| Ray stores metadata associated to tasks and objects in one or more Redis |
| ============================================== | ||
|
|
||
| Ray stores metadata associated to tasks and objects in one or more Redis | ||
| servers, as described in :doc:`internals-overview`. Applications that are |
There was a problem hiding this comment.
This link doesn't seem to work. Maybe just use an absolute path to the URL.
There was a problem hiding this comment.
It does work in html. It does not work in raw .rst I think. Also it's the first recommended method when I googled how to link to another doc/section. Lastly it's used in for instance https://github.com/ray-project/ray/blob/master/doc/source/tune.rst as well.
There was a problem hiding this comment.
I don't see anything like this in https://github.com/ray-project/ray/blob/master/doc/source/tune.rst. Can you link to the relevant line?
| ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | ||
|
|
||
| First, follow `instructions to build Ray from source | ||
| <installation.html#building-ray-from-source>`__ to install prerequisites. After |
There was a problem hiding this comment.
This link doesn't seem to work. Maybe just use an absolute path to the URL.
There was a problem hiding this comment.
See my other comment?
There was a problem hiding this comment.
Ok, I see this pattern in the tune documentation.
|
|
||
| .. code-block:: bash | ||
|
|
||
| env RAY_USE_NEW_GCS=on RAY_USE_XRAY=1 pip install -e . --verbose |
There was a problem hiding this comment.
The env shouldn't be necessary, I think. Also, RAY_USE_XRAY=1 won't have any effect.
There was a problem hiding this comment.
Good catch, thanks!
|
|
||
| git clone https://github.com/ray-project/ray.git | ||
| cd ray/python | ||
| pip install -e . --verbose # Add --user if you see a permission denied error. |
There was a problem hiding this comment.
Why include this line? You don't actually want people to run this line, right? You want people to run the line below.
There was a problem hiding this comment.
Done, good call
| export RAY_USE_XRAY=1 | ||
| python my_ray_script.py # Or launch python/ipython. | ||
|
|
||
| Flush Policy |
| -------------------------------------- | ||
|
|
||
| There are three `user-configurable parameters | ||
| <https://github.com/ray-project/ray/blob/master/python/ray/experimental/gcs_flush_policy.py#L31>`_ |
There was a problem hiding this comment.
Use a permanent link because this will break if we modify that file.
|
Test PASSed. |
|
Test PASSed. |
| ====================================== | ||
|
|
||
| Ray stores metadata associated with tasks and objects in one or more Redis | ||
| servers, as described in :doc:`internals-overview`. Applications that are |
There was a problem hiding this comment.
Ok, I just built the documentation locally and this seems to work. However, it seems like we're using two different link styles to accomplish the same thing.
Here we have
:doc:`internals-overview`
and below we have
<installation.html#building-ray-from-source>`__
Why not just stick with one style? Or am I missing something?
There was a problem hiding this comment.
Changed to the same style now
|
Test PASSed. |
|
Test PASSed. |
No description provided.