mirror of
https://github.com/ROCm/jax.git
synced 2025-04-14 10:56:06 +00:00
docs: tidy up titles and headings
This shortens some titles and makes them more consistent. It also removes "JAX" from several titles ("in JAX", "for JAX", "JAX's", etc.). Since these are JAX docs, that ought to be clear from context.
This commit is contained in:
parent
4533aeaf26
commit
3c223cd253
@ -1,8 +1,11 @@
|
||||
.. _advanced_guide:
|
||||
|
||||
Advanced tutorials
|
||||
==================
|
||||
This section contains examples and tutorials on more advanced topics, such as Multi Core computation, Custom operations, and more in depth applications
|
||||
Advanced guides
|
||||
===============
|
||||
|
||||
This section contains examples and tutorials on more advanced topics,
|
||||
such as multi-core computation, custom operations, and more in-depth
|
||||
applications.
|
||||
|
||||
.. toctree::
|
||||
:caption: Examples
|
||||
|
@ -1,4 +1,4 @@
|
||||
# Runtime value debugging in JAX
|
||||
# Debugging runtime values
|
||||
|
||||
<!--* freshness: { reviewed: '2024-04-11' } *-->
|
||||
|
||||
|
@ -1,4 +1,4 @@
|
||||
# Device memory profiling
|
||||
# Profiling device memory
|
||||
|
||||
<!--* freshness: { reviewed: '2024-03-08' } *-->
|
||||
|
||||
|
@ -1,7 +1,8 @@
|
||||
.. _jax-errors:
|
||||
|
||||
JAX Errors
|
||||
==========
|
||||
Errors
|
||||
======
|
||||
|
||||
This page lists a few of the errors you might encounter when using JAX,
|
||||
along with representative examples of how one might fix them.
|
||||
|
||||
|
@ -1,5 +1,5 @@
|
||||
JAX frequently asked questions (FAQ)
|
||||
====================================
|
||||
Frequently asked questions (FAQ)
|
||||
================================
|
||||
|
||||
.. comment RST primer for Sphinx: https://thomas-cokelaer.info/tutorials/sphinx/rest_syntax.html
|
||||
.. comment Some links referenced here. Use `JAX - The Sharp Bits`_ (underscore at the end) to reference
|
||||
|
@ -4,7 +4,7 @@
|
||||
"cell_type": "markdown",
|
||||
"metadata": {},
|
||||
"source": [
|
||||
"# JAX's foreign function interface\n",
|
||||
"# Foreign function interface (FFI)\n",
|
||||
"\n",
|
||||
"_This tutorial requires JAX v0.4.31 or newer._\n",
|
||||
"\n",
|
||||
|
@ -12,7 +12,7 @@ kernelspec:
|
||||
name: python3
|
||||
---
|
||||
|
||||
# JAX's foreign function interface
|
||||
# Foreign function interface (FFI)
|
||||
|
||||
_This tutorial requires JAX v0.4.31 or newer._
|
||||
|
||||
|
@ -1,5 +1,5 @@
|
||||
JAX glossary of terms
|
||||
=====================
|
||||
Glossary of terms
|
||||
=================
|
||||
|
||||
.. glossary::
|
||||
|
||||
|
@ -1,4 +1,4 @@
|
||||
JAX: High-Performance Array Computing
|
||||
JAX: High performance array computing
|
||||
=====================================
|
||||
|
||||
JAX is a Python library for accelerator-oriented array computation and program transformation,
|
||||
@ -75,7 +75,7 @@ For an end-to-end transformer library built on JAX, see MaxText_.
|
||||
.. toctree::
|
||||
:hidden:
|
||||
:maxdepth: 2
|
||||
:caption: Further resources
|
||||
:caption: Resources
|
||||
|
||||
user_guides
|
||||
advanced_guide
|
||||
|
@ -1,5 +1,5 @@
|
||||
(installation)=
|
||||
# Installing JAX
|
||||
# Installation
|
||||
|
||||
<!--* freshness: { reviewed: '2024-06-18' } *-->
|
||||
|
||||
|
@ -13,7 +13,7 @@ kernelspec:
|
||||
---
|
||||
|
||||
(key-concepts)=
|
||||
# Key Concepts
|
||||
# Key concepts
|
||||
|
||||
<!--* freshness: { reviewed: '2024-05-03' } *-->
|
||||
|
||||
|
@ -6,7 +6,7 @@
|
||||
"id": "7XNMxdTwURqI"
|
||||
},
|
||||
"source": [
|
||||
"# External callbacks in JAX\n",
|
||||
"# External callbacks\n",
|
||||
"\n",
|
||||
"<!--* freshness: { reviewed: '2024-04-08' } *-->"
|
||||
]
|
||||
|
@ -13,7 +13,7 @@ kernelspec:
|
||||
|
||||
+++ {"id": "7XNMxdTwURqI"}
|
||||
|
||||
# External callbacks in JAX
|
||||
# External callbacks
|
||||
|
||||
<!--* freshness: { reviewed: '2024-04-08' } *-->
|
||||
|
||||
|
@ -6,7 +6,7 @@
|
||||
"id": "6umP1IKf4Dg6"
|
||||
},
|
||||
"source": [
|
||||
"# Autobatching for Bayesian Inference\n",
|
||||
"# Autobatching for Bayesian inference\n",
|
||||
"\n",
|
||||
"<!--* freshness: { reviewed: '2024-04-08' } *-->\n",
|
||||
"\n",
|
||||
|
@ -14,7 +14,7 @@ kernelspec:
|
||||
|
||||
+++ {"id": "6umP1IKf4Dg6"}
|
||||
|
||||
# Autobatching for Bayesian Inference
|
||||
# Autobatching for Bayesian inference
|
||||
|
||||
<!--* freshness: { reviewed: '2024-04-08' } *-->
|
||||
|
||||
|
@ -1,4 +1,4 @@
|
||||
# Profiling JAX programs
|
||||
# Profiling computation
|
||||
|
||||
<!--* freshness: { reviewed: '2024-03-18' } *-->
|
||||
|
||||
|
@ -1,7 +1,7 @@
|
||||
.. _jax-tutorials:
|
||||
|
||||
JAX tutorials
|
||||
=============
|
||||
Tutorials
|
||||
=========
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
|
Loading…
x
Reference in New Issue
Block a user