ray.experimental.state.api.get_placement_group#

ray.experimental.state.api.get_placement_group(id: str, address: Optional[str] = None, timeout: int = 30, _explain: bool = False) → Optional[Dict][source]#

Get a placement group by id.

Parameters

  • id – Id of the placement group

  • address – Ray bootstrap address, could be auto, localhost:6379. If None, it will be resolved automatically from an initialized ray.

  • timeout – Max timeout value for the state APIs requests made.

  • _explain – Print the API information such as API latency or failed query information.

Returns

None if actor not found, or dictionarified PlacementGroupState.

Raises

Exceptions – RayStateApiException if the CLI failed to query the data.