Merge pull request #20858 from rajasekharporeddy:doc_typos

PiperOrigin-RevId: 628061707
This commit is contained in:
jax authors 2024-04-25 06:58:27 -07:00
commit fad2c0e315
6 changed files with 10 additions and 10 deletions

View File

@ -39,7 +39,7 @@ Remember to align the itemized text with the first line of an item within a list
lowering pass via Triton Python APIs has been removed and the
`JAX_TRITON_COMPILE_VIA_XLA` environment variable no longer has any effect.
* {func}`jax.numpy.clip` has a new argument signature: `a`, `a_min`, and
`a_max` are deprecated in favor of `x` (positonal only), `min`, and
`a_max` are deprecated in favor of `x` (positional only), `min`, and
`max` ({jax-issue}`20550`).
* The `device()` method of JAX arrays has been removed, after being deprecated
since JAX v0.4.21. Use `arr.devices()` instead.

View File

@ -161,7 +161,7 @@ def breakpoint(*, backend: str | None = None, filter_frames: bool = True,
debugger and in the absence of other registered debuggers, falls back to
the CLI debugger.
filter_frames: Whether or not to filter out JAX-internal stack frames from
the traceback. Since some libraries, like Flax, also make user of JAX's
the traceback. Since some libraries, like Flax, also make use of JAX's
stack frame filtering system, this option can also affect whether stack
frames from libraries are filtered.
num_frames: The number of frames above the current stack frame to make

View File

@ -138,9 +138,9 @@ def initialize(coordinator_address: str | None = None,
The JAX distributed system serves a number of roles:
* it allows JAX processes to discover each other and share topology information,
* it performs health checking, ensuring that all processes shut down if any process dies, and
* it is used for distributed checkpointing.
* It allows JAX processes to discover each other and share topology information,
* It performs health checking, ensuring that all processes shut down if any process dies, and
* It is used for distributed checkpointing.
If you are using TPU, Slurm, or Open MPI, all arguments are optional: if omitted, they
will be chosen automatically.

View File

@ -251,9 +251,9 @@ def from_dlpack(external_array,
the source of ``external_array`` will require a copy, meaning ``copy`` must be
set to either ``True`` or ``None``.
copy: An (optional) boolean, controlling whether or not to a copy is performed.
copy: An (optional) boolean, controlling whether or not a copy is performed.
If ``copy=True`` then a copy is always performed, even if unpacked onto the
same device. If ``copy=False`` then the copy is never peformed and will raise
same device. If ``copy=False`` then the copy is never performed and will raise
an error if necessary. When ``copy=None`` then a copy may be performed if
needed for a device transfer.

View File

@ -195,7 +195,7 @@ def sparse_sigmoid(x: ArrayLike) -> Array:
\end{cases}
This is the twin function of the ``sigmoid`` activation ensuring a zero output
for inputs less than -1, a 1 ouput for inputs greater than 1, and a linear
for inputs less than -1, a 1 output for inputs greater than 1, and a linear
output for inputs between -1 and 1. It is the derivative of ``sparse_plus``.
For more information, see `Learning with Fenchel-Young Losses (section 6.2)

View File

@ -98,7 +98,7 @@ def start_trace(log_dir, create_perfetto_link: bool = False,
The resulting trace can be viewed with TensorBoard. Note that TensorBoard
doesn't need to be running when collecting the trace.
Only once trace may be collected a time. A RuntimeError will be raised if
Only one trace may be collected at a time. A RuntimeError will be raised if
:func:`start_trace` is called while another trace is running.
Args:
@ -235,7 +235,7 @@ def trace(log_dir, create_perfetto_link=False, create_perfetto_trace=False):
The resulting trace can be viewed with TensorBoard. Note that TensorBoard
doesn't need to be running when collecting the trace.
Only once trace may be collected a time. A RuntimeError will be raised if a
Only one trace may be collected at a time. A RuntimeError will be raised if a
trace is started while another trace is running.
Args: