Repository map
This file assumes a local checkout similar to the provided jax-main.zip snapshot.
High-value documentation paths
Start with docs before implementation.
docs/installation.mddocs/benchmarking.mddocs/async_dispatch.rstdocs/control-flow.mddocs/random-numbers.mddocs/debugging.mddocs/debugging/checkify_guide.mddocs/debugging/print_breakpoint.mddocs/device_memory_profiling.mddocs/profiling.mddocs/persistent_compilation_cache.mddocs/buffer_donation.mddocs/sharded-computation.mddocs/notebooks/explicit-sharding.mddocs/migrate_pmap.mddocs/aot.mddocs/export/export.mddocs/export/shape_poly.mddocs/gpu_performance_tips.mddocs/faq.rstdocs/changelog.mddocs/notebooks/shard_map.mddocs/pallas/anddocs/jax.experimental.pallas*.rst
High-value source modules
These are the first places to inspect in the Python sources:
jax/_src/api.pyjax/_src/api_util.pyjax/_src/array.pyjax/_src/random.pyjax/_src/debugging.pyjax/_src/checkify.pyjax/_src/errors.pyjax/_src/custom_derivatives.pyjax/_src/ad_checkpoint.pyjax/_src/stages.pyjax/_src/export/jax/_src/pjit.pyjax/_src/sharding.pyjax/_src/sharding_impls.pyjax/_src/mesh.pyjax/_src/mesh_utils.pyjax/_src/pallas/
Tests worth checking early
Tests are often the fastest truth source for current behaviour.
tests/api_test.pytests/errors_test.pytests/lax_control_flow_test.pytests/random_test.pytests/checkify_test.pytests/debugging_primitives_test.pytests/pjit_test.pytests/pmap_test.pytests/shard_map_test.pytests/profiler_test.pytests/export_test.py
Search recipes
Control-flow and tracer errors:
rg "ConcretizationTypeError|TracerBoolConversionError|NonConcreteBooleanIndexError" docs tests jaxRandomness:
rg "random.key|PRNGKey|key reuse|fold_in|split" docs tests jaxSharding and migration:
rg "NamedSharding|PartitionSpec|Mesh|shard_map|pmap|migrate_pmap" docs tests jaxDebugging and profiling:
rg "debug.print|checkify|block_until_ready|profiler|compiler_ir" docs tests jaxCustom autodiff / export:
rg "custom_vjp|custom_jvp|export|ShapeDtypeStruct|shape polymorphism" docs tests jaxPallas:
rg "pallas|mosaic|triton" docs tests jaxRecommended protocol for repo questions
- read the relevant docs page
- inspect the nearest
_srcimplementation - confirm with a nearby test
- only then make a behaviour claim
If docs and code look out of sync, prefer current tests plus changelog or migration docs.