Arthur
3f9f749325
[Doc] update contribution guidelines ( #28858 )
...
update guidelines
2024-02-05 21:19:21 +09:00
Klaus Hipp
721ee783ca
[Docs] Fix spelling and grammar mistakes ( #28825 )
...
* Fix typos and grammar mistakes in docs and examples
* Fix typos in docstrings and comments
* Fix spelling of `tokenizer` in model tests
* Remove erroneous spaces in decorators
* Remove extra spaces in Markdown link texts
2024-02-02 08:45:00 +01:00
MD FAIZAN KHAN
636f704d0b
Fix the typos and grammar mistakes in CONTRIBUTING.md. ( #27193 )
...
Fix the typos and grammar mistakes in CONTRIBUTING.md
2023-11-01 12:42:22 +00:00
Yih-Dar
e84bf1f734
⚠️ Time to say goodbye to py37 ( #24091 )
...
* fix
---------
Co-authored-by: ydshieh <ydshieh@users.noreply.github.com>
2023-06-28 07:22:39 +02:00
Jacob
97527898da
typo: fix typos in CONTRIBUTING.md and deepspeed.mdx ( #24184 )
...
* typo: fix typos in CONTRIBUTING.md and deepspeed.mdx
* Update CONTRIBUTING.md
Co-authored-by: amyeroberts <22614925+amyeroberts@users.noreply.github.com>
---------
Co-authored-by: amyeroberts <22614925+amyeroberts@users.noreply.github.com>
2023-06-12 15:43:58 +01:00
Sylvain Gugger
28c19ab58d
Make it easier to develop without a dev install ( #22697 )
...
* Make it easier to develop without a dev install
* Remove ugly hack that doesn't work anyway
2023-04-11 08:41:53 -04:00
Kamal Raj Kanakarajan
d0c19b3303
rm $ symbol from code block from contributing.md ( #22057 )
...
rm $ symbol from code block
Removed the $ symbol from the code block to make copy-pasting easier.
2023-03-09 11:09:46 -05:00
Thomas Paviot
ba2a5f13f7
Fix en documentation typos ( #21799 )
...
* fix wrong url
* typos in english documentation
2023-02-27 08:36:36 +01:00
Shubhamai
557125637d
improving contributing tests section ( #21569 )
...
* improving tests section
* documenting other env variables
2023-02-10 13:17:01 -05:00
Sylvain Gugger
67d074874d
Cleanup quality ( #21493 )
...
* Remove mentions of flake8/isort
* Clean up inits
* Deall with all other inits
* Last special rule for dummy files
2023-02-07 12:27:31 -05:00
Mohammed Faizan Ahmed
bbe2c8b126
All broken links were fixed in contributing file ( #19760 )
2022-10-19 16:44:03 -04:00
Steven Liu
32670805fc
Update contribution guide ( #19700 )
...
* update the contribution guide
* apply review feedback
* fix checkboxes
* checkbox fix #2
* clarify force push
2022-10-18 17:20:12 -07:00
Shreem Asati
563b42faf0
Update CONTRIBUTING.md ( #19689 )
...
punctuation missing
2022-10-17 14:55:59 -04:00
Colin Dean
737f6ad1f7
Starts on a list of external deps required for dev ( #18929 )
...
* Starts on a list of external deps required for dev
I've found that I need to install MeCab manually on my AS Mac.
* Generalizes OS nascent dependency list
Co-authored-by: Sylvain Gugger <35901082+sgugger@users.noreply.github.com>
Co-authored-by: Sylvain Gugger <35901082+sgugger@users.noreply.github.com>
2022-09-07 16:33:03 -04:00
Sebastian Sosa
195133363e
supported python versions reference ( #18116 )
...
* supported python versions reference
* Update CONTRIBUTING.md
removing commit hash from link
Co-authored-by: Sylvain Gugger <35901082+sgugger@users.noreply.github.com>
Co-authored-by: Sylvain Gugger <35901082+sgugger@users.noreply.github.com>
2022-07-13 08:18:44 -04:00
Arthur
6de4ee61a0
Wav2 vec2 phoneme ctc tokenizer optimisation ( #16817 )
...
* Solved href rendering issue in heading
Markdown references in headings such as '####' don't render well.
Replaced it with <h4>...<a></a></h> banners.
* PhonemeTokenizer optimization using phonemizer lib
The backend should only be initialized once, otherwise it is reloaded.
Added `init_backend` function, intializes a backend attribute.
Phonemize re-uses self.backend.
Should give ~10 times faster phonemization.
* formatted file with make style
* Documentation suggestion
Co-authored-by: Sylvain Gugger <35901082+sgugger@users.noreply.github.com>
* Update /tokenization_wav2vec2_phoneme.py based on PR suggestion
Co-authored-by: Sylvain Gugger <35901082+sgugger@users.noreply.github.com>
* Update CONTRIBUTING.md
Co-authored-by: Sylvain Gugger <35901082+sgugger@users.noreply.github.com>
2022-04-19 07:39:04 -04:00
Lysandre Debut
eca77f4719
Updates the default branch from master to main ( #16326 )
...
* Updates the default branch from master to main
* Links from `master` to `main`
* Typo
* Update examples/flax/README.md
Co-authored-by: Sylvain Gugger <35901082+sgugger@users.noreply.github.com>
Co-authored-by: Sylvain Gugger <35901082+sgugger@users.noreply.github.com>
2022-03-23 03:46:59 -04:00
Kamal Raj
c972433a85
Update CONTRIBUTING.md ( #15290 )
...
Fix typo in doc
2022-01-24 07:21:31 -05:00
Kamal Raj
1b0ca7d270
Update CONTRIBUTING.md ( #14835 )
...
fix cmd typo
2021-12-20 08:42:03 -05:00
Kamal Raj
465a8b8d10
Update CONTRIBUTING.md ( #14800 )
...
fix pip installation cmd
2021-12-16 10:40:56 -05:00
Kamal Raj
8ae24e19b2
Update CONTRIBUTING.md ( #14799 )
...
typo
2021-12-16 10:24:26 -05:00
Sylvain Gugger
5061a9fd55
Post sphinx-clean up and contributing guide updates ( #14790 )
...
* Clean up sphinx
* Update contributing guide
* Update docs README
* No example title
* Fix copies
* Update CONTRIBUTING.md
Co-authored-by: Lysandre Debut <lysandre@huggingface.co>
Co-authored-by: Lysandre Debut <lysandre@huggingface.co>
2021-12-16 09:29:26 -05:00
Lysandre Debut
8010fda9bf
Removes images to put them in a dataset ( #14781 )
...
* First try
* Update instructions
2021-12-16 04:42:02 -05:00
Lysandre Debut
6ac0fac85a
Mention no images added to repository ( #14738 )
...
* Mention no images added to repository
* Update CONTRIBUTING.md
Co-authored-by: NielsRogge <48327001+NielsRogge@users.noreply.github.com>
Co-authored-by: NielsRogge <48327001+NielsRogge@users.noreply.github.com>
2021-12-13 12:21:26 -05:00
Sylvain Gugger
4df7d05a87
Doc new front ( #14590 )
...
* Convert PretrainedConfig doc to Markdown
* Use syntax
* Add necessary doc files (#14496 )
* Doc fixes (#14499 )
* Fixes for the new front
* Convert DETR file for table
* Title is needed
* Simplify a bit
* Even simpler
* Remove imports
* Fix typo in toctree (#14516 )
* Fix checkpoints badge
* Update versions.yml format (#14517 )
* Doc new front github actions (#14512 )
* Doc new front github actions
* Fix docstring
* Fix feature extraction utils import (#14515 )
* Address Julien's comments
* Push to doc-builder
* Ready for merge
* Remove old build and deploy
* Doc misc fixes (#14583 )
* Rm versions.yml from doc
* Fix converting.rst
* Rm pretrained_models from toctree
* Fix index links (#14567 )
* Fix links in README
* Localized READMEs
* Fix copy script
* Fix find doc script
* Update README_ko.md
Co-authored-by: Julien Chaumond <julien@huggingface.co>
Co-authored-by: Julien Chaumond <julien@huggingface.co>
* Adapt build command to new CLI tools (#14578 )
* Fix typo
* Fix doc interlinks (#14589 )
* Convert PretrainedConfig doc to Markdown
* Use syntax
* Rm pattern <[a-z]+(.html).*>
* Rm huggingface.co/transformers/master
* Rm .html
* Rm .html from index.mdx
* Rm .html from model_summary.rst
* Update index.mdx rm html
* Update remove .html
* Fix inner doc links
* Fix interlink in preprocssing.rst
* Update pr_checks
Co-authored-by: Sylvain Gugger <sylvain.gugger@gmail.com>
Co-authored-by: Sylvain Gugger <35901082+sgugger@users.noreply.github.com>
* Convert PretrainedConfig doc to Markdown
* Use syntax
* Add necessary doc files (#14496 )
* Doc fixes (#14499 )
* Fixes for the new front
* Convert DETR file for table
* Title is needed
* Simplify a bit
* Even simpler
* Remove imports
* Fix checkpoints badge
* Fix typo in toctree (#14516 )
* Update versions.yml format (#14517 )
* Doc new front github actions (#14512 )
* Doc new front github actions
* Fix docstring
* Fix feature extraction utils import (#14515 )
* Address Julien's comments
* Push to doc-builder
* Ready for merge
* Remove old build and deploy
* Doc misc fixes (#14583 )
* Rm versions.yml from doc
* Fix converting.rst
* Rm pretrained_models from toctree
* Fix index links (#14567 )
* Fix links in README
* Localized READMEs
* Fix copy script
* Fix find doc script
* Update README_ko.md
Co-authored-by: Julien Chaumond <julien@huggingface.co>
Co-authored-by: Julien Chaumond <julien@huggingface.co>
* Adapt build command to new CLI tools (#14578 )
* Fix typo
* Fix doc interlinks (#14589 )
* Convert PretrainedConfig doc to Markdown
* Use syntax
* Rm pattern <[a-z]+(.html).*>
* Rm huggingface.co/transformers/master
* Rm .html
* Rm .html from index.mdx
* Rm .html from model_summary.rst
* Update index.mdx rm html
* Update remove .html
* Fix inner doc links
* Fix interlink in preprocssing.rst
* Update pr_checks
Co-authored-by: Sylvain Gugger <sylvain.gugger@gmail.com>
Co-authored-by: Sylvain Gugger <35901082+sgugger@users.noreply.github.com>
* Styling
Co-authored-by: Mishig Davaadorj <mishig.davaadorj@coloradocollege.edu>
Co-authored-by: Lysandre Debut <lysandre@huggingface.co>
Co-authored-by: Julien Chaumond <julien@huggingface.co>
2021-12-01 14:13:02 -05:00
Sylvain Gugger
f0d6e952c0
Quality explain ( #14264 )
...
* Start PR doc
* Cleanup the quality checks and document them
* Add reference in the contributing guide
* Apply suggestions from code review
Co-authored-by: Stas Bekman <stas00@users.noreply.github.com>
* Rename file as per review suggestion
Co-authored-by: Stas Bekman <stas00@users.noreply.github.com>
2021-11-03 17:43:19 -04:00
Shiro T
f9880f62ad
fixed a small typo in the doc ( #11856 )
2021-05-25 04:18:55 -04:00
Stas Bekman
5aaf5aac0b
[contributing doc] explain/link to good first issue ( #11346 )
...
* explain/link to good first issue
* Apply suggestions from code review
Co-authored-by: Sylvain Gugger <35901082+sgugger@users.noreply.github.com>
Co-authored-by: Sylvain Gugger <35901082+sgugger@users.noreply.github.com>
2021-04-21 10:10:11 -07:00
Sylvain Gugger
dabeb15292
Examples reorg ( #11350 )
...
* Base move
* Examples reorganization
* Update references
* Put back test data
* Move conftest
* More fixes
* Move test data to test fixtures
* Update path
* Apply suggestions from code review
Co-authored-by: Lysandre Debut <lysandre@huggingface.co>
* Address review comments and clean
Co-authored-by: Lysandre Debut <lysandre@huggingface.co>
2021-04-21 11:11:20 -04:00
Simon Brandeis
3b67c5abb0
Update 'Develop on Windows' guidelines ( #9519 )
2021-01-12 04:15:16 -05:00
Sylvain Gugger
00aa9dbca2
Copyright ( #8970 )
...
* Add copyright everywhere missing
* Style
2020-12-07 18:36:34 -05:00
Guy Rosin
3a08cc1ce7
Minor docs typo fixes ( #8797 )
...
* Fix minor typos
* Additional typos
* Style fix
Co-authored-by: guyrosin <guyrosin@assist-561.cs.technion.ac.il>
2020-11-29 11:27:00 -05:00
Binoy Dalal
8d4ed7e953
added instructions for syncing upstream master with forked master via PR ( #8745 )
...
* added instructions for syncing upstream master with forked master via PR
* expand to add a note to why this is requested
Co-authored-by: Stas Bekman <stas00@users.noreply.github.com>
2020-11-24 10:11:46 -05:00
Julien Plu
e7e1549895
Windows dev section in the contributing file ( #8436 )
...
* Add a Windows dev section in the contributing file.
* Forgotten link
* Trigger CI
* Rework description
* Trigger CI
2020-11-10 11:19:16 -05:00
Santiago Castro
969859d5f6
Fix doc errors and typos across the board ( #8139 )
...
* Fix doc errors and typos across the board
* Fix a typo
* Fix the CI
* Fix more typos
* Fix CI
* More fixes
* Fix CI
* More fixes
* More fixes
2020-10-29 10:33:33 -04:00
Sylvain Gugger
f1220c5fe2
Add a code of conduct ( #7433 )
2020-09-29 13:38:47 -04:00
Sylvain Gugger
1fc4de69ed
Document new features of make fixup ( #7434 )
2020-09-29 03:56:57 -04:00
Stas Bekman
8859c4f841
[code quality] new make target that combines style and quality targets ( #7310 )
...
* [code quality] merge style and quality targets
Any reason why we don't run `flake8` in `make style`? I find myself needing to run `make style` and `make quality` all the time, but I need the latter just for the last 2 checks. Since we have no control over the source code why bother with separating checking and fixing - let's just have one target that fixes and then performs the remaining checks, as we know the first two have been done already.
This PR suggests to merge the 2 targets into one efficient target.
I will edit the docs if this change resonates with the team.
* move checks into style, re-use target
* better name
* add fixup target
* document new target
2020-09-25 11:37:40 -04:00
Sylvain Gugger
0054a48cdd
Add dep on datasets ( #7058 )
2020-09-11 04:43:19 -04:00
Stas Bekman
70fccc5cf3
new Makefile target: docs ( #6510 )
...
* [doc] multiple corrections to "Summary of the tasks"
* add a new "docs" target to validate docs and document it
* fix mixup
2020-08-27 12:25:16 -04:00
Sylvain Gugger
a573777901
Update repo to isort v5 ( #6686 )
...
* Run new isort
* More changes
* Update CI, CONTRIBUTING and benchmarks
2020-08-24 11:03:01 -04:00
Stas Bekman
61b5ee11e3
lighter 'make test' ( #6512 )
2020-08-20 17:24:25 +08:00
Stas Bekman
e1638dce16
fix the slow tests doc ( #6167 )
...
remove unnecessary duplication wrt `RUN_SLOW=yes`
2020-08-07 09:17:32 -04:00
Sam Shleifer
feeb956a19
[docs] Add integration test example to copy pasta template ( #5961 )
...
Co-authored-by: Julien Chaumond <chaumond@gmail.com>
2020-07-22 12:48:38 -04:00
Stas Bekman
bfeaae2235
fix 404 ( #5616 )
2020-07-09 15:12:29 -04:00
Sylvain Gugger
204ebc25e6
Update installation page and add contributing to the doc ( #5084 )
...
* Update installation page and add contributing to the doc
* Remove mention of symlinks
2020-06-17 14:01:10 -04:00
Patrick von Platen
5acb4edf25
Update version command when contributing ( #4614 )
2020-05-27 17:19:11 +02:00
Sam Shleifer
07dd7c2fd8
[cleanup] test_tokenization_common.py ( #4390 )
2020-05-19 10:46:55 -04:00
Sam Shleifer
d714dfeaa8
[isort] add known 3rd party to setup.cfg ( #4053 )
...
* add known 3rd party to setup.cfg
* comment
* Update CONTRIBUTING.md
Co-authored-by: Julien Chaumond <chaumond@gmail.com>
2020-04-28 17:12:00 -04:00
sshleifer
5f2dd71d1b
Smaller diff
2020-02-11 17:20:09 -05:00
