Skip to content

Commit

Permalink
Fix docstrings.
Browse files Browse the repository at this point in the history
  • Loading branch information
Gamenot committed Feb 22, 2023
1 parent 6477482 commit 9163c63
Showing 1 changed file with 15 additions and 1 deletion.
16 changes: 15 additions & 1 deletion smarts/core/sensors.py
Original file line number Diff line number Diff line change
Expand Up @@ -145,6 +145,15 @@ def observe(
renderer,
bullet_client,
):
"""Generate observations
Args:
sim_frame (SimulationFrame): The simulation frame.
sim_local_constants (SimulationLocalConstants): Constraints defined by the local simulator.
agent_ids (Set[str]): The agents to run.
renderer (Renderer): The renderer to use.
bullet_client (Any): The bullet client. This parameter is likely to be removed.
"""
raise NotImplementedError()

def step(self, sim_frame, sensor_states):
Expand Down Expand Up @@ -205,7 +214,7 @@ def step(self, sim_frame, sensor_states):
class ParallelSensorResolver(SensorResolver):
"""This implementation of the sensor resolver completes observations in parallel."""

def __init__(self, process_count_override=None) -> None:
def __init__(self, process_count_override: int = None) -> None:
super().__init__()
self._logger = logging.getLogger("Sensors")
self._sim_local_constants: SimulationLocalConstants = None
Expand Down Expand Up @@ -362,6 +371,11 @@ def step(self, sim_frame, sensor_states):

@property
def process_count_override(self):
"""The number of processes this implementation should run.
Returns:
int: Number of processes.
"""
return self._process_count_override

@process_count_override.setter
Expand Down

0 comments on commit 9163c63

Please sign in to comment.