Skip to content

Commit dbd2bb9

Browse files
committed
Audited vmap docs
1 parent 3315037 commit dbd2bb9

File tree

1 file changed

+4
-13
lines changed

1 file changed

+4
-13
lines changed

functorch/_src/vmap.py

Lines changed: 4 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -171,25 +171,16 @@ def _get_name(func: Callable):
171171
# on BatchedTensors perform the batched operations that the user is asking for.
172172
def vmap(func: Callable, in_dims: in_dims_t = 0, out_dims: out_dims_t = 0) -> Callable:
173173
"""
174-
vmap is the vectorizing map. Returns a new function that maps `func` over some
175-
dimension of the inputs. Semantically, vmap pushes the map into PyTorch
176-
operations called by `func`, effectively vectorizing those operations.
174+
vmap is the vectorizing map; `vmap(func)` returns a new function that maps
175+
`func` over some dimension of the inputs. Semantically, vmap pushes the map
176+
into PyTorch operations called by `func`, effectively vectorizing those
177+
operations.
177178
178179
vmap is useful for handling batch dimensions: one can write a function `func`
179180
that runs on examples and then lift it to a function that can take batches of
180181
examples with `vmap(func)`. vmap can also be used to compute batched
181182
gradients when composed with autograd.
182183
183-
.. warning::
184-
functorch.vmap is an experimental prototype that is subject to
185-
change and/or deletion. Please use at your own risk.
186-
187-
.. note::
188-
If you're interested in using vmap for your use case, please
189-
`contact us! <https://github.com/pytorch/pytorch/issues/42368>`_
190-
We're interested in gathering feedback from early adopters to inform
191-
the design.
192-
193184
Args:
194185
func (function): A Python function that takes one or more arguments.
195186
Must return one or more Tensors.

0 commit comments

Comments
 (0)