55 Commits

Author SHA1 Message Date
Jake VanderPlas
97beb01c43 Deprecate the device() method of JAX arrays 2023-11-30 11:43:02 -08:00
Jake VanderPlas
0aec40a16f Deprecate arr.device_buffer and arr.device_buffers 2023-11-29 15:31:01 -08:00
carlosgmartin
9f8e1bc34a Add nn.squareplus. 2023-11-14 23:52:41 -05:00
Jake VanderPlas
4a5bd9e046 Fix typos across the package 2023-09-22 14:54:31 -07:00
8bitmp3
6cabc364b3
Update JAX F.A.Q. 2023-08-15 20:09:09 +00:00
Jake VanderPlas
d7a19442b6 DOC: fix formatting in FAQ 2023-06-14 03:17:08 -07:00
Jake VanderPlas
a083ba7853 DOC: explicitly mention io_callback in FAQ 2023-04-19 12:30:53 -07:00
Matthew Johnson
3eb9c7a6e7 update docs to remove stale reference to laziness optimization 2023-03-13 10:17:46 -07:00
Ikko Eltociear Ashimine
9be04e75fa
DOC: fix typo in faq.rst
maximium -> maximum
2023-01-31 17:47:07 +09:00
Jake VanderPlas
64621cc43f FAQ: fix discussion of marking self as static 2023-01-17 12:03:49 -08:00
Jake VanderPlas
1bb4de280e DOC: add FAQ entry on converting a tracer to an array 2023-01-10 12:28:16 -08:00
jax authors
4f7bf51ae6 Merge pull request #13328 from eltociear:patch-2
PiperOrigin-RevId: 494912964
2022-12-12 21:22:33 -08:00
Peter Hawkins
1bbcec79c1 Update FAQ since buffer donation is implemented on CPU.
PiperOrigin-RevId: 493372426
2022-12-06 11:57:34 -08:00
Ikko Ashimine
2b06888bdc
Fix typo in faq.rst
occured -> occurred
2022-11-21 02:44:36 +09:00
Jake VanderPlas
e9194b26b0 FAQ: fix JIT numerics discussion 2022-10-26 11:30:17 -07:00
jbushago
2038988783
Fix typo in faq.rst.
Fixed a small typo in the FAQ: "inthe" -> "in the".
2022-09-30 14:14:05 -04:00
Misha Brukman
86a1a6b1ee
Fix sample code block formatting
Add missing colon to format sample code as a code block rather than a quote.
2022-08-08 12:41:01 -04:00
George Necula
2fd46d13cd Delete the masking.py 2022-07-25 11:25:29 +03:00
atgctg
1d5fbeadd2
Fix typo 2022-07-18 11:23:21 +02:00
Jake VanderPlas
fbb4eb7ace DOC: add FAQ section on zero gradients for rank-based operations 2022-06-09 15:05:04 -07:00
jax authors
ea54754c49 Merge pull request #9118 from skye:device_context_manager
PiperOrigin-RevId: 452570041
2022-06-02 10:33:53 -07:00
Lena Martens
f8f5a5dca3 Add notes in buffer donation FAQ about key-word args limitation. 2022-05-25 15:33:04 +01:00
Onno Eberhard
7276731e8c
Small fix in FAQ documentation 2022-05-10 13:04:49 +02:00
Skye Wanderman-Milne
f26b866e08 Add jax.default_device context manager
This currently only supports setting a specific Device object, not a
platform like "cpu". That should be added in the future.

Bumps the minimum jaxlib version in order to include
https://github.com/tensorflow/tensorflow/pull/53656
2022-05-07 00:31:00 +00:00
Jake VanderPlas
c4836aa507 DOC: add FAQ entry on jit-compiling methods 2022-05-06 12:39:12 -07:00
George Necula
83b818d45c Add more documentation for buffer donation
Fixes: #9237
2022-01-24 09:33:08 +01:00
Jake VanderPlas
b889282f6d docs: add FAQ section about jit compilation & numerics 2021-12-28 08:57:51 -08:00
Jake VanderPlas
1f7d6316c2 doc: move stub section to bottom of FAQ 2021-12-15 16:19:14 -08:00
Jake VanderPlas
4a72e57ce0 DOC: add FAQ section on JAX vs. Numpy performance 2021-11-24 12:04:02 -08:00
elliotwaite
7392a57b75 DOC: many small fixes 2021-08-04 16:55:13 -07:00
George Necula
6a48c60a72 Rename master to main in embedded links.
Tried to avoid the change on external links to repos that
have not yet renamed master.
2021-06-18 10:00:01 +03:00
Jake VanderPlas
b88bf37698 DOC: fix typos in FAQ (np -> jnp) 2021-06-15 09:38:05 -07:00
Jake VanderPlas
12c84e7a50 Add jax.errors submodule & error troubleshooting docs 2021-03-03 12:39:12 -08:00
Stephan Hoyer
ac9b1ce921 Fix data placement reference 2021-03-01 10:12:19 -08:00
Stephan Hoyer
46db7bbe3b DOC: Add a FAQ on "Benchmarking JAX code"
This should a useful reference for users surprised by how JAX is slow :)
2021-02-28 15:26:53 -08:00
8bitmp3
162a6f155a
Nit: lint (grammar) JAX F.A.Q. 2020-12-29 18:09:13 +00:00
Sharad Vikram
a51afa309c
Fix typo in FAQ 2020-11-09 21:06:53 -08:00
Stephan Hoyer
bb684b598e Add a FAQ entry on slow JIT compilation 2020-11-09 17:21:13 -08:00
Nicholas Vadivelu
76e9f2343b update device faq 2020-09-28 19:19:47 -07:00
Nicholas Vadivelu
c4a08aff45 document setting default device and array creation 2020-09-26 17:36:40 -07:00
Stephen Tu
3b68fab2d8
Update faq.rst (#3934) 2020-08-01 11:12:59 -07:00
Matthew Johnson
062ce297dd
removed stale faq entries (#3565) 2020-06-25 19:17:24 -07:00
8bitmp3
f8570ec049
Update JAX FAQ.rst, jax.device_put (#3496) 2020-06-22 10:08:03 -07:00
Skye Wanderman-Milne
8f4ba7e679
Allow specifying both devices and axis_size to pmap. (#3475)
This allows providing custom device assignments to nested pmaps or pmap-of-sharded_jit when running on a multi-host platform.
2020-06-19 15:51:12 -07:00
Peter Hawkins
96d72fca56
Edit documentation. (#3358)
Use :func:, :class: and :meth: when referring to Python objects.
Use :ref: for hyperlinks.
Fix some bad formatting.
2020-06-08 10:37:50 -04:00
George Necula
b071b12a13
Fixed link in FAQ (#3129) 2020-05-18 16:02:49 +03:00
Jamie Townsend
670fab59cf
Test code in docs and api.py docstrings (#2994)
Also remove jaxpr doc tests from api_test.py.
2020-05-16 16:19:24 +03:00
George Necula
d315564ebf
Fixed a few more places where device commitment was lost. (#2913)
* trivial jit computations were forcing commitment to the default device
* a device_put with a device specification would not set the commitment
  if the data was already (uncommitted) on the specified device.
* added tests for the above
* once the above were fixed the LaztTest.test_zeros_ones_compilation
  stated to fail because the `sticky` parameter to lazy_force_computation
  was changing. Fixed this by removing stickyness from the compilation key.
* Expanded docstring for jax.device_put; expanded the
  device placement FAQ entry.
2020-05-04 11:30:28 +03:00
George Necula
ac023bf28f
Fixed a few places where device sticky-ness was lost. Added FAQ (#2882)
* Fixed a few places where device sitckyness was lost. Added FAQ for device
placement.

I have also added a new test (multi_device_test.test_computation_follows_data),
written more as part of the documentation. It is shorted than the
old test_computation_follows_data (which is still there, renamed
as test_computation_follows_data_old). I believe there is no
extra coverage in test_computation_follows_data_old w.r.t. all the
other tests we have.

* Fix mypy annotations and updates based on comments

* Undid some changes, will make another PR
2020-05-01 10:06:59 +03:00
George Necula
a2c06d6113
Added clearer error message for tracers in numpy.split (#2508)
* Added clearer error message for tracers in numpy.split

Now we print:

ConcretizationTypeError: Abstract tracer value where concrete value is expected (in
jax.numpy.split argument 1).
Use transformation parameters such as `static_argnums` for `jit` to avoid
tracing input values.
See `https://jax.readthedocs.io/en/latest/faq.html#abstract-tracer-value-where-concrete-value-is-expected-error`.
Encountered value: Traced<ShapedArray>

* Fixed tests, slight change to the error message

* Expanded the FAQ entry about abstract tracers for higher-order primitives

* Added clarification for tracers inside jit of grad

* Updated FAQ language in response to reviews
2020-04-22 09:25:06 +02:00