paddlepaddle--paddle/test/sequence/test_sequence_mask.py

# Copyright (c) 2018 PaddlePaddle Authors. All Rights Reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#     http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

import sys
from pathlib import Path

# Add test/legacy_test to sys.path
test_dir = Path(__file__).resolve().parents[1]
sys.path.append(str(test_dir / "legacy_test"))

import unittest

import numpy as np
from op_test import OpTest

import paddle
from paddle.base.framework import (
    convert_nptype_to_vartype,
)


def sequence_mask_wrapper(x, maxlen_tensor=None, maxlen=-1, mask_dtype='int64'):
    if maxlen_tensor is not None:
        maxlen = maxlen_tensor
    return paddle.nn.functional.sequence_mask(
        x, maxlen=maxlen, dtype=mask_dtype
    )


class SequenceMaskTestBase(OpTest):
    def initDefaultParameters(self):
        self.op_type = 'sequence_mask'
        self.python_api = sequence_mask_wrapper
        self.maxlen = 10
        self.mask_dtype = 'int64'
        self.x = [[0, 3, 4], [5, 7, 9]]

    def initParameters(self):
        pass

    def setUp(self):
        self.initDefaultParameters()
        self.initParameters()
        if not isinstance(self.x, np.ndarray):
            self.x = np.array(self.x)

        self.inputs = {'X': self.x}
        self.outputs = {'Y': self.calc_ground_truth_mask()}
        self.attrs = {
            'maxlen': self.maxlen,
            'out_dtype': convert_nptype_to_vartype(self.mask_dtype),
        }

    def calc_ground_truth_mask(self):
        maxlen = np.max(self.x) if self.maxlen < 0 else self.maxlen
        shape = (*self.x.shape, maxlen)
        index_broadcast = np.broadcast_to(
            np.reshape(range(maxlen), [1] * self.x.ndim + [-1]),
            shape=shape,
        )
        x_broadcast = np.broadcast_to(
            np.reshape(
                self.x,
                (*self.x.shape, -1),
            ),
            shape=shape,
        )
        return (index_broadcast < x_broadcast).astype(self.mask_dtype)

    def test_check_output(self):
        self.check_output(check_pir=True)


class SequenceMaskTest1(SequenceMaskTestBase):
    def initParameters(self):
        self.mask_dtype = 'bool'


class SequenceMaskTest2(SequenceMaskTestBase):
    def initParameters(self):
        self.mask_dtype = 'uint8'


class SequenceMaskTest3(SequenceMaskTestBase):
    def initParameters(self):
        self.mask_dtype = 'int32'


class SequenceMaskTest4(SequenceMaskTestBase):
    def initParameters(self):
        self.mask_dtype = 'float32'


class SequenceMaskTest5(SequenceMaskTestBase):
    def initParameters(self):
        self.mask_dtype = 'float64'


class SequenceMaskTest6(SequenceMaskTestBase):
    def initParameters(self):
        self.maxlen = -1

    def test_check_output(self):
        self.check_output(check_pir=True, check_symbol_infer=False)


class SequenceMaskTestBase_tensor_attr(OpTest):
    def initDefaultParameters(self):
        self.op_type = 'sequence_mask'
        self.python_api = sequence_mask_wrapper
        self.maxlen = 10
        self.maxlen_tensor = np.ones((1), 'int32') * 10
        self.mask_dtype = 'int64'
        self.x = [[0, 3, 4], [5, 7, 9]]

    def initParameters(self):
        pass

    def setUp(self):
        self.initDefaultParameters()
        self.initParameters()
        if not isinstance(self.x, np.ndarray):
            self.x = np.array(self.x)

        self.inputs = {'X': self.x, 'MaxLenTensor': self.maxlen_tensor}
        self.outputs = {'Y': self.calc_ground_truth_mask()}
        self.attrs = {'out_dtype': convert_nptype_to_vartype(self.mask_dtype)}

    def calc_ground_truth_mask(self):
        maxlen = np.max(self.x) if self.maxlen < 0 else self.maxlen
        shape = (*self.x.shape, maxlen)
        index_broadcast = np.broadcast_to(
            np.reshape(range(maxlen), [1] * self.x.ndim + [-1]),
            shape=shape,
        )
        x_broadcast = np.broadcast_to(
            np.reshape(
                self.x,
                (*self.x.shape, -1),
            ),
            shape=shape,
        )
        return (index_broadcast < x_broadcast).astype(self.mask_dtype)

    def test_check_output(self):
        self.check_output(check_pir=True, check_symbol_infer=False)


class SequenceMaskTest1_tensor_attr(SequenceMaskTestBase_tensor_attr):
    def initParameters(self):
        self.mask_dtype = 'bool'


class SequenceMaskTest2_tensor_attr(SequenceMaskTestBase_tensor_attr):
    def initParameters(self):
        self.mask_dtype = 'uint8'


class SequenceMaskTest3_tensor_attr(SequenceMaskTestBase_tensor_attr):
    def initParameters(self):
        self.mask_dtype = 'int32'


class SequenceMaskTest4_tensor_attr(SequenceMaskTestBase_tensor_attr):
    def initParameters(self):
        self.mask_dtype = 'float32'


class SequenceMaskTest5_tensor_attr(SequenceMaskTestBase_tensor_attr):
    def initParameters(self):
        self.mask_dtype = 'float64'


class TestSequenceMaskOpError(unittest.TestCase):
    def test_errors(self):
        paddle.enable_static()
        with paddle.static.program_guard(
            paddle.static.Program(), paddle.static.Program()
        ):
            input_data = np.random.uniform(1, 5, [4]).astype("float32")

            def test_Variable():
                # the input must be Variable
                paddle.nn.functional.sequence_mask(input_data, maxlen=4)

            self.assertRaises(TypeError, test_Variable)
        paddle.disable_static()


class TestSequenceMaskWithEmptyTensor(unittest.TestCase):
    def test_empty(self):
        lengths = paddle.to_tensor(np.array([], dtype=np.int64))
        mask = paddle.nn.functional.sequence_mask(lengths)
        self.assertEqual(list(mask.shape), [0, 0])


class SequenceMaskTest_ZeroSize(OpTest):
    def initDefaultParameters(self):
        self.op_type = 'sequence_mask'
        self.python_api = sequence_mask_wrapper
        self.maxlen = 10
        self.mask_dtype = 'int64'
        self.x = np.random.random([0, 3]).astype('int64')
        self.y = np.random.random([0, 3, 10]).astype('int64')

    def initParameters(self):
        pass

    def setUp(self):
        self.initDefaultParameters()
        self.initParameters()
        if not isinstance(self.x, np.ndarray):
            self.x = np.array(self.x)

        self.inputs = {'X': self.x}
        self.outputs = {'Y': self.y}
        self.attrs = {
            'maxlen': self.maxlen,
            'out_dtype': convert_nptype_to_vartype(self.mask_dtype),
        }

    def test_check_output(self):
        self.check_output(check_pir=True)


if __name__ == '__main__':
    unittest.main()