Add detailed ConvBERT model card with usage, architecture, and refere…#38470
Open
Aesha19 wants to merge 1 commit intohuggingface:mainfrom
Open
Add detailed ConvBERT model card with usage, architecture, and refere…#38470Aesha19 wants to merge 1 commit intohuggingface:mainfrom
Aesha19 wants to merge 1 commit intohuggingface:mainfrom
Conversation
Author
|
Hi! This is my first contribution — just checking in kindly for a review |
stevhliu
reviewed
Jun 2, 2025
| @@ -0,0 +1,125 @@ | |||
| <!-- ConvBERT model card --> | |||
Member
There was a problem hiding this comment.
You don't have to remove this
Suggested change
| <!-- ConvBERT model card --> | |
| <!--Copyright 2020 The HuggingFace Team. 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. | |
| ⚠️ Note that this file is in Markdown but contain specific syntax for our doc-builder (similar to MDX) that may not be | |
| rendered properly in your Markdown viewer. | |
| --> |
Comment on lines
+5
to
+9
| <div style="float: right;"> | ||
| <div class="flex flex-wrap space-x-1"> | ||
| <img alt="PyTorch" src="https://img.shields.io/badge/PyTorch-DE3412?style=flat&logo=pytorch&logoColor=white"> | ||
| </div> | ||
| </div> |
Member
There was a problem hiding this comment.
Missing the TensorFlow badge and this should go above # ConvBERT
Comment on lines
+11
to
+13
| --- | ||
|
|
||
| ## Model Overview |
Member
There was a problem hiding this comment.
Suggested change
| --- | |
| ## Model Overview |
|
|
||
| ## Model Overview | ||
|
|
||
| ConvBERT is a lightweight and efficient NLP transformer model introduced by YituTech. It improves on the classic BERT architecture by incorporating **span-based dynamic convolutions** into the self-attention mechanism. This hybrid approach enables ConvBERT to model both local and global dependencies more effectively while reducing the computational cost. |
Member
There was a problem hiding this comment.
Suggested change
| ConvBERT is a lightweight and efficient NLP transformer model introduced by YituTech. It improves on the classic BERT architecture by incorporating **span-based dynamic convolutions** into the self-attention mechanism. This hybrid approach enables ConvBERT to model both local and global dependencies more effectively while reducing the computational cost. | |
| [ConvBERT](https://huggingface.co/papers/2008.02496) incorporates a mixed attention block that makes it more efficient than [BERT](./bert). Attention is costly because it models global word relationships. This is inefficient because some heads only learn local word relationships. ConvBERT replaces some of the attention heads with a convolution head to handle this. The result of this new mixed attention design is a more lightweight model with lower training costs without compromising performance. | |
| Instead of using attention heads everywhere to model , ConvBERT also includes convolution heads to model local word relationships. | |
| is a lightweight and efficient NLP transformer model introduced by YituTech. It improves on the classic BERT architecture by incorporating **span-based dynamic convolutions** into the self-attention mechanism. This hybrid approach enables ConvBERT to model both local and global dependencies more effectively while reducing the computational cost. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What does this PR do?
This PR adds a detailed and standardized model card for ConvBERT to improve Hugging Face Transformers documentation.
Includes:
pipeline,AutoModel, and CLIFile added:
src/transformers/models/convbert/modelcard.mdThis contribution helps improve model discoverability and provides users with accessible and actionable information about ConvBERT.
cc: @stevhliu (documentation reviewer)
Fixes: N/A