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
sshleifer
31158af57c
formatting
2020-02-11 17:20:09 -05:00
sshleifer
5dd61fb9a9
Add more specific testing advice to Contributing.md
2020-02-11 17:20:09 -05:00
Bram Vanroy
9773e5e0d9
CLI script to gather environment info ( #2699 )
...
* add "info" command to CLI
As a convenience, add the info directive to CLI. Running `python transformers-cli info` will return a string containing the transformers version, platform, python version, PT/TF version and GPU support
* Swap f-strings for .format
Still supporting 3.5 so can't use f-strings (sad face)
* Add reference in issue to CLI
* Add the expected fields to issue template
This way, people can still add the information manually if they want. (Though I fear they'll just ignore it.)
* Remove heading from output
* black-ify
* order of imports
Should ensure isort test passes
* use is_X_available over import..pass
* style
* fix copy-paste bug
* Rename command info -> env
Also adds the command to CONTRIBUTING.md in "Did you find a bug" section
2020-02-01 10:38:14 -05:00
alberduris
81d6841b4b
GPU text generation: mMoved the encoded_prompt to correct device
2020-01-06 15:11:12 +01:00
alberduris
dd4df80f0b
Moved the encoded_prompts to correct device
2020-01-06 15:11:12 +01:00
Aymeric Augustin
3233b58ad4
Quote square brackets in shell commands.
...
This ensures compatibility with zsh.
Fix #2316 .
2019-12-27 08:50:25 +01:00
Aymeric Augustin
a8d34e534e
Remove [--editable] in install instructions.
...
Use -e only in docs targeted at contributors.
If a user copy-pastes command line with [--editable], they will hit
an error. If they don't know the --editable option, we're giving them
a choice to make before they can move forwards, but this isn't a choice
they need to make right now.
2019-12-24 08:46:08 +01:00
Aymeric Augustin
70373a5f7c
Update contribution instructions.
...
Also provide shortcuts in a Makefile.
2019-12-23 21:05:30 +01:00
Aymeric Augustin
76a1417f2a
Include all optional dependencies in extras.
...
Take advantage of this to simplify the Circle CI configuration.
Don't bother with tensorboardX: it's a fallback for PyTorch < 1.1.0.
2019-12-23 19:14:31 +01:00
Aidan Kierans
1718fb9e74
Minor/basic text fixes ( #2229 )
...
* Small clarification
Matches line 431 to line 435 for additional clarity and consistency.
* Fixed minor typo
The letter "s" was previously omitted from the word "docstrings".
2019-12-19 16:23:18 -05:00
Rémi Louf
de2696f68e
suggest to track repo w/ https rather than ssh
2019-11-27 11:02:28 -05:00
Thomas Wolf
55fbfea369
Update CONTRIBUTING.md
...
Co-Authored-By: Stefan Schweter <stefan.schweter@bsb-muenchen.de>
2019-10-30 12:25:40 +01:00
Thomas Wolf
cef2a8f900
Update CONTRIBUTING.md
...
Co-Authored-By: Stefan Schweter <stefan.schweter@bsb-muenchen.de>
2019-10-30 12:25:31 +01:00
thomwolf
328a86d2af
adding links to the templates in readme and contributing
2019-10-30 11:37:55 +01:00
Rémi Louf
45de313a9e
add bullet point on modifying an existing PR
2019-10-08 11:54:10 +02:00
Rémi Louf
ade05b6cef
add code contribution
2019-10-07 23:20:25 +02:00
Rémi Louf
e9c09052a4
add issues and requests guidelines
2019-10-07 22:30:55 +02:00
thomwolf
1de35b624b
preparing for first release
2018-11-15 20:56:10 +01:00