49 Commits

Author	SHA1	Message	Date
Shubham S Jagtap	084e946cfd	Apply linting to the important code blocks to make it readable (#34449) ... Enhance user experience using py-linting	2024-10-28 10:48:18 -07:00
Klaus Hipp	328ade855b	[Docs] Fix placement of tilde character (#28913) ... Fix placement of tilde character	2024-02-07 17:19:39 -08:00
Rishit Ratna	78d767e3c8	Fixed minor typos (#28489)	2024-01-15 16:45:15 +00:00
Yih-Dar	f02b915ba2	Remove utils/documentation_tests.txt (#26213) ... * update * update --------- Co-authored-by: ydshieh <ydshieh@users.noreply.github.com>	2023-09-18 13:33:01 +02:00
zspo	3e203f92be	Fix small typo README.md (#25934) ... * fix some samll bugs in readme * Update docs/README.md Co-authored-by: amyeroberts <22614925+amyeroberts@users.noreply.github.com> --------- Co-authored-by: amyeroberts <22614925+amyeroberts@users.noreply.github.com>	2023-09-06 14:07:29 +01:00
Nino Risteski	1bf2f36daf	Update README.md (#25832) ... deleted unnecessary comma in the Adding a new model section.	2023-08-30 10:52:41 +01:00
Nino Risteski	8c75cfdaee	Update README.md (#25834) ... _toctree.yml file. broken link, now fixed.	2023-08-29 20:02:57 +01:00
Sylvain Gugger	eb849f6604	Migrate doc files to Markdown. (#24376) ... * Rename index.mdx to index.md * With saved modifs * Address review comment * Treat all files * .mdx -> .md * Remove special char * Update utils/tests_fetcher.py Co-authored-by: Lysandre Debut <lysandre.debut@reseau.eseo.fr> --------- Co-authored-by: Lysandre Debut <lysandre.debut@reseau.eseo.fr>	2023-06-20 18:07:47 -04:00
Yih-Dar	b143019005	Update README.md (#24022) ... fix Co-authored-by: ydshieh <ydshieh@users.noreply.github.com>	2023-06-05 17:08:15 +02:00
code-with-rajeev	2308f3d42c	Update README.md (#19530) ... Fixed a grammatical error.	2022-11-14 01:36:38 -05:00
Paula Isabel	226b8ef063	correct typos in README (#19304)	2022-10-05 10:40:38 -07:00
flozi00	6be338f1b9	correct spelling in README (#19092)	2022-09-19 19:51:43 +02:00
Ankur Goyal	7495924007	Specify en in doc-builder README example (#18526) ... Co-authored-by: Ankur Goyal <ankur@impira.com>	2022-08-08 10:22:17 -04:00
Snehan Kekre	ce0152819d	Update docs README with instructions on locally previewing docs (#18196) ... * Update docs README with instructions on locally previewing docs * Add instructions to install `watchdog` before previewing the docs	2022-07-19 11:47:26 +02:00
Kamal Raj	91ede485a7	Fix typo (#17328)	2022-05-18 10:29:53 -04:00
Omar U. Espejel	da47c264f9	Add translating guide (#17004) ... * Add translating guide	2022-04-30 17:43:38 -05:00
Sylvain Gugger	088c1880b7	Big file_utils cleanup (#16396) ... * Big file_utils cleanup * This one still needs to be treated separately	2022-03-25 07:25:20 -04:00
Yih-Dar	1cf28da66d	Update docs/README.md (#16333) ... * Update docs/README.md Co-authored-by: Lysandre Debut <lysandre@huggingface.co> Co-authored-by: Sylvain Gugger <35901082+sgugger@users.noreply.github.com>	2022-03-23 22:46:11 +01: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
Patrick von Platen	a7df656f03	Update README.md (#15926)	2022-03-04 00:22:38 +01:00
Sylvain Gugger	0118c4f6a8	Re-enable doctests for the quicktour (#15828) ... * Re-enable doctests for the quicktour * Re-enable doctests for task_summary (#15830) * Remove &	2022-02-25 17:46:38 +01:00
Patrick von Platen	f45ac11fb3	Add section about doc testing (#15659) ... * Add doctesting section * Improve * 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>	2022-02-15 16:56:31 +01:00
Kamal Raj	3254080d45	Update README.md (#15430) ... fix typo	2022-01-31 09:48:20 -05:00
Sylvain Gugger	6292532fd1	Update doc writing guide (#15350)	2022-01-26 12:54:11 -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
Sylvain Gugger	459677aebe	PoC for conserving old links (#14754) ... * PoC for conserving old links * Do the same for other links * remap the redirects section * add instructions on how to move sections * improve Co-authored-by: Stas Bekman <stas@stason.org>	2021-12-15 11:40:47 -08:00
Reza Gharibi	6b83090e80	Fix some typos in the docs (#14126) ... * Fix some typos in the docs * Fix a styling issue * Fix code quality check error	2021-10-25 07:40:44 -04:00
Stas Bekman	b6a28e9ac9	[docs] How to solve "Title level inconsistent" sphinx error (#10600) ... * How to solve: Title level inconsistent * list chars	2021-03-08 20:16:33 -08:00
Sylvain Gugger	00aa9dbca2	Copyright (#8970) ... * Add copyright everywhere missing * Style	2020-12-07 18:36:34 -05:00
Sylvain Gugger	0be5f4a00c	Expand a bit the documentation doc (#7350)	2020-09-24 04:34:18 -04:00
Thomas Wolf	601d4d699c	[tokenizers] Updates data processors, docstring, examples and model cards to the new API (#5308) ... * remove references to old API in docstring - update data processors * style * fix tests - better type checking error messages * better type checking * include awesome fix by @LysandreJik for #5310 * updated doc and examples	2020-06-26 19:48:14 +02: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
Sylvain Gugger	2d372a990b	Explain how to preview the docs in a PR (#4795)	2020-06-05 20:47:02 -04:00
Sylvain Gugger	cd4e07a85e	Add note about doc generation (#4770)	2020-06-04 13:43:14 -04:00
Lysandre Debut	9524956819	Documentation specification (#4294)	2020-05-11 16:43:57 -04:00
Patrick von Platen	57b0fab692	Add better explanation to check docs locally. (#3459)	2020-03-31 09:30:17 -04: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	d79e9c9a9a	Remove docs/requirements.txt. ... It's superseded by the "docs" extras.	2019-12-23 19:17:07 +01:00
Dima Veselov	cd69bc9c87	Fixed typo in docs README	2019-10-02 03:21:55 +03:00
Julien Chaumond	fc9faa8a47	[docs] Doc tweaks ... Co-Authored-By: Lysandre Debut <lysandre.debut@reseau.eseo.fr>	2019-09-26 18:19:51 -04:00
LysandreJik	e52737d5ad	Updated docs README to feature the examples symlink	2019-09-06 12:13:31 -04:00
thomwolf	699bc7e86e	fix gpt-2 unk token test	2019-07-12 11:46:57 +02:00
LysandreJik	e0e5c7faf5	Added requirements.txt file.	2019-07-09 10:16:09 -04:00
LysandreJik	269e73b601	Adding example detailing how to add a new file to the documentation + adding fonts.	2019-07-09 10:11:29 -04:00
LysandreJik	03de9686a7	Initial folder structure for the documentation. A draft of documentation change has been made in the BertModel class.	2019-07-05 17:11:13 -04:00