Skip to content

Update model-card for Autofomer#37231

Open
AnupKulkarniVK wants to merge 2 commits intohuggingface:mainfrom
AnupKulkarniVK:AnupKulkarniVK-Update-autoformer-model-card
Open

Update model-card for Autofomer#37231
AnupKulkarniVK wants to merge 2 commits intohuggingface:mainfrom
AnupKulkarniVK:AnupKulkarniVK-Update-autoformer-model-card

Conversation

@AnupKulkarniVK
Copy link
Copy Markdown

@AnupKulkarniVK AnupKulkarniVK commented Apr 3, 2025

What does this PR do?

Fixes # (issue)

Before submitting

  • This PR fixes a typo or improves the docs (you can dismiss the other checks if that's the case).
  • Did you read the contributor guideline,
    Pull Request section?
  • Was this discussed/approved via a Github issue or the forum? Please add a link
    to it if that's the case.
  • Did you make sure to update the documentation with your changes? Here are the
    documentation guidelines, and
    here are tips on formatting docstrings.
  • Did you write any new necessary tests?

Who can review?

Anyone in the community is free to review the PR once the tests have passed. Feel free to tag
members/contributors who may be interested in your PR.

@github-actions github-actions Bot marked this pull request as draft April 3, 2025 02:20
@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Apr 3, 2025

Hi 👋, thank you for opening this pull request! The pull request is converted to draft by default. The CI will be paused while the PR is in draft mode. When it is ready for review, please click the Ready for review button (at the bottom of the PR page). This will assign reviewers and trigger CI.

@AnupKulkarniVK AnupKulkarniVK marked this pull request as ready for review April 17, 2025 04:47
@github-actions github-actions Bot requested a review from stevhliu April 17, 2025 04:48
Copy link
Copy Markdown
Member

@stevhliu stevhliu left a comment

Choose a reason for hiding this comment

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

Nice work, excited to have our first updated time-series model card! 🎉

Comment thread docs/source/en/model_doc/autoformer.md Outdated
Comment thread docs/source/en/model_doc/autoformer.md Outdated
Comment thread docs/source/en/model_doc/autoformer.md Outdated
> [!TIP]
> Click on the Autoformer model cards in the right sidebar to explore more examples and use cases like weather or energy time series forecasting.

The example below demonstrates how to generate text with [`Pipeline`], [`AutoModel`]
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Suggested change
The example below demonstrates how to generate text with [`Pipeline`], [`AutoModel`]
The example below demonstrates how to make a prediction with [`AutoformerForPrediction`].

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Not resolved yet! I think its better to leave it as how to make a prediction since the docs don't explicitly show how to use it for things like weather and energy

Comment thread docs/source/en/model_doc/autoformer.md Outdated
Comment thread docs/source/en/model_doc/autoformer.md Outdated
</hfoptions>

The abstract from the paper is the following:
Quantization
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Lets also remove the Quantization content and Attention Mask Visualization stuff since none of that is supported either

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

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

Done

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

This hasn't been removed yet!

Comment thread docs/source/en/model_doc/autoformer.md Outdated
Comment thread docs/source/en/model_doc/autoformer.md Outdated
Comment thread docs/source/en/model_doc/autoformer.md Outdated
Comment thread docs/source/en/model_doc/autoformer.md
@AnupKulkarniVK
Copy link
Copy Markdown
Author

AnupKulkarniVK commented Apr 18, 2025

@stevhliu took care of the review comments. Please take a look. Thanks

Copy link
Copy Markdown
Member

@stevhliu stevhliu left a comment

Choose a reason for hiding this comment

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

Thanks, just a few more unresolved changes and then we can merge!

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.

2 participants