Makefile 3.04 KB
Newer Older
1
.PHONY: deps_table_update modified_only_fixup extra_quality_checks quality style fixup fix-copies test test-examples docs
2

3
4
# make sure to test the local checkout in scripts and not the pre-installed one (don't use quotes!)
export PYTHONPATH = src
5

6
check_dirs := examples tests src utils
7
8

modified_only_fixup:
9
10
	$(eval modified_py_files := $(shell python utils/get_modified_files.py $(check_dirs)))
	@if test -n "$(modified_py_files)"; then \
11
12
13
14
		echo "Checking/fixing $(modified_py_files)"; \
		black $(modified_py_files); \
		isort $(modified_py_files); \
		flake8 $(modified_py_files); \
15
	else \
16
		echo "No library .py files were modified"; \
17
	fi
18

19
20
21
22
23
# Update src/transformers/dependency_versions_table.py

deps_table_update:
	@python setup.py deps_table_update

24
25
26
27
28
29
deps_table_check_updated:
	@md5sum src/transformers/dependency_versions_table.py > md5sum.saved
	@python setup.py deps_table_update
	@md5sum -c --quiet md5sum.saved || (printf "\nError: the version dependency table is outdated.\nPlease run 'make fixup' or 'make style' and commit the changes.\n\n" && exit 1)
	@rm md5sum.saved

30
31
32
33
# autogenerating code

autogenerate_code: deps_table_update

Sylvain Gugger's avatar
Sylvain Gugger committed
34
# Check that the repo is in a good state
35

Sylvain Gugger's avatar
Sylvain Gugger committed
36
repo-consistency:
37
	python utils/check_copies.py
38
	python utils/check_table.py
39
	python utils/check_dummies.py
40
	python utils/check_repo.py
41
	python utils/check_inits.py
42
	python utils/tests_fetcher.py --sanity_check
43

44
# this target runs checks on all files
Sylvain Gugger's avatar
Sylvain Gugger committed
45

46
quality:
47
48
	black --check $(check_dirs)
	isort --check-only $(check_dirs)
Sylvain Gugger's avatar
Sylvain Gugger committed
49
	python utils/custom_init_isort.py --check_only
50
	flake8 $(check_dirs)
51
#	python utils/style_doc.py src/transformers docs/source --max_len 119 --check_only
52
53

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

55
extra_style_checks:
Sylvain Gugger's avatar
Sylvain Gugger committed
56
	python utils/custom_init_isort.py
57
#	python utils/style_doc.py src/transformers docs/source --max_len 119
Sylvain Gugger's avatar
Sylvain Gugger committed
58

59
# this target runs checks on all files and potentially modifies some of them
Sylvain Gugger's avatar
Sylvain Gugger committed
60

Sylvain Gugger's avatar
Sylvain Gugger committed
61
style:
62
63
	black $(check_dirs)
	isort $(check_dirs)
64
	${MAKE} autogenerate_code
Sylvain Gugger's avatar
Sylvain Gugger committed
65
	${MAKE} extra_style_checks
66
67

# Super fast fix and check target that only works on relevant modified files since the branch was made
68

Sylvain Gugger's avatar
Sylvain Gugger committed
69
fixup: modified_only_fixup extra_style_checks autogenerate_code repo-consistency
70

71
72
73
74
# Make marked copies of snippets of codes conform to the original

fix-copies:
	python utils/check_copies.py --fix_and_overwrite
75
	python utils/check_table.py --fix_and_overwrite
76
	python utils/check_dummies.py --fix_and_overwrite
77

78
79
80
81
82
83
84
85
# Run tests for the library

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

# Run tests for examples

test-examples:
Sylvain Gugger's avatar
Sylvain Gugger committed
86
	python -m pytest -n auto --dist=loadfile -s -v ./examples/pytorch/
87

Philipp Schmid's avatar
Philipp Schmid committed
88
89
90
91
92
93
# Run tests for SageMaker DLC release

test-sagemaker: # install sagemaker dependencies in advance with pip install .[sagemaker]
	TEST_SAGEMAKER=True python -m pytest -n auto  -s -v ./tests/sagemaker


Sylvain Gugger's avatar
Sylvain Gugger committed
94
95
96
97
98
99
100
101
102
103
104
105
106
# Release stuff

pre-release:
	python utils/release.py

pre-patch:
	python utils/release.py --patch

post-release:
	python utils/release.py --post_release

post-patch:
	python utils/release.py --post_release --patch