@@ -64,46 +64,50 @@ def set_array_api_strict_flags(
6464 This function is **not** part of the array API standard. It only exists
6565 in array-api-strict.
6666
67- - `api_version`: The version of the standard to use. Supported
68- versions are: ``{supported_versions}``. The default version number is
69- ``{default_version!r}``.
70-
71- Note that 2021.12 is supported, but currently gives the same thing as
72- 2022.12 (except that the fft extension will be disabled).
73-
74- 2023.12 support is experimental. Some features in 2023.12 may still be
75- missing, and it hasn't been fully tested.
76-
77- - `boolean_indexing`: Whether indexing by a boolean array is supported.
78- Note that although boolean array indexing does result in data-dependent
79- shapes, this flag is independent of the `data_dependent_shapes` flag
80- (see below).
81-
82- - `data_dependent_shapes`: Whether data-dependent shapes are enabled in
83- array-api-strict.
84-
85- This flag is enabled by default. Array libraries that use computation
86- graphs may not be able to support functions whose output shapes depend
87- on the input data.
88-
89- The functions that make use of data-dependent shapes, and are therefore
90- disabled by setting this flag to False are
91-
92- - `unique_all()`, `unique_counts()`, `unique_inverse()`, and `unique_values()`.
93- - `nonzero()`
94- - `repeat()` when the `repeats` argument is an array (requires 2023.12
95- version of the standard)
96-
97- Note that while boolean indexing is also data-dependent, it is
98- controlled by a separate `boolean_indexing` flag (see above).
99-
100- See
101- https://data-apis.org/array-api/latest/design_topics/data_dependent_output_shapes.html
102- for more details.
103-
104- - `enabled_extensions`: A list of extensions that are enabled in
105- array-api-strict. The default is ``{default_extensions}``. Note that
106- some extensions require a minimum version of the standard.
67+ Parameters
68+ ----------
69+ api_version : str, optional
70+ The version of the standard to use. Supported versions are:
71+ ``{supported_versions}``. The default version number is
72+ ``{default_version!r}``.
73+
74+ Note that 2021.12 is supported, but currently gives the same thing as
75+ 2022.12 (except that the fft extension will be disabled).
76+
77+ 2023.12 support is experimental. Some features in 2023.12 may still be
78+ missing, and it hasn't been fully tested.
79+
80+ boolean_indexing : bool, optional
81+ Whether indexing by a boolean array is supported.
82+ Note that although boolean array indexing does result in
83+ data-dependent shapes, this flag is independent of the
84+ `data_dependent_shapes` flag (see below).
85+
86+ data_dependent_shapes : bool, optional
87+ Whether data-dependent shapes are enabled in array-api-strict.
88+ This flag is enabled by default. Array libraries that use computation
89+ graphs may not be able to support functions whose output shapes depend
90+ on the input data.
91+
92+ The functions that make use of data-dependent shapes, and are therefore
93+ disabled by setting this flag to False are
94+
95+ - `unique_all()`, `unique_counts()`, `unique_inverse()`, and `unique_values()`.
96+ - `nonzero()`
97+ - `repeat()` when the `repeats` argument is an array (requires 2023.12
98+ version of the standard)
99+
100+ Note that while boolean indexing is also data-dependent, it is
101+ controlled by a separate `boolean_indexing` flag (see above).
102+
103+ See
104+ https://data-apis.org/array-api/latest/design_topics/data_dependent_output_shapes.html
105+ for more details.
106+
107+ enabled_extensions : list of str, optional
108+ A list of extensions that are enabled in array-api-strict. The default
109+ is ``{default_extensions}``. Note that some extensions require a
110+ minimum version of the standard.
107111
108112 The flags can also be changed by setting :ref:`environment variables
109113 <environment-variables>`.
0 commit comments