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 6 commits into
base: main
Choose a base branch
from
Open

Add ONNX export support for PatchTST #2101

wants to merge 6 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.

Copy link
Member

@michaelbenayoun michaelbenayoun left a comment

Choose a reason for hiding this comment

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

LGTM!

Let's wait for @echarlaix 's review before merging.

Copy link
Collaborator

@echarlaix echarlaix left a comment

Choose a reason for hiding this comment

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

Looks great, thank you so much @xenova for all the great work!

Comment on lines +260 to +261
"patchtst": "ibm/test-patchtst",
"patchtsmixer": "ibm/test-patchtsmixer",
Copy link
Collaborator

Choose a reason for hiding this comment

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

already included in PYTORCH_EXPORT_MODELS_TINY so can be removed

Suggested change
"patchtst": "ibm/test-patchtst",
"patchtsmixer": "ibm/test-patchtsmixer",

Comment on lines +317 to +320
("pt", "patchtsmixer", "feature-extraction"): ("transformers", "PatchTSMixerModel"),
("pt", "patchtsmixer", "time-series-forecasting"): ("transformers", "PatchTSMixerForPrediction"),
("pt", "patchtst", "feature-extraction"): ("transformers", "PatchTSTModel"),
("pt", "patchtst", "time-series-forecasting"): ("transformers", "PatchTSTForPrediction"),
Copy link
Collaborator

Choose a reason for hiding this comment

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

shouldn't AutoModel load the models as expected https://huggingface.co/datasets/huggingface/transformers-metadata/blob/main/pipeline_tags.json#L666-L667 ?

Suggested change
("pt", "patchtsmixer", "feature-extraction"): ("transformers", "PatchTSMixerModel"),
("pt", "patchtsmixer", "time-series-forecasting"): ("transformers", "PatchTSMixerForPrediction"),
("pt", "patchtst", "feature-extraction"): ("transformers", "PatchTSTModel"),
("pt", "patchtst", "time-series-forecasting"): ("transformers", "PatchTSTForPrediction"),
("pt", "patchtsmixer", "time-series-forecasting"): ("transformers", "PatchTSMixerForPrediction"),
("pt", "patchtst", "time-series-forecasting"): ("transformers", "PatchTSTForPrediction"),

@@ -177,6 +177,7 @@ class OnnxConfig(ExportConfig, ABC):
"text2text-generation": OrderedDict({"logits": {0: "batch_size", 1: "decoder_sequence_length"}}),
"text-classification": OrderedDict({"logits": {0: "batch_size"}}),
"text-generation": OrderedDict({"logits": {0: "batch_size", 1: "sequence_length"}}),
"time-series-forecasting": OrderedDict({"prediction_outputs": {0: "batch_size"}}),
Copy link
Collaborator

Choose a reason for hiding this comment

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

I can't find "time-series-forecasting" in https://huggingface.co/datasets/huggingface/transformers-metadata/blob/main/pipeline_tags.json, do you know if this specific to PatchTST models ? (-> PatchTSTXxxForPrediction)

@@ -2445,3 +2446,51 @@ class EncoderDecoderOnnxConfig(EncoderDecoderBaseOnnxConfig):
NORMALIZED_CONFIG_CLASS = NormalizedEncoderDecoderConfig

DEFAULT_ONNX_OPSET = 14 # uses SDPA in Transformers, hence opset>=14.


class PatchTSTDummyInputGenerator(DummyInputGenerator):
Copy link
Collaborator

Choose a reason for hiding this comment

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

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
4 participants