diff --git a/cirq-core/cirq/devices/grid_device_metadata.py b/cirq-core/cirq/devices/grid_device_metadata.py index 00da05e27a9..bb18951f0c2 100644 --- a/cirq-core/cirq/devices/grid_device_metadata.py +++ b/cirq-core/cirq/devices/grid_device_metadata.py @@ -139,7 +139,21 @@ def compilation_target_gatesets(self) -> Tuple['cirq.CompilationTargetGateset', @property def gate_durations(self) -> Optional[Dict['cirq.GateFamily', 'cirq.Duration']]: - """Get a dictionary mapping from gateset to duration for gates.""" + """Get a dictionary mapping from gate family to duration for gates. + + To look up the duration of a specific gate instance / gate type / operation which is part of + the device's gateset, you can search for its corresponding GateFamily. For example: + + >>> my_op = cirq.Z + >>> gate_durations = grid_device_metadata.gate_durations + >>> op_duration = None + >>> for gate_family in gate_durations: + ... if my_op in gate_family: + ... op_duration = gate_durations[gate_family] + ... + >>> print(op_duration) + 1 ns + """ return self._gate_durations def _value_equality_values_(self):