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.

Sign up for GitHub

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

Jump to bottom

Added resources for albert architecture #20717

Closed

JuheonChu wants to merge 13 commits into huggingface:main from JuheonChu:Added-resources-for-ALBERT-Architecture

Contributor

JuheonChu commented Dec 10, 2022 •

edited

Loading

What does this PR do?

Co-authored-by: Adia Wu [email protected]
Co-authored-by: Mollerup23 [email protected]

Fixes #20055

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?

@stevhliu @younesbelkada

Juheon Chu and others added 2 commits

December 9, 2022 19:31


          Added Transformers resources for ALBERT

247c3a6

Co-authored-by: Adia Wu <[email protected]>
Co-authored-by: mollerup23 <[email protected]>


          Merge branch 'Added-resources-for-ALBERT-Architecture' of https://git…

90703a5

…hub.com/JuheonChu/transformers into Added-resources-for-ALBERT-Architecture

Contributor Author

JuheonChu commented Dec 10, 2022

I tried
pip install ".[docs]"
doc-builder build transformers .\docs\source\en\model_doc\albert.mdx --build_dir ~/tmp/test-build
to pass the currently failing Build PR Documentation CI/CD test.
However, I still fail. May I ask for any further suggestion?

Contributor

AdiaWu commented Dec 12, 2022

@michaelbenayoun ,
Hello, this is Adia who is one of the co-authors of this PR. Do you mind if I ask for any suggestion to solve Build PR Documentation / build / build_pr_documentation (pull_request) CI/CD test? Thank you very much for your time.

Best,
Adia Wu

Member

michaelbenayoun commented Dec 12, 2022 •

edited

Loading

Hi,
Not a specialist on the doc-builder but why did you inline all the [[autodoc]] lines? Also this seems weird, here the plan is to document the __call__ method, not to put call in bold.

Contributor Author

JuheonChu commented Dec 12, 2022

Hello @michaelbenayoun, I think auto-formatting with Visual Studio Code resulted in inlining those [[autodoc]] code blocks. Do you think it is better to change those parts?


          Update albert.mdx

16b77bc

Member

michaelbenayoun commented Dec 12, 2022

You should set it back to the original version.

michaelbenayoun reviewed

View reviewed changes

docs/source/en/model_doc/albert.mdx Outdated

               ## AlbertModel
-              [[autodoc]] AlbertModel
+              [[autodoc]] AlbertModel

Member

michaelbenayoun Dec 12, 2022

nit: remove the line breaks


          Removed the line breaks

f7124dc

stevhliu reviewed

View reviewed changes

Member

stevhliu left a comment

Thanks for the new PR! 🙂

Please keep all the original formatting, or else you may find that the Build PR documentation job fails. For an example of what the finished page should look like, feel free to check out the BERT resources section and you can copy and paste some of the relevant notebook and script links from there.

docs/source/en/model_doc/albert.mdx Outdated Show resolved Hide resolved

docs/source/en/model_doc/albert.mdx Outdated Show resolved Hide resolved

docs/source/en/model_doc/albert.mdx Outdated Show resolved Hide resolved

docs/source/en/model_doc/albert.mdx Outdated Show resolved Hide resolved

docs/source/en/model_doc/albert.mdx

Comment on lines +50 to +57

+              <PipelineTag pipeline="introduce" />
+              - A blog post on [Getting Started with ALBERT](https://huggingface.co/albert-base-v2).
+              - A blog post on [Albert-base-v2](https://huggingface.co/albert-base-v2).
+              - A blog post on [albert-xlarge-v2](https://huggingface.co/albert-xlarge-v2).
+              - A blog post on [Chinese Albert](https://huggingface.co/uer/albert-base-chinese-cluecorpussmall).
+              - A blog post on [Albert-tiny](https://huggingface.co/clue/albert_chinese_tiny).
+              - An article about [ALBERT: A Lite BERT for Self-supervised Learning of Language
+              Representations](https://arxiv.org/abs/1909.11942).

Member

stevhliu Dec 12, 2022

Thanks for thinking outside the box here and suggesting an introduction section! But this isn't necessary since there is already an intro to ALBERT here with a link to the paper and abstract.

docs/source/en/model_doc/albert.mdx Outdated Show resolved Hide resolved

docs/source/en/model_doc/albert.mdx

+              <PipelineTag pipeline="text-recognition" />
+              - A notebook on [Finetune T5 for Named Entity Recognition](https://github.com/ToluClassics/Notebooks/blob/main/T5_Ner_Finetuning.ipynb).
+              <PipelineTag pipeline="token-classification" />

Member

stevhliu Dec 12, 2022

You can remove this whole section since none of the links are directly relevant.

docs/source/en/model_doc/albert.mdx Outdated Show resolved Hide resolved

docs/source/en/model_doc/albert.mdx Outdated Show resolved Hide resolved

docs/source/en/model_doc/albert.mdx Outdated Show resolved Hide resolved

JuheonChu and others added 9 commits

December 12, 2022 15:02


          Update docs/source/en/model_doc/albert.mdx

46558b4

Co-authored-by: Steven Liu <[email protected]>


          Update docs/source/en/model_doc/albert.mdx

879e529

Co-authored-by: Steven Liu <[email protected]>


          Keeping Original formatting

57a7325

Co-authored-by: Steven Liu <[email protected]>


          Removing the extra line

415c495

Co-authored-by: Steven Liu <[email protected]>


          Format with case-sensitivity

6d2e9d9

Co-authored-by: Steven Liu <[email protected]>


          Keep the original formatting

470ca80

Co-authored-by: Steven Liu <[email protected]>


          token-classification Pipeline tag

Co-authored-by: Steven Liu <[email protected]>


          remove the extra space

4b0b416

Co-authored-by: Steven Liu <[email protected]>


          Change to fill-mask

356ed7e

Co-authored-by: Steven Liu <[email protected]>

github-actions bot commented Jan 9, 2023

This issue has been automatically marked as stale because it has not had recent activity. If you think this still needs to be addressed please comment on this thread.

Please note that issues that do not follow the contributing guidelines are likely to be ignored.

github-actions bot closed this

JuheonChu deleted the Added-resources-for-ALBERT-Architecture branch

February 3, 2023 21:23

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet