Skip to content

implement of leftpadding #2242

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 9 commits into from
May 28, 2025
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 14 additions & 4 deletions keras_hub/src/layers/preprocessing/start_end_packer.py
Original file line number Diff line number Diff line change
Expand Up @@ -111,6 +111,7 @@ def __init__(
pad_value=None,
return_padding_mask=False,
name=None,
padding_side="right",
**kwargs,
):
super().__init__(name=name, **kwargs)
Expand Down Expand Up @@ -139,6 +140,7 @@ def check_special_value_type(value, value_name):

self.pad_value = pad_value
self.return_padding_mask = return_padding_mask
self.padding_side = padding_side

@preprocessing_function
def call(
Expand Down Expand Up @@ -172,10 +174,17 @@ def call(
x = tf.concat([x, end_token_id_tensor], axis=-1)

# Pad to desired length.
outputs = x.to_tensor(
default_value=self.pad_value,
shape=(batch_size, sequence_length),
)
if self.padding_side == "left":
outputs = x[..., ::-1].to_tensor(
default_value=self.pad_value,
shape=(batch_size, sequence_length),
)
outputs = outputs[..., ::-1]
else:
outputs = x.to_tensor(
default_value=self.pad_value,
shape=(batch_size, sequence_length),
)
outputs = tf.squeeze(outputs, axis=0) if unbatched else outputs

if self.return_padding_mask:
Expand All @@ -195,6 +204,7 @@ def get_config(self):
"end_value": self._end_value,
"pad_value": self.pad_value,
"return_padding_mask": self.return_padding_mask,
"padding_side": self.padding_side,
}
)
return config
Expand Down
103 changes: 103 additions & 0 deletions keras_hub/src/layers/preprocessing/start_end_packer_test.py
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,19 @@

class StartEndPackerTest(TestCase):
def test_dense_input(self):
# right padding
input_data = [5, 6, 7]
start_end_packer = StartEndPacker(sequence_length=5)
output = start_end_packer(input_data)
expected_output = [5, 6, 7, 0, 0]
self.assertAllEqual(output, expected_output)
# left padding
start_end_packer = StartEndPacker(
sequence_length=5, padding_side="left"
)
output = start_end_packer(input_data)
expected_output = [0, 0, 5, 6, 7]
self.assertAllEqual(output, expected_output)

def test_bfloat16_dtype(self):
# Core Keras has a strange bug where it converts int to floats in
Expand All @@ -21,29 +29,54 @@ def test_bfloat16_dtype(self):
self.assertDTypeEqual(output, "int32")

def test_dense_2D_input(self):
# right padding
input_data = [[5, 6, 7]]
start_end_packer = StartEndPacker(sequence_length=5)
output = start_end_packer(input_data)
expected_output = [[5, 6, 7, 0, 0]]
self.assertAllEqual(output, expected_output)
# left padding
start_end_packer = StartEndPacker(
sequence_length=5, padding_side="left"
)
output = start_end_packer(input_data)
expected_output = [[0, 0, 5, 6, 7]]
self.assertAllEqual(output, expected_output)

def test_ragged_input(self):
# right padding
input_data = [[5, 6, 7], [8, 9, 10, 11]]
start_end_packer = StartEndPacker(sequence_length=5)
output = start_end_packer(input_data)
expected_output = [[5, 6, 7, 0, 0], [8, 9, 10, 11, 0]]
self.assertAllEqual(output, expected_output)
# left padding
start_end_packer = StartEndPacker(
sequence_length=5, padding_side="left"
)
output = start_end_packer(input_data)
expected_output = [[0, 0, 5, 6, 7], [0, 8, 9, 10, 11]]
self.assertAllEqual(output, expected_output)

def test_start_end_token(self):
# right padding
input_data = [[5, 6, 7], [8, 9, 10, 11]]
start_end_packer = StartEndPacker(
sequence_length=6, start_value=1, end_value=2
)
output = start_end_packer(input_data)
expected_output = [[1, 5, 6, 7, 2, 0], [1, 8, 9, 10, 11, 2]]
self.assertAllEqual(output, expected_output)
# left padding
start_end_packer = StartEndPacker(
sequence_length=6, start_value=1, end_value=2, padding_side="left"
)
output = start_end_packer(input_data)
expected_output = [[0, 1, 5, 6, 7, 2], [1, 8, 9, 10, 11, 2]]
self.assertAllEqual(output, expected_output)

def test_multiple_start_end_tokens(self):
# right padding
input_data = [[5, 6, 7], [8, 9, 10, 11, 12, 13]]
start_end_packer = StartEndPacker(
sequence_length=8,
Expand All @@ -55,7 +88,20 @@ def test_multiple_start_end_tokens(self):
expected_output = [[1, 2, 5, 6, 7, 3, 4, 0], [1, 2, 8, 9, 10, 11, 3, 4]]
self.assertAllEqual(output, expected_output)

# left padding
start_end_packer = StartEndPacker(
sequence_length=8,
start_value=[1, 2],
end_value=[3, 4],
pad_value=0,
padding_side="left",
)
output = start_end_packer(input_data)
expected_output = [[0, 1, 2, 5, 6, 7, 3, 4], [1, 2, 8, 9, 10, 11, 3, 4]]
self.assertAllEqual(output, expected_output)

def test_start_end_padding_value(self):
# right padding
input_data = [[5, 6, 7], [8, 9, 10, 11]]
start_end_packer = StartEndPacker(
sequence_length=7, start_value=1, end_value=2, pad_value=3
Expand All @@ -64,7 +110,20 @@ def test_start_end_padding_value(self):
expected_output = [[1, 5, 6, 7, 2, 3, 3], [1, 8, 9, 10, 11, 2, 3]]
self.assertAllEqual(output, expected_output)

# left padding
start_end_packer = StartEndPacker(
sequence_length=7,
start_value=1,
end_value=2,
pad_value=3,
padding_side="left",
)
output = start_end_packer(input_data)
expected_output = [[3, 3, 1, 5, 6, 7, 2], [3, 1, 8, 9, 10, 11, 2]]
self.assertAllEqual(output, expected_output)

def test_end_token_value_during_truncation(self):
# right padding
input_data = [[5, 6], [8, 9, 10, 11, 12, 13]]
start_end_packer = StartEndPacker(
sequence_length=5, start_value=1, end_value=2, pad_value=0
Expand All @@ -73,7 +132,20 @@ def test_end_token_value_during_truncation(self):
expected_output = [[1, 5, 6, 2, 0], [1, 8, 9, 10, 2]]
self.assertAllEqual(output, expected_output)

# left padding
start_end_packer = StartEndPacker(
sequence_length=5,
start_value=1,
end_value=2,
pad_value=0,
padding_side="left",
)
output = start_end_packer(input_data)
expected_output = [[0, 1, 5, 6, 2], [1, 8, 9, 10, 2]]
self.assertAllEqual(output, expected_output)

def test_string_input(self):
# right padding
input_data = [["KerasHub", "is", "awesome"], ["amazing"]]
start_end_packer = StartEndPacker(
sequence_length=5,
Expand All @@ -88,7 +160,23 @@ def test_string_input(self):
]
self.assertAllEqual(output, expected_output)

# left padding
start_end_packer = StartEndPacker(
sequence_length=5,
start_value="[START]",
end_value="[END]",
pad_value="[PAD]",
padding_side="left",
)
output = start_end_packer(input_data)
expected_output = [
["[START]", "KerasHub", "is", "awesome", "[END]"],
["[PAD]", "[PAD]", "[START]", "amazing", "[END]"],
]
self.assertAllEqual(output, expected_output)

def test_string_input_with_multiple_special_values(self):
# right padding
input_data = [["KerasHub", "is", "awesome"], ["amazing"]]
start_end_packer = StartEndPacker(
sequence_length=6,
Expand All @@ -103,6 +191,21 @@ def test_string_input_with_multiple_special_values(self):
]
self.assertAllEqual(output, expected_output)

# left padding
start_end_packer = StartEndPacker(
sequence_length=6,
start_value=["[END]", "[START]"],
end_value="[END]",
pad_value="[PAD]",
padding_side="left",
)
output = start_end_packer(input_data)
expected_output = [
["[END]", "[START]", "KerasHub", "is", "awesome", "[END]"],
["[PAD]", "[PAD]", "[END]", "[START]", "amazing", "[END]"],
]
self.assertAllEqual(output, expected_output)

def test_special_token_dtype_error(self):
with self.assertRaises(ValueError):
StartEndPacker(sequence_length=5, start_value=1.0)
Expand Down
Loading