tensor.py 24.9 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16
# -*- coding: utf-8 -*-
# MegEngine is Licensed under the Apache License, Version 2.0 (the "License")
#
# Copyright (c) 2014-2020 Megvii Inc. All rights reserved.
#
# Unless required by applicable law or agreed to in writing,
# software distributed under the License is distributed on an
# "AS IS" BASIS, WITHOUT ARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
import functools
import math
from itertools import accumulate
from typing import Iterable, List, Optional, Sequence, Tuple, Union

import numpy as np

from ..core._imperative_rt import CompNode
17
from ..core._imperative_rt.core2 import apply
18
from ..core._wrap import device as as_device
19 20
from ..core.ops import builtin
from ..core.ops.special import Const
21
from ..core.tensor.tensor_wrapper import _broadcast, _remove_axis
22 23 24 25 26 27 28 29 30 31 32 33 34
from ..core.tensor.utils import (
    astensor1d,
    convert_inputs,
    convert_single_value,
    dtype_promotion,
    get_device,
)
from ..device import get_default_device
from ..tensor import Tensor
from .elemwise import ceil

__all__ = [
    "arange",
35
    "broadcast_to",
36 37
    "concat",
    "cond_take",
38
    "expand_dims",
39
    "eye",
40
    "flatten",
41 42 43 44 45 46
    "full",
    "full_like",
    "gather",
    "linspace",
    "ones",
    "ones_like",
47
    "reshape",
48
    "split",
M
Megvii Engine Team 已提交
49
    "squeeze",
50 51
    "stack",
    "scatter",
52
    "transpose",
53 54 55 56 57 58
    "where",
    "zeros",
    "zeros_like",
]


59
def eye(N, M=None, *, dtype="float32", device: Optional[CompNode] = None) -> Tensor:
60 61
    """
    Returns a 2D tensor with ones on the diagonal and zeros elsewhere.
62

M
Megvii Engine Team 已提交
63
    :param shape: expected shape of output tensor.
64 65 66
    :param dtype: data type. Default: None
    :param device: compute node of the matrix. Default: None
    :return: eye matrix.
67 68 69 70 71 72 73 74

    Examples:

    .. testcode::

        import numpy as np
        import megengine.functional as F

75
        out = F.eye(4, 6, dtype=np.float32)
76 77 78 79 80 81 82 83 84 85 86 87
        print(out.numpy())

    Outputs:

    .. testoutput::

        [[1. 0. 0. 0. 0. 0.]
         [0. 1. 0. 0. 0. 0.]
         [0. 0. 1. 0. 0. 0.]
         [0. 0. 0. 1. 0. 0.]]

    """
88 89 90 91 92 93 94 95 96
    if M is not None:
        if isinstance(N, Tensor) or isinstance(M, Tensor):
            shape = astensor1d((N, M))
        else:
            shape = Tensor([N, M], dtype="int32", device=device)
    elif isinstance(N, Tensor):
        shape = N
    else:
        shape = Tensor(N, dtype="int32", device=device)
97
    op = builtin.Eye(k=0, dtype=dtype, comp_node=device)
98
    (result,) = apply(op, shape)
99 100 101 102
    return result


def full(shape, value, dtype="float32", device=None):
103 104
    """
    Returns a tensor with given shape and value.
105
    """
106 107
    if isinstance(shape, int):
        shape = (shape,)
108 109
    if device is None:
        device = get_default_device()
110
    (x,) = Const(value, dtype=dtype, device=device)()
111 112
    if len(shape) == 0:  # scalar
        return x
113
    return broadcast_to(x, shape)
114 115 116


def ones(shape, dtype="float32", device=None):
117 118
    """
    Returns a ones tensor with given shape.
119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139

    :param inp: input tensor.
    :return: output zero tensor.

    Examples:

    .. testcode::

        import megengine.functional as F

        out = F.ones((2, 1))
        print(out.numpy())

    Outputs:

    .. testoutput::

        [[1.]
         [1.]]

    """
140 141 142 143
    return full(shape, 1.0, dtype=dtype, device=device)


def zeros(shape, dtype="float32", device=None):
144 145
    """
    Returns a zero tensor with given shape.
146
    """
147 148 149 150
    return full(shape, 0.0, dtype=dtype, device=device)


def zeros_like(inp: Tensor) -> Tensor:
151 152
    """
    Returns a zero tensor with the same shape as input tensor.
153

154 155
    :param inp: input tensor.
    :return: output zero tensor.
156 157 158 159 160 161 162 163 164 165 166 167 168

    Examples:

    .. testcode::

        import numpy as np
        from megengine import tensor
        import megengine.functional as F

        inp = tensor(np.arange(1, 7, dtype=np.int32).reshape(2,3))
        out = F.zeros_like(inp)
        print(out.numpy())

M
Megvii Engine Team 已提交
169
    Outputs:
170

171 172 173 174 175 176 177 178 179 180
    .. testoutput::

        [[0 0 0]
         [0 0 0]]

    """
    return zeros(inp.shape, dtype=inp.dtype, device=inp.device)


def ones_like(inp: Tensor) -> Tensor:
181 182
    """
    Returns a ones tensor with the same shape as input tensor.
183 184 185 186 187
    """
    return ones(inp.shape, dtype=inp.dtype, device=inp.device)


def full_like(inp: Tensor, value: Union[int, float]) -> Tensor:
188 189
    """
    Returns a tensor filled with given value with the same shape as input tensor.
190 191 192 193
    """
    return full(inp.shape, value, dtype=inp.dtype, device=inp.device)


194
def broadcast_to(inp: Tensor, shape: Union[int, Iterable[int]]) -> Tensor:
195
    """
196
    Broadcasts a tensor to given shape.
197

198 199 200
    :param inp: input tensor.
    :param shape: target shape.
    :return: output tensor.
201 202 203 204 205 206 207 208 209

    Examples:

    .. testcode::

        import numpy as np
        from megengine import tensor
        import megengine.functional as F

210 211
        data = tensor(np.arange(0, 3, dtype=np.float32).reshape(3))
        out = F.broadcast_to(data, (2, 3))
212 213 214 215 216 217
        print(out.numpy())

    Outputs:

    .. testoutput::

218 219
        [[0. 1. 2.]
         [0. 1. 2.]]
220 221

    """
222
    return _broadcast(inp, shape)
223 224


225
def concat(inps: Iterable[Tensor], axis: int = 0, device=None) -> Tensor:
226 227 228
    r"""
    Concat some tensors

229
    :param inps: input tensors to concat.
M
Megvii Engine Team 已提交
230 231
    :param axis: over which dimension the tensors are concatenated. Default: 0
    :param device: which device output will be. Default: None
232
    :return: output tensor.
233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256

    Examples:

    .. testcode::

        import numpy as np
        from megengine import tensor
        import megengine.functional as F

        data1 = tensor(np.arange(0, 6, dtype=np.float32).reshape((2, 3)))
        data2 = tensor(np.arange(6, 12, dtype=np.float32).reshape((2, 3)))
        out = F.concat([data1, data2])
        print(out.numpy())

    Outputs:

    .. testoutput::

        [[ 0.  1.  2.]
         [ 3.  4.  5.]
         [ 6.  7.  8.]
         [ 9. 10. 11.]]

    """
257 258 259
    if len(inps) == 1:
        return inps[0]

260
    dtype = dtype_promotion(inps)
261 262 263
    if device is None:
        device = get_device(inps)
    device = as_device(device)
264 265

    def convert(x):
266
        return convert_single_value(x, dtype=dtype, device=device)
267 268 269 270 271 272

    inps = tuple(map(convert, inps))
    (result,) = apply(builtin.Concat(axis=axis, comp_node=device.to_c()), *inps)
    return result


273
def stack(inps, axis=0, device=None):
274 275
    """
    Concats a sequence of tensors along a new axis.
276 277
    The input tensors must have the same shape.

278 279
    :param inps: input tensors.
    :param axis: which axis will be concatenated.
M
Megvii Engine Team 已提交
280
    :param device: the device output will be. Default: None
281
    :return: output concatenated tensor.
282 283 284 285 286 287 288 289 290

    Examples:

    .. testcode::

        import numpy as np
        from megengine import tensor
        import megengine.functional as F

291 292
        x1 = tensor(np.arange(0, 3, dtype=np.float32).reshape((3)))
        x2 = tensor(np.arange(6, 9, dtype=np.float32).reshape((3)))
293 294 295 296 297 298 299
        out = F.stack([x1, x2], axis=0)
        print(out.numpy())

    Outputs:

    .. testoutput::

300 301
        [[0. 1. 2.]
         [6. 7. 8.]]
302 303

    """
304 305 306 307
    if len(inps) > 0 and not isinstance(inps[0].shape, inps[0].__class__):
        shapes = {arr.shape for arr in inps}
        if len(shapes) != 1:
            raise ValueError("All input tensors must have the same shape")
308

309
    inps = [expand_dims(inp, axis=axis) for inp in inps]
310
    return concat(inps, axis=axis, device=device)
311 312 313


def split(inp, nsplits_or_sections, axis=0):
314 315
    """
    Splits the input tensor into several smaller tensors.
316 317
    When nsplits_or_sections is int, the last tensor may be smaller than others.

318
    :param inp: input tensor.
M
Megvii Engine Team 已提交
319
    :param nsplits_or_sections: number of sub tensors or sections information list.
320 321
    :param axis: which axis will be splited.
    :return: output tensor list.
322 323 324 325 326 327 328 329 330 331 332

    Examples:

    .. testcode::

        import numpy as np
        from megengine import tensor
        import megengine.functional as F

        x = tensor(np.random.random((2,3,4,5)), dtype=np.float32)
        out = F.split(x, 2, axis=3)
333
        print(out[0].numpy().shape, out[1].numpy().shape)
334 335 336 337 338 339 340 341 342 343 344 345 346 347

    Outputs:

    .. testoutput::

        (2, 3, 4, 3) (2, 3, 4, 2)

    """
    sub_tensors = []
    sections = []

    def swapaxis(inp, src, dst):
        if src == dst:
            return inp
348
        shape = [i for i in range(inp.ndim)]
349 350 351 352 353 354 355
        shape[src] = dst
        shape[dst] = src
        return inp.transpose(shape)

    inp = swapaxis(inp, 0, axis)

    if isinstance(nsplits_or_sections, int):
356 357 358 359 360
        incr_step = ceil(inp.shape[0] / nsplits_or_sections)
        nsplits = nsplits_or_sections
        while nsplits > 0:
            nsplits -= 1
            sections.append(incr_step.astype("int32"))
361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386
            incr_step += nsplits_or_sections
    else:
        sections = nsplits_or_sections

    st = 0
    for se in sections:
        sub_tensors.append(swapaxis(inp[st:se], axis, 0))
        st = se

    if st < inp.shape[0]:
        sub_tensors.append(swapaxis(inp[st:], axis, 0))

    return sub_tensors


def _get_idx(index, axis):
    index_dims = len(index.shape)
    idx = []
    for i in range(index_dims):
        if i != axis:
            shape = [1] * index_dims
            shape[i] = index.shape[i]
            arange = linspace(
                0, index.shape[i] - 1, index.shape[i], device=index.device,
            )
            arange = (
387
                broadcast_to(arange.reshape(*shape), index.shape)
388 389 390 391 392 393 394 395 396 397
                .reshape(-1)
                .astype(np.int32)
            )
            idx.append(arange)
        else:
            idx.append(index.reshape(-1))
    return tuple(idx)


def gather(inp: Tensor, axis: int, index: Tensor) -> Tensor:
398
    # TODO: rewrite doc
399 400
    r"""
    Gathers data from input tensor on axis using index.
401 402 403 404 405 406 407

    For a 3-D tensor, the output is specified by::

        out[i][j][k] = inp[index[i][j][k]][j][k] # if axis == 0
        out[i][j][k] = inp[i][index[i][j][k]][k] # if axis == 1
        out[i][j][k] = inp[i][j][index[i][j][k]] # if axis == 2

M
Megvii Engine Team 已提交
408
    if input tensor is a n-dimensional tensor with size
409
    :math:`(x_0,x_1,...,x_{i-1},x_i,x_{i+1},...,x_{n-1})` and axis=i,
M
Megvii Engine Team 已提交
410
    then index must be a n-dimensional tensor with size
411
    :math:`(x_0,x_1,...,x_{i-1},y,x_{i+1},...,x_{n-1})` where :math:`y\ge 1` and
412
    output will have the same size as index.
413

414
    :param inp: input tensor.
M
Megvii Engine Team 已提交
415
    :param axis: along which axis to index.
416 417
    :param index: indices of elements to gather.
    :return: output tensor.
418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470

    Examples:

    .. testcode::

        import megengine.functional as F
        from megengine import tensor

        inp = tensor([
            [1,2], [3,4], [5,6],
        ])
        index = tensor([[0,2], [1,0]])
        oup = F.gather(inp, 0, index)
        print(oup.numpy())

    Outputs:

    .. testoutput::

        [[1 6]
         [3 2]]

    """
    input_shape = inp.shape
    index_shape = index.shape
    input_dims = len(input_shape)
    index_dims = len(index_shape)
    if input_dims != index_dims:
        raise ValueError(
            "The index tensor must have same dimensions as input tensor, "
            "But the input dims:{}, the index dims:{}".format(input_dims, index_dims)
        )

    if axis < 0 or axis >= input_dims:
        raise ValueError(
            "Index axis {} is output of bounds, should in range [0 {})".format(
                axis, input_dims
            )
        )

    for i in range(input_dims):
        if i != axis and input_shape[i] != index_shape[i]:
            raise ValueError(
                "The input {} and index {} must have the same size apart from axis {}".format(
                    input_shape, index_shape, axis
                )
            )

    idx = _get_idx(index, axis)
    return inp[idx].reshape(index.shape)  # pylint: disable=no-member


def scatter(inp: Tensor, axis: int, index: Tensor, source: Tensor) -> Tensor:
471
    # TODO: rewrite doc
472 473
    r"""
    Writes all values from the tensor source into input tensor
474
    at the indices specified in the index tensor.
475

476 477 478
    For each value in source, its output index is specified by its index
    in source for ``axis != dimension`` and by the corresponding value in
    index for ``axis = dimension``.
479

M
Megvii Engine Team 已提交
480
    For a 3-D tensor, input tensor is updated as::
481 482 483 484 485

        inp[index[i][j][k]][j][k] = source[i][j][k]  # if axis == 0
        inp[i][index[i][j][k]][k] = source[i][j][k]  # if axis == 1
        inp[i][j][index[i][j][k]] = source[i][j][k]  # if axis == 2

M
Megvii Engine Team 已提交
486
    ``inp``, ``index`` and ``source`` should have same number of dimensions.
487 488 489 490

    It is also required that ``source.shape(d) <= inp.shape(d)`` and ``index.shape(d) == source.shape(d)``
    for all dimensions ``d``.

491
    Moreover, the values of index must be between ``0`` and ``inp.shape(axis) - 1`` inclusive.
492 493 494

    .. note::
        Please notice that, due to performance issues, the result is uncertain on the GPU device
M
Megvii Engine Team 已提交
495
        if scattering different positions from source to the same destination position
496 497
        regard to index tensor.

M
Megvii Engine Team 已提交
498
        Check the following examples, the oup[0][2] is maybe
499 500 501
        from source[0][2] which value is 0.2256 or source[1][2] which value is 0.5339
        if set the index[1][2] from 1 to 0.

502 503 504 505 506
    :param inp: inp tensor which to be scattered.
    :param axis: axis along which to index.
    :param index: indices of elements to scatter.
    :param source: source element(s) to scatter.
    :return: output tensor.
507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577

    Examples:

    .. testcode::

        import numpy as np
        import megengine.functional as F
        from megengine import tensor

        inp = tensor(np.zeros(shape=(3,5),dtype=np.float32))
        source = tensor([[0.9935,0.9465,0.2256,0.8926,0.4396],[0.7723,0.0718,0.5939,0.357,0.4576]])
        index = tensor([[0,2,0,2,1],[2,0,1,1,2]])
        oup = F.scatter(inp, 0, index,source)
        print(oup.numpy())

    Outputs:

    .. testoutput::

        [[0.9935 0.0718 0.2256 0.     0.    ]
         [0.     0.     0.5939 0.357  0.4396]
         [0.7723 0.9465 0.     0.8926 0.4576]]

    """
    input_shape = inp.shape
    index_shape = index.shape
    source_shape = source.shape
    input_dims = len(input_shape)
    index_dims = len(index_shape)
    source_dims = len(source_shape)

    if input_dims != index_dims or input_dims != source_dims:
        raise ValueError("The input, source and index tensor must have same dimensions")

    if axis < 0 or axis >= input_dims:
        raise ValueError(
            "Index axis {} is output of bounds, should in range [0 {})".format(
                axis, input_dims
            )
        )

    for i in range(source_dims):
        if source_shape[i] > input_shape[i]:
            raise ValueError(
                "The each shape size for source {} must be less than or equal to input {} ".format(
                    source_shape, input_shape
                )
            )

    for i in range(index_dims):
        if index_shape[i] != source_shape[i]:
            raise ValueError(
                "The each shape size for index {} must be equal to source {} ".format(
                    index_shape, source_shape
                )
            )

    for i in range(index_dims):
        if i != axis and index_shape[i] > input_shape[i]:
            raise ValueError(
                "The index {} must be less than or equal to input {} size apart from axis {}".format(
                    index_shape, input_shape, axis
                )
            )

    idx = _get_idx(index, axis)
    inp[idx] = source.flatten()
    return inp


def where(mask: Tensor, x: Tensor, y: Tensor) -> Tensor:
578 579
    r"""
    Selects elements either from Tensor x or Tensor y, according to mask.
580 581 582 583 584

    .. math::

        \textrm{out}_i = x_i \textrm{ if } \textrm{mask}_i \textrm{ is True else } y_i

M
Megvii Engine Team 已提交
585
    :param mask: a mask used for choosing ``x`` or ``y``.
586 587 588
    :param x: first choice.
    :param y: second choice.
    :return: output tensor.
589 590 591 592 593 594 595

    Examples:

    .. testcode::

        from megengine import tensor
        import megengine.functional as F
596
        mask = tensor(np.array([[True, False], [False, True]], dtype=np.bool))
597 598 599 600 601 602 603 604 605 606 607 608 609
        x = tensor(np.array([[1, np.inf], [np.nan, 4]],
            dtype=np.float32))
        y = tensor(np.array([[5, 6], [7, 8]], dtype=np.float32))
        out = F.where(mask, x, y)
        print(out.numpy())

    Outputs:

    .. testoutput::

        [[1. 6.]
         [7. 4.]]
    """
610 611

    x, y = convert_inputs(x, y)
612
    if not isinstance(x, Tensor):
613
        raise TypeError("input x must be a tensor")
614
    if not isinstance(y, Tensor):
615
        raise TypeError("input y must be a tensor")
616
    if not isinstance(mask, Tensor):
617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636
        raise TypeError("mask must be a tensor")
    if mask.dtype != np.bool_:
        raise ValueError("mask must be bool")
    if x.device != mask.device:
        raise ValueError("ambiguous device: {} vs {}".format(x.device, mask.device))

    v0, index0 = cond_take(mask, x)
    v1, index1 = cond_take(~mask, y)

    if v0.shape == (0,):
        out = v1
    elif v1.shape == (0,):
        out = v0
    else:
        out = concat([v0, v1])

    out[index0] = v0
    out[index1] = v1
    out = out.reshape(x.shape)
    return out
637 638 639 640


def cond_take(mask: Tensor, x: Tensor) -> Tensor:
    r"""
M
Megvii Engine Team 已提交
641
    Takes elements from data if specific condition is satisfied on mask.
642 643 644
    This operator has two outputs: the first is the elements taken,
    and the second is the indices corresponding to those elements;
    they are both 1-dimensional. High-dimension input would first be flattened.
645

646 647
    :param mask: condition param; must be the same shape with data.
    :param x: input tensor from which to take elements.
648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665

    Examples:

    .. testcode::

        import numpy as np
        from megengine import tensor
        import megengine.functional as F
        mask = tensor(np.array([[True, False], [False, True]], dtype=np.bool_))
        x = tensor(np.array([[1, np.inf], [np.nan, 4]],
            dtype=np.float32))
        v, index = F.cond_take(mask, x)
        print(v.numpy(), index.numpy())

    Outputs:

    .. testoutput::

M
Megvii Engine Team 已提交
666
        [1. 4.] [0 3]
667 668

    """
669
    if not isinstance(x, Tensor):
670
        raise TypeError("input must be a tensor")
671
    if not isinstance(mask, Tensor):
672 673 674 675 676 677 678 679 680 681 682
        raise TypeError("mask must be a tensor")
    if mask.dtype != np.bool_:
        raise ValueError("mask must be bool")
    if x.device != mask.device:
        raise ValueError("ambiguous device: {} vs {}".format(x.device, mask.device))

    op = builtin.CondTake()
    v, index = apply(op, x, mask)
    return v, index


683
def transpose(inp: Tensor, pattern: Iterable[int]) -> Tensor:
684
    r"""
685
    Swaps shapes and strides according to given pattern.
686

687
    :param inp: input tensor.
688
    :param pattern: a list of integers including 0, 1, ... , ``ndim``-1,
689
    and any number of ``'x'`` char in dimensions where this tensor should be broadcasted. For examples:
690 691 692 693 694 695 696 697 698

        * (``'x'``) -> make a 0d (scalar) into a 1d vector
        * (0, 1) -> identity for 2d vectors
        * (1, 0) -> inverts the first and second dimensions
        * (``'x'``, 0) -> make a row out of a 1d vector (N to 1xN)
        * (0, ``'x'``) -> make a column out of a 1d vector (N to Nx1)
        * (2, 0, 1) -> AxBxC to CxAxB
        * (0, ``'x'``, 1) -> AxB to Ax1xB
        * (1, ``'x'``, 0) -> AxB to Bx1xA
M
Megvii Engine Team 已提交
699
        * (1,) -> this removes dimensions 0. It must be a broadcastable dimension (1xA to A)
700

701
    :return: output tensor.
702 703 704 705 706 707 708 709 710

    Examples:

    .. testcode::

        import numpy as np
        from megengine import tensor
        import megengine.functional as F
        x = tensor(np.array([[1, 1], [0, 0]], dtype=np.int32))
711
        out = F.transpose(x, (1, 0))
712 713 714 715 716 717 718 719 720 721
        print(out.numpy())

    Outputs:

    .. testoutput::

        [[1 0]
         [1 0]]

    """
722
    return inp.transpose(list(-1 if _ == "x" else _ for _ in pattern))
723 724 725 726


def reshape(inp: Tensor, target_shape: Iterable[int]) -> Tensor:
    r"""
727
    Reshapes a tensor to given target shape; total number of logical elements must
728 729
    remain unchanged

730
    :param inp: input tensor.
M
Megvii Engine Team 已提交
731
    :param target_shape: target shape, it can contain an element of -1 representing ``unspec_axis``.
732 733 734 735 736 737 738 739 740

    Examples:

    .. testcode::

        import numpy as np
        from megengine import tensor
        import megengine.functional as F
        x = tensor(np.arange(12, dtype=np.int32))
741
        out = F.reshape(x, (3, 4))
742 743 744 745 746 747
        print(out.numpy())

    Outputs:

    .. testoutput::

748 749 750
        [[ 0  1  2  3]
         [ 4  5  6  7]
         [ 8  9 10 11]]
751 752

    """
753
    return inp.reshape(target_shape)
754 755


756
def flatten(inp: Tensor, start_axis: int = 0, end_axis: int = -1) -> Tensor:
757 758
    r"""
    Reshapes the tensor by flattening the sub-tensor from dimension ``start_axis`` to dimension ``end_axis``.
759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794

    :param inp: input tensor.
    :param start_axis: start dimension that the sub-tensor to be flattened. Default: 0
    :param end_axis: end dimension that the sub-tensor to be flattened. Default: -1
    :return: output tensor.

    Examples:

    .. testcode::

        import numpy as np
        from megengine import tensor
        import megengine.functional as F

        inp_shape = (2, 2, 3, 3)
        x = tensor(
            np.arange(36, dtype=np.int32).reshape(inp_shape),
        )
        out = F.flatten(x, 2)
        print(x.numpy().shape)
        print(out.numpy().shape)

    Outputs:

    .. testoutput::

        (2, 2, 3, 3)
        (2, 2, 9)

    """
    target_shape = tuple(inp.shape[i] for i in range(start_axis)) + (-1,)
    if end_axis != -1:
        target_shape += (*inp.shape[end_axis + 1 :],)
    return inp.reshape(*target_shape)


795
def expand_dims(inp: Tensor, axis: Union[int, Sequence[int]]) -> Tensor:
796
    r"""
797
    Adds dimension before given axis.
798

799 800 801
    :param inp: input tensor.
    :param axis: place of new axes.
    :return: output tensor.
802 803 804 805 806 807 808 809

    Examples:

    .. testcode::

        import numpy as np
        from megengine import tensor
        import megengine.functional as F
810

811
        x = tensor([1, 2])
812
        out = F.expand_dims(x, 0)
813
        print(out.numpy().shape)
814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833

    Outputs:

    .. testoutput::

        (1, 2)

    """

    def get_axes():
        try:
            return [int(axis)]
        except (TypeError, ValueError):
            pass
        return list(map(int, axis))

    axis = get_axes()
    ndim = inp.ndim + len(axis)
    axis = sorted(i + ndim if i < 0 else i for i in axis)

834
    op = builtin.AddAxis(axis=axis)
835 836 837 838
    (result,) = apply(op, inp)
    return result


839
def squeeze(inp: Tensor, axis: Optional[Union[int, Sequence[int]]] = None) -> Tensor:
840
    r"""
841
    Removes dimension of shape 1.
842

843 844 845
    :param inp: input tensor.
    :param axis: place of axis to be removed.
    :return: output tensor.
846 847 848 849 850 851 852 853

    Examples:

    .. testcode::

        import numpy as np
        from megengine import tensor
        import megengine.functional as F
854

855
        x = tensor(np.array([1, 2], dtype=np.int32).reshape(1, 1, 2, 1))
856
        out = F.squeeze(x, 3)
857
        print(out.numpy().shape)
858 859 860 861 862 863 864 865

    Outputs:

    .. testoutput::

        (1, 1, 2)

    """
866
    return _remove_axis(inp, axis)
867 868 869 870 871 872 873 874 875


def linspace(
    start: Union[int, float, Tensor],
    stop: Union[int, float, Tensor],
    num: Union[int, Tensor],
    dtype="float32",
    device: Optional[CompNode] = None,
) -> Tensor:
876 877
    r"""
    Returns equally spaced numbers over a specified interval.
878

879 880 881 882 883
    :param start: starting value of the squence, shoule be scalar.
    :param stop: last value of the squence, shoule be scalar.
    :param num: number of values to generate.
    :param dtype: result data type.
    :return: generated tensor.
884 885 886 887 888 889 890 891 892 893 894

    Examples:

    .. testcode::

        import numpy as np
        import megengine.functional as F

        a = F.linspace(3,10,5)
        print(a.numpy())

M
Megvii Engine Team 已提交
895
    Outputs:
896

897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913
    .. testoutput::

        [ 3.    4.75  6.5   8.25 10.  ]

    """
    start = Tensor(start, device=device)
    stop = Tensor(stop, device=device)
    num = Tensor(num, device=device)

    op = builtin.Linspace(comp_node=device)
    (result,) = apply(op, start, stop, num)
    if np.dtype(dtype) == np.int32:
        return result.astype(dtype)
    return result


def arange(
914
    start: Union[int, float, Tensor] = 0,
915
    stop: Optional[Union[int, float, Tensor]] = None,
916 917 918 919
    step: Union[int, float, Tensor] = 1,
    dtype="float32",
    device: Optional[CompNode] = None,
) -> Tensor:
920 921
    r"""
    Returns a tensor with values from start to stop with adjacent interval step.
922

923
    :param start: starting value of the squence, shoule be scalar.
924
    :param stop: ending value of the squence, shoule be scalar.
925 926 927
    :param step: gap between each pair of adjacent values. Default: 1
    :param dtype: result data type.
    :return: generated tensor.
928 929 930 931 932 933 934 935

    Examples:

    .. testcode::

        import numpy as np
        import megengine.functional as F

936
        a = F.arange(5)
937
        print(a.numpy())
938

M
Megvii Engine Team 已提交
939
    Outputs:
940

941 942
    Outputs:

943 944
    .. testoutput::

945
        [0. 1. 2. 3. 4.]
946 947

    """
948 949
    if stop is None:
        start, stop = 0, start
950

951 952
    if isinstance(start, Tensor):
        start = start.astype("float32")
953 954
    if isinstance(stop, Tensor):
        stop = stop.astype("float32")
955 956
    if isinstance(step, Tensor):
        step = step.astype("float32")
957
    num = ceil(Tensor((stop - start) / step, device=device))
958 959 960 961 962
    stop = start + step * (num - 1)
    result = linspace(start, stop, num, device=device)
    if np.dtype(dtype) == np.int32:
        return result.astype(dtype)
    return result