transformers/Makefile

.PHONY: quality_checks quality style fixup test test-examples docs

# Check that source code meets quality standards

quality_checks:
	flake8 examples templates tests src utils
	python utils/check_copies.py
	python utils/check_repo.py

quality:
	black --check examples templates tests src utils
	isort --check-only examples templates tests src utils
	${MAKE} quality_checks

# Format source code automatically and check is there are any problems left that need manual fixing

style:
	black examples templates tests src utils
	isort examples templates tests src utils

fixup: style quality_checks

# Make marked copies of snippets of codes conform to the original

fix-copies:
	python utils/check_copies.py --fix_and_overwrite

# Run tests for the library

test:
	python -m pytest -n auto --dist=loadfile -s -v ./tests/

# Run tests for examples

test-examples:
	python -m pytest -n auto --dist=loadfile -s -v ./examples/

# Check that docs can build

docs:
	cd docs && make html SPHINXOPTS="-W"
[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 15:37:40 +00:00			`.PHONY: quality_checks quality style fixup test test-examples docs`
Update contribution instructions. Also provide shortcuts in a Makefile. 2019-12-22 20:31:12 +00:00
			`# Check that source code meets quality standards`

[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 15:37:40 +00:00			`quality_checks:`
Update contribution instructions. Also provide shortcuts in a Makefile. 2019-12-22 20:31:12 +00:00			`flake8 examples templates tests src utils`
Copy code from Bert to Roberta and add safeguard script (#7219) * Copy code from Bert to Roberta and add safeguard script * Fix docstring * Comment code * Formatting * Update src/transformers/modeling_roberta.py Co-authored-by: Lysandre Debut <lysandre@huggingface.co> * Add test and fix bugs * Fix style and make new comand Co-authored-by: Lysandre Debut <lysandre@huggingface.co> 2020-09-22 09:02:27 +00:00			`python utils/check_copies.py`
Add a script to check all models are tested and documented (#6298) * Add a script to check all models are tested and documented * Apply suggestions from code review Co-authored-by: Kevin Canwen Xu <canwenxu@126.com> * Address comments Co-authored-by: Kevin Canwen Xu <canwenxu@126.com> 2020-08-07 13:18:37 +00:00			`python utils/check_repo.py`
Update contribution instructions. Also provide shortcuts in a Makefile. 2019-12-22 20:31:12 +00:00
[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 15:37:40 +00:00			`quality:`
			`black --check examples templates tests src utils`
			`isort --check-only examples templates tests src utils`
			`${MAKE} quality_checks`

			`# Format source code automatically and check is there are any problems left that need manual fixing`
Add "make style" to format code with black. 2019-12-21 14:50:39 +00:00
			`style:`
[code quality] fix confused flake8 (#7309) * fix confused flake We run `black --target-version py35 ...` but flake8 doesn't know that, so currently with py38 flake8 fails suggesting that black should have reformatted 63 files. Indeed if I run: ``` black --line-length 119 --target-version py38 examples templates tests src utils ``` it indeed reformats 63 files. The only solution I found is to create a black config file as explained at https://github.com/psf/black#configuration-format, which is what this PR adds. Now flake8 knows that py35 is the standard and no longer gets confused regardless of the user's python version. * adjust the other files that will now rely on black's config file 2020-09-23 02:12:36 +00:00			`black examples templates tests src utils`
Update repo to isort v5 (#6686) * Run new isort * More changes * Update CI, CONTRIBUTING and benchmarks 2020-08-24 15:03:01 +00:00			`isort examples templates tests src utils`
Update contribution instructions. Also provide shortcuts in a Makefile. 2019-12-22 20:31:12 +00:00
[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 15:37:40 +00:00			`fixup: style quality_checks`

Copy code from Bert to Roberta and add safeguard script (#7219) * Copy code from Bert to Roberta and add safeguard script * Fix docstring * Comment code * Formatting * Update src/transformers/modeling_roberta.py Co-authored-by: Lysandre Debut <lysandre@huggingface.co> * Add test and fix bugs * Fix style and make new comand Co-authored-by: Lysandre Debut <lysandre@huggingface.co> 2020-09-22 09:02:27 +00:00			`# Make marked copies of snippets of codes conform to the original`

			`fix-copies:`
			`python utils/check_copies.py --fix_and_overwrite`

Update contribution instructions. Also provide shortcuts in a Makefile. 2019-12-22 20:31:12 +00:00			`# Run tests for the library`

			`test:`
			`python -m pytest -n auto --dist=loadfile -s -v ./tests/`

			`# Run tests for examples`

			`test-examples:`
			`python -m pytest -n auto --dist=loadfile -s -v ./examples/`
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 16:25:16 +00:00
			`# Check that docs can build`

			`docs:`
			`cd docs && make html SPHINXOPTS="-W"`