- ray.experimental.state.api.summarize_objects(address: Optional[str] = None, timeout: int = 30, raise_on_missing_output: bool = True, _explain: bool = False) Dict [source]#
Summarize the objects in cluster.
address – Ray bootstrap address, could be
localhost:6379. If None, it will be resolved automatically from an initialized ray.
timeout – Max timeout for requests made when getting the states.
raise_on_missing_output – When True, exceptions will be raised if there is missing data due to truncation/data source unavailable.
_explain – Print the API information such as API latency or failed query information.
RayStateApiExceptionif the CLI failed to query the data.