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 Japanese translated README #19945

Merged
merged 6 commits into from
Nov 1, 2022
Merged

Conversation

eltociear
Copy link
Contributor

What does this PR do?

Add Japanese README

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.

@HuggingFaceDocBuilderDev
Copy link

HuggingFaceDocBuilderDev commented Oct 28, 2022

The documentation is not available anymore as the PR was closed or merged.

@sgugger
Copy link
Collaborator

sgugger commented Oct 28, 2022

Thanks for adding this new translation! @younesbelkada do you want to give it a quick proofreading?
Also @eltociear to make sure the Japanese README stays up to date with the other ones, could you fill the fololowing dict with the proper prompts/templates? Thanks!

@eltociear
Copy link
Contributor Author

@sgugger Thanks!
Added a fix to the this file.

Copy link
Contributor

@younesbelkada younesbelkada left a comment

Choose a reason for hiding this comment

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

初めまして @eltociear 👋 !
Thanks a lot for this great PR!
The Japanese translation looks perfect to me, I am really looking forward to merging this!
I would advocate to add something similar to the Chinese translated README, at the beginning of this README file, let's add a dictionary for future contributors and for mapping the important keywords:

<!---
A useful guide for English-Chinese translation of Hugging Face documentation
- Add space around English words and numbers when they appear between Chinese characters. E.g., 共 100 多种语言; 使用 transformers 库。
- Use square quotes, e.g.,「引用」

Dictionary

Hugging Face: 抱抱脸
token: 词符(并用括号标注原英文)
tokenize: 词符化(并用括号标注原英文)
tokenizer: 词符化器(并用括号标注原英文)
transformer: transformer(不翻译)
�pipeline: 流水线
API: API (不翻译)
inference: 推理
Trainer: 训练器。当作为类名出现时不翻译。
pretrained/pretrain: 预训练
finetune: 微调
community: 社区
example: 当特指仓库中 example 目录时翻译为「用例」
Python data structures (e.g., list, set, dict): 翻译为列表,集合,词典,并用括号标注原英文
NLP/Natural Language Processing: 以 NLP 出现时不翻译,以 Natural Language Processing 出现时翻译为自然语言处理
checkpoint: 检查点
-->

Gently tagging our japanese student ambassadors @haruki-N @blackdoor571 @hiro819 if they want to have a quick look ;)

README_ja.md Outdated Show resolved Hide resolved
@sgugger
Copy link
Collaborator

sgugger commented Oct 28, 2022

Thanks! Can you also just quickly run make fix-copies to make the CI happy?

@eltociear
Copy link
Contributor Author

@younesbelkada さん初めまして!
Thank you for contacting!
I have added an explanation to the top of the README.
Also, thanks for checking and suggesting a fix!

@sgugger
Copy link
Collaborator

sgugger commented Oct 28, 2022

@eltociear It looks like the start prompt you added is not present in the Japanese README. Could you make sure it's correct?


現在のチェックポイント数: ![](https://img.shields.io/endpoint?url=https://huggingface.co/api/shields/models&color=brightgreen)

🤗Transformersは現在、以下のアーキテクチャを提供しています(それぞれのハイレベルな要約は[こちら](https://huggingface.co/docs/transformers/model_summary)を参照してください):
Copy link
Contributor Author

Choose a reason for hiding this comment

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

@sgugger Thank you for pointing this out. start prompt is here.

utils/check_copies.py Outdated Show resolved Hide resolved
Co-authored-by: Sylvain Gugger <[email protected]>
@sgugger sgugger merged commit 38e5b71 into huggingface:main Nov 1, 2022
@sgugger
Copy link
Collaborator

sgugger commented Nov 1, 2022

Thanks again for your contribution!

@eltociear
Copy link
Contributor Author

@sgugger THANKS too!

amyeroberts pushed a commit to amyeroberts/transformers that referenced this pull request Nov 3, 2022
* Add japanese translated README.md

* Add README_ja.md link

* Add japanese transkate to check_copies.py

* Add guide to Japanese README.md

* Update README_ja.md

Co-authored-by: Younes Belkada <[email protected]>

* Update utils/check_copies.py

Co-authored-by: Sylvain Gugger <[email protected]>

Co-authored-by: Younes Belkada <[email protected]>
Co-authored-by: Sylvain Gugger <[email protected]>
mpierrau pushed a commit to mpierrau/transformers that referenced this pull request Dec 15, 2022
* Add japanese translated README.md

* Add README_ja.md link

* Add japanese transkate to check_copies.py

* Add guide to Japanese README.md

* Update README_ja.md

Co-authored-by: Younes Belkada <[email protected]>

* Update utils/check_copies.py

Co-authored-by: Sylvain Gugger <[email protected]>

Co-authored-by: Younes Belkada <[email protected]>
Co-authored-by: Sylvain Gugger <[email protected]>
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.

4 participants