Skip to content
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

Add ONNX export support for PatchTST #2101

Open
wants to merge 5 commits into
base: main
Choose a base branch
from
Open

Add ONNX export support for PatchTST #2101

wants to merge 5 commits into from

Conversation

xenova
Copy link
Contributor

@xenova xenova commented Nov 21, 2024

What does this PR do?

This PR adds ONNX export support for PatchTST models, as well as fixes other models that contain the torch.unfold operator, which is not supported by torch.onnx.export. This is done by applying a set of default patching specs.

Fixes huggingface/transformers.js#1047

Before submitting

  • This PR fixes a typo or improves the docs (you can dismiss the other checks if that's the case).
  • Did you make sure to update the documentation with your changes?
  • Did you write any new necessary tests?

Who can review?

@michaelbenayoun, @echarlaix

@HuggingFaceDocBuilderDev

The docs for this PR live here. All of your documentation changes will be reflected on that endpoint. The docs are available until 30 days after the last update.

Comment on lines +119 to +124
def onnx_compatible_unfold(self, dimension, size, step):
num_patches = (self.size(dimension) - size) // step + 1
return torch.stack(
[self[:, i : i + size, :] for i in range(0, num_patches * step, step)],
dim=1,
).transpose(3, 2)
Copy link
Contributor Author

@xenova xenova Nov 28, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I ran into some issues with my naive attempt (only seems to work for 4D). Here's a better version I found:

Suggested change
def onnx_compatible_unfold(self, dimension, size, step):
num_patches = (self.size(dimension) - size) // step + 1
return torch.stack(
[self[:, i : i + size, :] for i in range(0, num_patches * step, step)],
dim=1,
).transpose(3, 2)
def onnx_compatible_unfold(input_tensor, dimension, size, step):
"""
Custom implementation of torch.unfold without using torch.unfold.
Args:
input_tensor (torch.Tensor): The input tensor.
dimension (int): The dimension to unfold.
size (int): The size of each slice.
step (int): The step size between slices.
Returns:
torch.Tensor: The unfolded tensor.
"""
# Compute the shape of the unfolded output
input_size = input_tensor.size(dimension)
num_slices = (input_size - size) // step + 1
# Permute dimension to the end for easier indexing
input_tensor = input_tensor.transpose(dimension, -1)
# Extract slices
slices = []
for i in range(num_slices):
start = i * step
end = start + size
slices.append(input_tensor[..., start:end])
# Stack slices and permute dimensions back
result = torch.stack(slices, dim=-2).transpose(dimension, -2)
return result

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

PatchTSTModel, PatchTSTConfig, & Trainer
2 participants