mirrors/rocm_jax
1
0
Fork 0
mirror of https://github.com/ROCm/jax.git synced 2025-04-16 11:56:07 +00:00
Code Issues Packages Projects Releases Wiki Activity
rocm_jax/docs
History
jax authors 800f903f9b Merge pull request #25686 from Mikcl:docs/working-with-pytrees-formatting 
PiperOrigin-RevId: 711448394
2025-01-02 09:40:17 -08:00
..
_static
[Pallas] Update TPU documentation
2024-12-06 10:59:11 -08:00
_templates
Add the JAX logo to sphinx docs
2019-08-05 12:34:29 -07:00
_tutorials
Add/update JAX Advanced Tutorials docs, ToC structure
2024-09-20 23:06:54 +00:00
debugging
docs: runtime debugging tweaks
2024-08-28 11:04:14 -07:00
export
[export] Expand exporting to work with AbstractMesh.
2024-12-16 10:30:46 +02:00
ffi
Update some outdated syntax in FFI tutorial.
2024-11-12 08:34:24 -08:00
gpu_ops
Current status + build script fixes
2024-04-08 04:48:28 -07:00
jep
DOC: clarify API compatibility discussion & mention EffVer
2024-12-19 11:23:43 -08:00
notebooks
remove whitespace from distributed arrays doc
2024-12-18 23:55:20 +00:00
pallas
Merge pull request #25272 from justinjfu:pallas_tpu_docs_update
2024-12-09 12:22:31 -08:00
sphinxext
Update references to the GitHub url in JAX codebase to reflect move from google/jax to jax-ml/jax
2024-09-20 07:52:33 -07:00
about.md
add about page
2024-11-07 21:47:50 -08:00
advanced_guide.rst
Add md page about XLA&XLA_FLAGS in JAX
2024-09-05 09:27:32 +00:00
advanced-autodiff.md
Fix some typos
2024-11-19 15:04:55 +00:00
aot.md
Don't add mhlo.layout_mode = "default" since that is the default even in PJRT and will help reduce cruft in the IR
2024-10-11 14:54:32 -07:00
api_compatibility.md
DOC: clarify API compatibility discussion & mention EffVer
2024-12-19 11:23:43 -08:00
async_dispatch.rst
update documentation notes to new-style typed keys
2024-03-07 12:40:09 -08:00
autodidax.ipynb
Fix some typos
2024-11-19 15:04:55 +00:00
autodidax.md
Fix some typos
2024-11-19 15:04:55 +00:00
autodidax.py
Fix some typos
2024-11-19 15:04:55 +00:00
automatic-differentiation.md
pre-commit: update hooks & pin using hashes
2024-08-27 15:23:13 -07:00
automatic-vectorization.md
pre-commit: update hooks & pin using hashes
2024-08-27 15:23:13 -07:00
beginner_guide.rst
Update references to the GitHub url in JAX codebase to reflect move from google/jax to jax-ml/jax
2024-09-20 07:52:33 -07:00
build_custom_gpu.sh
Current status + build script fixes
2024-04-08 04:48:28 -07:00
building_on_jax.md
docs: sentence case page titles, section headings, some content
2024-08-12 18:12:17 -07:00
changelog.md
move changelog to top level
2021-03-08 10:44:52 -08:00
concurrency.rst
Document that JAX follows the NEP-29 deprecation policy.
2021-04-21 11:12:41 -04:00
conf.py
Adjust copyright notice.
2024-10-28 18:53:38 -07:00
contributing.md
Update references to the GitHub url in JAX codebase to reflect move from google/jax to jax-ml/jax
2024-09-20 07:52:33 -07:00
contributor_guide.rst
jax.core: deprecate a number of APIs
2024-12-10 11:11:32 -08:00
control-flow.md
Add an example on logical operators to the tutorial.
2024-11-15 12:40:41 -08:00
Custom_Operation_for_GPUs.md
Fix some typos
2024-11-19 15:04:55 +00:00
Custom_Operation_for_GPUs.py
Fix typos: Change 'arugments' to 'arguments'.
2024-11-13 15:58:45 -05:00
debugging.md
docs: shorten/clarify some page titles
2024-08-28 11:22:06 -07:00
deprecation.md
Mention python 3.13 in docs & package metadata
2024-11-20 08:23:19 -08:00
developer.md
Update documentation and add setup.py pypi bindings
2024-12-19 10:21:28 -06:00
device_memory_profiling.md
docs: tidy up titles and headings
2024-08-13 11:53:57 -07:00
distributed_data_loading.md
Use jax.make_array_from_process_local_data API in distributed data loading doc
2024-09-23 16:03:34 -07:00
errors.rst
Add jax.errors.JaxRuntimeError as a public alias for the XlaRuntimeError class.
2024-09-26 08:39:30 -07:00
extensions.rst
Add/update JAX Advanced Tutorials docs, ToC structure
2024-09-20 23:06:54 +00:00
external-callbacks.md
Add/update JAX Advanced Tutorials docs, ToC structure
2024-09-20 23:06:54 +00:00
faq.rst
Move Control Flow text from Sharp Bits into its own tutorial.
2024-11-14 11:07:52 -08:00
ffi.ipynb
fix(docs): typos in macro name
2024-11-19 16:42:19 +01:00
ffi.md
fix(docs): typos in macro name
2024-11-19 16:42:19 +01:00
glossary.rst
Add/update JAX Advanced Tutorials docs, ToC structure
2024-09-20 23:06:54 +00:00
gpu_memory_allocation.rst
Document cudaMallocAsync as an experimental feature.
2024-12-06 13:41:35 -05:00
gpu_performance_tips.md
Merge pull request #25444 from justinjfu:gpu_docs_update
2024-12-13 11:05:31 -08:00
gradient-checkpointing.md
Fix some typos
2024-12-03 05:07:53 +00:00
hero.html
DOC: update main landing page style
2024-11-15 13:44:31 -08:00
index.rst
DOC: update main landing page style
2024-11-15 13:44:31 -08:00
installation.md
Update documentation and add setup.py pypi bindings
2024-12-19 10:21:28 -06:00
investigating_a_regression.md
Update references to the GitHub url in JAX codebase to reflect move from google/jax to jax-ml/jax
2024-09-20 07:52:33 -07:00
jax_array_migration.md
Add freshness metablock to JAX OSS docs.
2024-06-21 14:50:49 -07:00
jax-primitives.md
Add/update JAX Advanced Tutorials docs, ToC structure
2024-09-20 23:06:54 +00:00
jax.debug.rst
DOC: make API doc titles more uniform
2023-01-18 10:59:42 -08:00
jax.distributed.rst
DOC: make API doc titles more uniform
2023-01-18 10:59:42 -08:00
jax.dlpack.rst
DOC: make API doc titles more uniform
2023-01-18 10:59:42 -08:00
jax.dtypes.rst
custom prng: introduce mechanism to identify key arrays by dtype
2023-07-21 12:27:32 -07:00
jax.example_libraries.optimizers.rst
DOC: make API doc titles more uniform
2023-01-18 10:59:42 -08:00
jax.example_libraries.rst
DOC: make API doc titles more uniform
2023-01-18 10:59:42 -08:00
jax.example_libraries.stax.rst
DOC: make API doc titles more uniform
2023-01-18 10:59:42 -08:00
jax.experimental.array_api.rst
[array api] Finalize array API in jax.numpy & deprecate jax.experimental.array_api
2024-08-01 11:19:17 -07:00
jax.experimental.checkify.rst
DOC: make API doc titles more uniform
2023-01-18 10:59:42 -08:00
jax.experimental.compilation_cache.rst
Cleanup deprecated compilation cache APIs.
2024-01-12 22:44:48 -08:00
jax.experimental.custom_partitioning.rst
Adding @custom_partitioning to jax.experimental API doc
2023-01-20 11:34:29 -08:00
jax.experimental.jet.rst
DOC: make API doc titles more uniform
2023-01-18 10:59:42 -08:00
jax.experimental.key_reuse.rst
[key reuse] define KeyReuseError in jax.errors
2024-03-08 10:59:06 -08:00
jax.experimental.mesh_utils.rst
Add JAX mesh_utils docs
2024-02-13 00:56:21 +00:00
jax.experimental.multihost_utils.rst
Fix a sphinx error.
2023-05-05 11:08:18 -07:00
jax.experimental.pallas.mosaic_gpu.rst
[pallas:mosaic_gpu] plgpu.copy_smem_to_gmem no longer transparently commits SMEM
2024-10-31 02:21:10 -07:00
jax.experimental.pallas.rst
[pallas] Added API docs for Triton and Mosaic GPU backends
2024-10-10 12:27:53 +01:00
jax.experimental.pallas.tpu.rst
[pallas] Added API docs for Triton and Mosaic GPU backends
2024-10-10 12:27:53 +01:00
jax.experimental.pallas.triton.rst
[pallas] Added API docs for Triton and Mosaic GPU backends
2024-10-10 12:27:53 +01:00
jax.experimental.pjit.rst
DOC: make API doc titles more uniform
2023-01-18 10:59:42 -08:00
jax.experimental.rst
[pallas] Added API docs for Triton and Mosaic GPU backends
2024-10-10 12:27:53 +01:00
jax.experimental.serialize_executable.rst
Add doc for jax.experimental.serialize_executable module
2024-05-14 19:11:37 -04:00
jax.experimental.shard_map.rst
shard_map: add API docs
2024-05-13 13:04:15 -07:00
jax.experimental.sparse.rst
DOC: document jax.experimental.sparse.linalg
2023-04-28 14:18:50 -07:00
jax.export.rst
[export] Improved the documentation.
2024-12-08 17:39:24 +01:00
jax.extend.core.rst
jax.core: deprecate a number of APIs
2024-12-10 11:11:32 -08:00
jax.extend.ffi.rst
Export jaxlib.xla_client.register_custom_call_target as jax.extend.ffi.register_ffi_target.
2024-07-19 08:12:25 -04:00
jax.extend.linear_util.rst
Add jax.extend.mlir.
2023-12-06 09:16:43 -08:00
jax.extend.mlir.rst
Add jax.extend.mlir.
2023-12-06 09:16:43 -08:00
jax.extend.random.rst
Add jax.extend.mlir.
2023-12-06 09:16:43 -08:00
jax.extend.rst
jax.core: deprecate a number of APIs
2024-12-10 11:11:32 -08:00
jax.flatten_util.rst
DOC: make API doc titles more uniform
2023-01-18 10:59:42 -08:00
jax.image.rst
DOC: make API doc titles more uniform
2023-01-18 10:59:42 -08:00
jax.lax.rst
Reverts 525b646c0ebd5205f4fa0639c94adb2de47e1cf0
2024-12-17 10:12:34 -08:00
jax.lib.rst
Finalize some deprecations in jax.core, jax.lib.xla_bridge, and jax.lib.xla_client.
2024-12-11 09:50:33 -08:00
jax.nn.initializers.rst
update package/API reference docs to new-style typed PRNG keys
2024-03-07 12:40:09 -08:00
jax.nn.rst
Update jax doc sdpa
2024-07-15 17:30:54 +00:00
jax.numpy.rst
Finalize deprecation of jnp.round_
2024-12-13 14:13:44 -08:00
jax.ops.rst
DOC: make API doc titles more uniform
2023-01-18 10:59:42 -08:00
jax.profiler.rst
DOC: make API doc titles more uniform
2023-01-18 10:59:42 -08:00
jax.random.rst
emphasize typed over legacy RNG keys in random module docs
2024-08-11 12:41:50 -07:00
jax.rst
Add error message when using custom_vmap with reverse-mode AD, and add docstrings.
2024-12-09 11:17:44 -08:00
jax.scipy.rst
feat(lib): add real-valued implementation of jax.scipy.special.fresnel
2024-09-03 09:50:19 +02:00
jax.sharding.rst
Deprecate XLACompatibleSharding in favor of jax.sharding.Sharding.
2024-06-05 09:07:27 -07:00
jax.stages.rst
Add trace to stages.Wrapped and add docs for it.
2024-06-13 14:49:54 -07:00
jax.tree_util.rst
Export KeyPath and related types to jax.tree_util
2024-07-31 06:41:33 -07:00
jax.tree.rst
Add jax.tree shortcuts for .*_with_path calls, for convenience of users.
2024-12-12 15:13:32 -08:00
jax.typing.rst
Define jax.typing.DTypeLike
2023-10-10 08:46:36 -07:00
jaxpr.md
Add/update JAX Advanced Tutorials docs, ToC structure
2024-09-20 23:06:54 +00:00
jit-compilation.md
Move Control Flow text from Sharp Bits into its own tutorial.
2024-11-14 11:07:52 -08:00
key-concepts.md
Consolidate material on PRNGs and add a short summary to Key Concepts.
2024-11-15 14:44:57 -08:00
multi_process.md
docs: shorten/clarify some page titles
2024-08-28 11:22:06 -07:00
notes.rst
DOC: re-organize notes section
2023-01-30 11:57:06 -08:00
persistent_compilation_cache.md
When caching is enabled, also enable XLA caching features as well
2024-11-13 10:30:04 -08:00
profiling.md
tbp nightly instructions
2025-01-02 09:49:31 +01:00
pytrees.md
Add freshness metablock to JAX OSS docs.
2024-06-21 14:50:49 -07:00
quickstart.md
Fix Typos
2024-09-25 21:26:05 +05:30
random-numbers.md
Consolidate material on PRNGs and add a short summary to Key Concepts.
2024-11-15 14:44:57 -08:00
rank_promotion_warning.rst
Avoid 'from jax import config' imports
2024-04-11 13:23:27 -07:00
README.md
Fixes to the documentation
2019-10-09 17:45:09 +02:00
requirements.txt
DOC: update main landing page style
2024-11-15 13:44:31 -08:00
sharded-computation.ipynb
Don't create a mesh inside jit in sharded-computation tutorial
2024-12-17 16:11:00 -08:00
sharded-computation.md
Don't create a mesh inside jit in sharded-computation tutorial
2024-12-17 16:11:00 -08:00
stateful-computations.md
Move Control Flow text from Sharp Bits into its own tutorial.
2024-11-14 11:07:52 -08:00
transfer_guard.rst
Add a documentation for the JAX transfer guard
2022-03-25 19:50:12 +00:00
tutorials.rst
Move Control Flow text from Sharp Bits into its own tutorial.
2024-11-14 11:07:52 -08:00
type_promotion.rst
Typo
2024-09-05 20:47:40 +02:00
user_guides.rst
Add/update JAX Advanced Tutorials docs, ToC structure
2024-09-20 23:06:54 +00:00
working-with-pytrees.md
Fix formatting in the docs for transposing pytrees
2024-12-26 01:18:10 +00:00
xla_flags.md
Fix some typos
2024-12-03 05:07:53 +00:00

README.md

To rebuild the documentation, see Update Documentation.