docs: shorten/clarify some page titles

Shorten the titles for derivative rules and manual parallelism, and go
for canonical wording in the parallel programming intro (typically we
"shard" data, and "partition" computation, as part of parallel
programming).
This commit is contained in:
Roy Frostig 2024-08-28 11:19:53 -07:00
parent 42de34263f
commit 7b29791200
9 changed files with 11 additions and 11 deletions

View File

@ -21,7 +21,7 @@ This section introduces you to a set of built-in JAX debugging methods — {func
Let's begin with {func}`jax.debug.print`.
## JAX `debug.print` for high-level
## `jax.debug.print` for simple inspection
Here is a rule of thumb:
@ -111,7 +111,7 @@ f(1, 2)
To learn more about {func}`jax.debug.print` and its Sharp Bits, refer to {ref}`advanced-debugging`.
## JAX `debug.breakpoint` for `pdb`-like debugging
## `jax.debug.breakpoint` for `pdb`-like debugging
**Summary:** Use {func}`jax.debug.breakpoint` to pause the execution of your JAX program to inspect values.
@ -160,7 +160,7 @@ f(2., 1.) # ==> No breakpoint
f(2., 0.) # ==> Pauses during execution
```
## JAX `debug.callback` for more control during debugging
## `jax.debug.callback` for more control during debugging
Both {func}`jax.debug.print` and {func}`jax.debug.breakpoint` are implemented using
the more flexible {func}`jax.debug.callback`, which gives greater control over the

View File

@ -12,7 +12,7 @@ kernelspec:
name: python3
---
# Distributed data loading in multi-host / multi-process environments
# Distributed data loading
<!--* freshness: { reviewed: '2024-05-16' } *-->

View File

@ -1,4 +1,4 @@
# Using JAX in multi-host and multi-process environments
# Multi-host and multi-process environments
<!--* freshness: { reviewed: '2024-06-10' } *-->

View File

@ -6,7 +6,7 @@
"id": "LqiaKasFjH82"
},
"source": [
"# Custom derivative rules for JAX-transformable Python functions\n",
"# Custom derivative rules\n",
"\n",
"<!--* freshness: { reviewed: '2024-04-08' } *-->\n",
"\n",

View File

@ -13,7 +13,7 @@ kernelspec:
+++ {"id": "LqiaKasFjH82"}
# Custom derivative rules for JAX-transformable Python functions
# Custom derivative rules
<!--* freshness: { reviewed: '2024-04-08' } *-->

View File

@ -5,7 +5,7 @@
"id": "41a7e222",
"metadata": {},
"source": [
"# SPMD multi-device parallelism with `shard_map`\n",
"# Manual parallelism with `shard_map`\n",
"\n",
"<!--* freshness: { reviewed: '2024-04-08' } *-->\n",
"\n",

View File

@ -14,7 +14,7 @@ kernelspec:
name: python3
---
# SPMD multi-device parallelism with `shard_map`
# Manual parallelism with `shard_map`
<!--* freshness: { reviewed: '2024-04-08' } *-->

View File

@ -5,7 +5,7 @@
"metadata": {},
"source": [
"(sharded-computation)=\n",
"# Introduction to sharded computation\n",
"# Introduction to parallel programming\n",
"\n",
"<!--* freshness: { reviewed: '2024-05-10' } *-->\n",
"\n",

View File

@ -12,7 +12,7 @@ kernelspec:
---
(sharded-computation)=
# Introduction to sharded computation
# Introduction to parallel programming
<!--* freshness: { reviewed: '2024-05-10' } *-->