Commit 0613135a authored by Mikhail Korobov's avatar Mikhail Korobov Committed by Francisco Massa
Browse files

improve make_grid docstring (#227)

* DOC fixed typo in make_grid argument name

* DOC document "padding" make_grid argument
parent 77eb7ea7
...@@ -10,16 +10,17 @@ def make_grid(tensor, nrow=8, padding=2, ...@@ -10,16 +10,17 @@ def make_grid(tensor, nrow=8, padding=2,
Args: Args:
tensor (Tensor or list): 4D mini-batch Tensor of shape (B x C x H x W) tensor (Tensor or list): 4D mini-batch Tensor of shape (B x C x H x W)
or a list of images all of the same size. or a list of images all of the same size.
nrows (int, optional): Number of rows in grid. Final grid size is nrow (int, optional): Number of rows in grid. Final grid size is
(B / nrow, nrow). Default is 8. (B / nrow, nrow). Default is 8.
padding (int, optional): amount of padding. Default is 2.
normalize (bool, optional): If True, shift the image to the range (0, 1), normalize (bool, optional): If True, shift the image to the range (0, 1),
by subtracting the minimum and dividing by the maximum pixel value. by subtracting the minimum and dividing by the maximum pixel value.
range (tuple, optional): tuple (min, max) where min and max are numbers, range (tuple, optional): tuple (min, max) where min and max are numbers,
then these numbers are used to normalize the image. By default, min and max then these numbers are used to normalize the image. By default, min and max
are computed from the tensor. are computed from the tensor.
scale_each(bool, optional): If True, scale each image in the batch of scale_each (bool, optional): If True, scale each image in the batch of
images separately rather than the (min, max) over all images. images separately rather than the (min, max) over all images.
pad_value(float, optional): Value for the padded pixels. pad_value (float, optional): Value for the padded pixels.
Example: Example:
See this notebook `here <https://gist.github.com/anonymous/bf16430f7750c023141c562f3e9f2a91>`_ See this notebook `here <https://gist.github.com/anonymous/bf16430f7750c023141c562f3e9f2a91>`_
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment