2022-03-22 03:28:23 +08:00
.PHONY : deps_table_update modified_only_fixup extra_style_checks quality style fixup fix -copies test test -examples
2020-09-28 22:45:42 +08:00
2021-04-26 23:42:43 +08:00
# make sure to test the local checkout in scripts and not the pre-installed one (don't use quotes!)
export PYTHONPATH = src
2020-09-28 22:45:42 +08:00
2020-10-30 01:38:11 +08:00
check_dirs := examples tests src utils
2020-09-28 22:45:42 +08:00
2024-01-17 17:59:40 +08:00
exclude_folders := examples/research_projects
2020-09-28 22:45:42 +08:00
modified_only_fixup :
2020-11-08 01:45:16 +08:00
$( eval modified_py_files := $( shell python utils/get_modified_files.py $( check_dirs) ) )
@if test -n " $( modified_py_files) " ; then \
2020-10-06 17:25:21 +08:00
echo " Checking/fixing $( modified_py_files) " ; \
2024-01-17 17:59:40 +08:00
ruff check $( modified_py_files) --fix --exclude $( exclude_folders) ; \
ruff format $( modified_py_files) --exclude $( exclude_folders) ; \
2020-09-28 22:45:42 +08:00
else \
2020-10-06 17:25:21 +08:00
echo "No library .py files were modified" ; \
2020-09-28 22:45:42 +08:00
fi
2019-12-23 04:31:12 +08:00
2020-11-25 02:22:25 +08:00
# Update src/transformers/dependency_versions_table.py
deps_table_update :
@python setup.py deps_table_update
2021-06-28 23:55:59 +08:00
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
2021-03-22 21:14:22 +08:00
# autogenerating code
autogenerate_code : deps_table_update
2021-11-04 05:43:19 +08:00
# Check that the repo is in a good state
2019-12-23 04:31:12 +08:00
2021-11-04 05:43:19 +08:00
repo-consistency :
2020-09-22 17:02:27 +08:00
python utils/check_copies.py
2020-12-08 08:55:12 +08:00
python utils/check_table.py
2020-10-05 21:12:04 +08:00
python utils/check_dummies.py
2020-08-07 21:18:37 +08:00
python utils/check_repo.py
2021-04-05 08:41:34 +08:00
python utils/check_inits.py
2022-04-30 16:40:46 +08:00
python utils/check_config_docstrings.py
2023-02-08 00:49:30 +08:00
python utils/check_config_attributes.py
2023-01-26 22:33:47 +08:00
python utils/check_doctest_list.py
2022-09-15 02:06:49 +08:00
python utils/update_metadata.py --check-only
2023-01-28 02:19:28 +08:00
python utils/check_task_guides.py
2023-10-04 21:13:37 +08:00
python utils/check_docstrings.py
2023-12-22 19:56:11 +08:00
python utils/check_support_list.py
2019-12-23 04:31:12 +08:00
2020-09-28 22:45:42 +08:00
# this target runs checks on all files
2021-11-04 05:43:19 +08:00
2020-09-25 23:37:40 +08:00
quality :
2024-03-22 17:11:59 +08:00
@python -c "from transformers import *" || ( echo '🚨 import failed, this means you introduced unprotected imports! 🚨' ; exit 1)
2023-11-17 00:43:19 +08:00
ruff check $( check_dirs) setup.py conftest.py
ruff format --check $( check_dirs) setup.py conftest.py
2021-03-20 04:17:13 +08:00
python utils/custom_init_isort.py --check_only
2022-05-17 01:24:20 +08:00
python utils/sort_auto_mappings.py --check_only
2022-07-07 20:17:58 +08:00
python utils/check_doc_toc.py
2020-09-25 23:37:40 +08:00
2024-03-22 17:11:59 +08:00
2020-09-25 23:37:40 +08:00
# Format source code automatically and check is there are any problems left that need manual fixing
2019-12-21 22:50:39 +08:00
2021-03-22 21:14:22 +08:00
extra_style_checks :
2021-03-20 04:17:13 +08:00
python utils/custom_init_isort.py
2022-05-17 01:24:20 +08:00
python utils/sort_auto_mappings.py
2022-07-07 20:17:58 +08:00
python utils/check_doc_toc.py --fix_and_overwrite
2021-03-20 04:17:13 +08:00
2021-03-22 21:14:22 +08:00
# this target runs checks on all files and potentially modifies some of them
2021-11-04 05:43:19 +08:00
2021-03-20 04:17:13 +08:00
style :
2024-01-17 17:59:40 +08:00
ruff check $( check_dirs) setup.py conftest.py --fix --exclude $( exclude_folders)
ruff format $( check_dirs) setup.py conftest.py --exclude $( exclude_folders)
2021-03-22 21:14:22 +08:00
${ MAKE } autogenerate_code
2021-03-20 04:17:13 +08:00
${ MAKE } extra_style_checks
2020-09-28 22:45:42 +08:00
# Super fast fix and check target that only works on relevant modified files since the branch was made
2019-12-23 04:31:12 +08:00
2021-11-04 05:43:19 +08:00
fixup : modified_only_fixup extra_style_checks autogenerate_code repo -consistency
2020-09-25 23:37:40 +08:00
2020-09-22 17:02:27 +08:00
# Make marked copies of snippets of codes conform to the original
fix-copies :
python utils/check_copies.py --fix_and_overwrite
2020-12-08 08:55:12 +08:00
python utils/check_table.py --fix_and_overwrite
2020-10-05 21:12:04 +08:00
python utils/check_dummies.py --fix_and_overwrite
2023-08-04 22:24:04 +08:00
python utils/check_doctest_list.py --fix_and_overwrite
2023-01-28 02:19:28 +08:00
python utils/check_task_guides.py --fix_and_overwrite
2023-10-04 21:13:37 +08:00
python utils/check_docstrings.py --fix_and_overwrite
2020-09-22 17:02:27 +08:00
2019-12-23 04:31:12 +08:00
# Run tests for the library
test :
python -m pytest -n auto --dist= loadfile -s -v ./tests/
# Run tests for examples
test-examples :
2021-04-21 23:11:20 +08:00
python -m pytest -n auto --dist= loadfile -s -v ./examples/pytorch/
2020-08-28 00:25:16 +08:00
2021-03-30 14:28:02 +08:00
# 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
2021-03-16 20:41:47 +08:00
# 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
2023-05-17 02:23:10 +08:00
build-release :
rm -rf dist
rm -rf build
python setup.py bdist_wheel
python setup.py sdist
python utils/check_build.py