You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: draft/_sources/design_topics/device_support.rst.txt
+6-6Lines changed: 6 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -77,14 +77,14 @@ rather than hard requirements:
77
77
- Respect explicit device assignment (i.e. if the input to the ``device=`` keyword is not ``None``, guarantee that the array is created on the given device, and raise an exception otherwise).
78
78
- Preserve device assignment as much as possible (e.g. output arrays from a function are expected to be on the same device as input arrays to the function).
79
79
- Raise an exception if an operation involves arrays on different devices (i.e. avoid implicit data transfer between devices).
80
+
- When a function accepts a mix of arrays and Python scalars, the scalars should inherit the device of the arrays, much like what happens with :ref:`type-promotion`.
80
81
- Use a default for ``device=None`` which is consistent between functions within the same library.
81
-
- If a library has multiple ways of controlling device placement, the most explicit method should have the highest priority. For example:
82
+
- If a library has multiple ways of controlling device placement, the most explicit method should have the highest priority:
82
83
83
-
1. If ``device=`` keyword is specified, that always takes precedence
84
-
85
-
2. If ``device=None``, then use the setting from a context manager, if set.
86
-
87
-
3. If no context manager was used, then use the global default device/strategy
84
+
1. If the ``device=`` keyword is specified, that always takes precedence;
85
+
2. If ``device=None`` or the function does not accept a ``device`` parameter, then use the device of the input array(s), if any;
86
+
3. If there are no input arrays, then use the setting from a context manager, if any;
87
+
4. If no context manager was used, then use the global default device/strategy.
<li><p>Respect explicit device assignment (i.e. if the input to the <codeclass="docutils literal notranslate"><spanclass="pre">device=</span></code> keyword is not <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>, guarantee that the array is created on the given device, and raise an exception otherwise).</p></li>
504
504
<li><p>Preserve device assignment as much as possible (e.g. output arrays from a function are expected to be on the same device as input arrays to the function).</p></li>
505
505
<li><p>Raise an exception if an operation involves arrays on different devices (i.e. avoid implicit data transfer between devices).</p></li>
506
+
<li><p>When a function accepts a mix of arrays and Python scalars, the scalars should inherit the device of the arrays, much like what happens with <aclass="reference internal" href="../API_specification/type_promotion.html#type-promotion"><spanclass="std std-ref">Type Promotion Rules</span></a>.</p></li>
506
507
<li><p>Use a default for <codeclass="docutils literal notranslate"><spanclass="pre">device=None</span></code> which is consistent between functions within the same library.</p></li>
507
-
<li><p>If a library has multiple ways of controlling device placement, the most explicit method should have the highest priority. For example:</p>
508
+
<li><p>If a library has multiple ways of controlling device placement, the most explicit method should have the highest priority:</p>
508
509
<olclass="arabic simple">
509
-
<li><p>If <codeclass="docutils literal notranslate"><spanclass="pre">device=</span></code> keyword is specified, that always takes precedence</p></li>
510
-
<li><p>If <codeclass="docutils literal notranslate"><spanclass="pre">device=None</span></code>, then use the setting from a context manager, if set.</p></li>
511
-
<li><p>If no context manager was used, then use the global default device/strategy</p></li>
510
+
<li><p>If the <codeclass="docutils literal notranslate"><spanclass="pre">device=</span></code> keyword is specified, that always takes precedence;</p></li>
511
+
<li><p>If <codeclass="docutils literal notranslate"><spanclass="pre">device=None</span></code> or the function does not accept a <codeclass="docutils literal notranslate"><spanclass="pre">device</span></code> parameter, then use the device of the input array(s), if any;</p></li>
512
+
<li><p>If there are no input arrays, then use the setting from a context manager, if any;</p></li>
513
+
<li><p>If no context manager was used, then use the global default device/strategy.</p></li>
0 commit comments