From 7b297912008ffe2a2b6f0417a73494bd88ccb696 Mon Sep 17 00:00:00 2001 From: Roy Frostig Date: Wed, 28 Aug 2024 11:19:53 -0700 Subject: [PATCH] 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). --- docs/debugging.md | 6 +++--- docs/distributed_data_loading.md | 2 +- docs/multi_process.md | 2 +- .../notebooks/Custom_derivative_rules_for_Python_code.ipynb | 2 +- docs/notebooks/Custom_derivative_rules_for_Python_code.md | 2 +- docs/notebooks/shard_map.ipynb | 2 +- docs/notebooks/shard_map.md | 2 +- docs/sharded-computation.ipynb | 2 +- docs/sharded-computation.md | 2 +- 9 files changed, 11 insertions(+), 11 deletions(-) diff --git a/docs/debugging.md b/docs/debugging.md index 1e8501f99..d07f42da5 100644 --- a/docs/debugging.md +++ b/docs/debugging.md @@ -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 diff --git a/docs/distributed_data_loading.md b/docs/distributed_data_loading.md index 14fb1bb55..d7b88be44 100644 --- a/docs/distributed_data_loading.md +++ b/docs/distributed_data_loading.md @@ -12,7 +12,7 @@ kernelspec: name: python3 --- -# Distributed data loading in multi-host / multi-process environments +# Distributed data loading diff --git a/docs/multi_process.md b/docs/multi_process.md index 7d7083bde..32cfae126 100644 --- a/docs/multi_process.md +++ b/docs/multi_process.md @@ -1,4 +1,4 @@ -# Using JAX in multi-host and multi-process environments +# Multi-host and multi-process environments diff --git a/docs/notebooks/Custom_derivative_rules_for_Python_code.ipynb b/docs/notebooks/Custom_derivative_rules_for_Python_code.ipynb index 88d446723..dd7a36e57 100644 --- a/docs/notebooks/Custom_derivative_rules_for_Python_code.ipynb +++ b/docs/notebooks/Custom_derivative_rules_for_Python_code.ipynb @@ -6,7 +6,7 @@ "id": "LqiaKasFjH82" }, "source": [ - "# Custom derivative rules for JAX-transformable Python functions\n", + "# Custom derivative rules\n", "\n", "\n", "\n", diff --git a/docs/notebooks/Custom_derivative_rules_for_Python_code.md b/docs/notebooks/Custom_derivative_rules_for_Python_code.md index fdf4b3ed0..930887af1 100644 --- a/docs/notebooks/Custom_derivative_rules_for_Python_code.md +++ b/docs/notebooks/Custom_derivative_rules_for_Python_code.md @@ -13,7 +13,7 @@ kernelspec: +++ {"id": "LqiaKasFjH82"} -# Custom derivative rules for JAX-transformable Python functions +# Custom derivative rules diff --git a/docs/notebooks/shard_map.ipynb b/docs/notebooks/shard_map.ipynb index 157d6c567..1315783c3 100644 --- a/docs/notebooks/shard_map.ipynb +++ b/docs/notebooks/shard_map.ipynb @@ -5,7 +5,7 @@ "id": "41a7e222", "metadata": {}, "source": [ - "# SPMD multi-device parallelism with `shard_map`\n", + "# Manual parallelism with `shard_map`\n", "\n", "\n", "\n", diff --git a/docs/notebooks/shard_map.md b/docs/notebooks/shard_map.md index 21e4111d5..96667e709 100644 --- a/docs/notebooks/shard_map.md +++ b/docs/notebooks/shard_map.md @@ -14,7 +14,7 @@ kernelspec: name: python3 --- -# SPMD multi-device parallelism with `shard_map` +# Manual parallelism with `shard_map` diff --git a/docs/sharded-computation.ipynb b/docs/sharded-computation.ipynb index b7bc919eb..22d9156f6 100644 --- a/docs/sharded-computation.ipynb +++ b/docs/sharded-computation.ipynb @@ -5,7 +5,7 @@ "metadata": {}, "source": [ "(sharded-computation)=\n", - "# Introduction to sharded computation\n", + "# Introduction to parallel programming\n", "\n", "\n", "\n", diff --git a/docs/sharded-computation.md b/docs/sharded-computation.md index 4f8c1b020..e6e1948f9 100644 --- a/docs/sharded-computation.md +++ b/docs/sharded-computation.md @@ -12,7 +12,7 @@ kernelspec: --- (sharded-computation)= -# Introduction to sharded computation +# Introduction to parallel programming