SRC = allennlp

MD_DOCS_ROOT = docs/

MD_DOCS_API_ROOT = $(MD_DOCS_ROOT)api/

MD_DOCS_SRC = $(filter-out $(SRC)/__main__.py %/__init__.py $(SRC)/version.py,$(shell find $(SRC) -type f -name '*.py' | grep -v -E 'tests/'))

MD_DOCS = $(subst .py,.md,$(subst $(SRC)/,$(MD_DOCS_API_ROOT),$(MD_DOCS_SRC)))

MD_DOCS_CMD = python scripts/py2md.py

MD_DOCS_CONF = mkdocs.yml

MD_DOCS_CONF_SRC = mkdocs-skeleton.yml

MD_DOCS_TGT = site/

MD_DOCS_EXTRAS = $(addprefix $(MD_DOCS_ROOT),README.md CHANGELOG.md CONTRIBUTING.md)

TORCH_INSTALL = pip install torch torchvision -c constraints.txt

DOCKER_TORCH_VERSION = 1.12.0-cuda11.3-python3.8

DOCKER_TEST_TORCH_VERSION = 1.12.0-cuda11.3-python3.8

DOCKER_TAG = latest

DOCKER_IMAGE_NAME = allennlp/allennlp:$(DOCKER_TAG)

DOCKER_TEST_IMAGE_NAME = allennlp/test:$(DOCKER_TAG)

DOCKER_RUN_CMD = docker run --rm \

-v $$HOME/.allennlp:/root/.allennlp \

-v $$HOME/.cache/huggingface:/root/.cache/huggingface \

-v $$HOME/nltk_data:/root/nltk_data

NLTK_DOWNLOAD_CMD = python -c 'import nltk; [nltk.download(p) for p in ("wordnet", "wordnet_ic", "sentiwordnet", "omw", "omw-1.4")]'

ifeq ($(shell uname),Darwin)

ifeq ($(shell which gsed),)

$(error Please install GNU sed with 'brew install gnu-sed')

SED = gsed

SED = sed

.PHONY : version

version :

@python -c 'from allennlp.version import VERSION; print(f"AllenNLP v{VERSION}")'

.PHONY : check-for-cuda

check-for-cuda :

@python -c 'import torch; assert torch.cuda.is_available(); print("Cuda is available")'

.PHONY : flake8

flake8 :

flake8 allennlp tests scripts

.PHONY : format

format :

black --check allennlp tests scripts

.PHONY : typecheck

typecheck :

mypy allennlp tests scripts --cache-dir=/dev/null

.PHONY : test

test :

pytest --color=yes -v -rf --durations=40 \

--cov-config=.coveragerc \

--cov=$(SRC) \

--cov-report=xml

.PHONY : test-without-checklist

test-without-checklist :

pytest --color=yes -v -rf --durations=40 \

--cov-config=.coveragerc \

--cov=$(SRC) \

--cov-report=xml \

--ignore-glob=*checklist*

.PHONY : test-checklist

test-checklist :

pytest --color=yes -v -rf --durations=40 \

--cov-config=.coveragerc \

--cov=$(SRC) \

--cov-report=xml \

tests/ \

-k checklist

.PHONY : gpu-tests

gpu-tests : check-for-cuda

pytest --color=yes -v -rf --durations=20 \

--cov-config=.coveragerc \

--cov=$(SRC) \

--cov-report=xml \

-m gpu

.PHONY : benchmarks

benchmarks :

pytest -c benchmarks/pytest.ini benchmarks/

.PHONY : download-extras

download-extras :

$(NLTK_DOWNLOAD_CMD)

.PHONY : install

install :

# Due to a weird thing with pip, we may need egg-info before running `pip install -e`.

# See https://github.com/pypa/pip/issues/4537.

# python setup.py install_egg_info

# Install torch ecosystem first.

$(TORCH_INSTALL)

pip install --upgrade pip

pip install pip-tools

pip-compile requirements.in -o final_requirements.txt --allow-unsafe --rebuild --verbose

pip install -e . -r final_requirements.txt

# These nltk packages are used by the 'checklist' module.

$(NLTK_DOWNLOAD_CMD)

.PHONY : build-all-api-docs

build-all-api-docs :

@$(MD_DOCS_CMD) $(subst /,.,$(subst .py,,$(MD_DOCS_SRC))) -o $(MD_DOCS)

.PHONY : build-docs

build-docs : build-all-api-docs $(MD_DOCS_CONF) $(MD_DOCS) $(MD_DOCS_EXTRAS)

mkdocs build

.PHONY : serve-docs

serve-docs : build-all-api-docs $(MD_DOCS_CONF) $(MD_DOCS) $(MD_DOCS_EXTRAS)

mkdocs serve --dirtyreload

.PHONY : update-docs

update-docs : $(MD_DOCS) $(MD_DOCS_EXTRAS)

$(MD_DOCS_ROOT)README.md : README.md

cp $< $@

# Alter the relative path of the README image for the docs.

$(SED) -i '1s/docs/./' $@

# Alter external doc links to relative links.

$(SED) -i 's|https://docs.allennlp.org/main/api/|api/|' $@

$(MD_DOCS_ROOT)%.md : %.md

cp $< $@

$(MD_DOCS_CONF) : $(MD_DOCS_CONF_SRC) $(MD_DOCS)

python scripts/build_docs_config.py $@ $(MD_DOCS_CONF_SRC) $(MD_DOCS_ROOT) $(MD_DOCS_API_ROOT)

$(MD_DOCS_API_ROOT)%.md : $(SRC)/%.py scripts/py2md.py

mkdir -p $(shell dirname $@)

$(MD_DOCS_CMD) $(subst /,.,$(subst .py,,$<)) --out $@

.PHONY : clean

clean :

rm -rf $(MD_DOCS_TGT)

rm -rf $(MD_DOCS_API_ROOT)

rm -f $(MD_DOCS_ROOT)*.md

rm -rf .pytest_cache/

rm -rf allennlp.egg-info/

rm -rf dist/

rm -rf build/

find . | grep -E '(\.mypy_cache|__pycache__|\.pyc|\.pyo$$)' | xargs rm -rf

.PHONY : docker-image

docker-image :

docker build \

--pull \

-f Dockerfile \

--build-arg TORCH=$(DOCKER_TORCH_VERSION) \

-t $(DOCKER_IMAGE_NAME) .

DOCKER_GPUS = --gpus all

.PHONY : docker-run

docker-run :

$(DOCKER_RUN_CMD) $(DOCKER_GPUS) $(DOCKER_IMAGE_NAME) $(ARGS)

.PHONY : docker-test-image

docker-test-image :

docker build \

--pull \

-f Dockerfile.test \

--build-arg TORCH=$(DOCKER_TEST_TORCH_VERSION) \

-t $(DOCKER_TEST_IMAGE_NAME) .

.PHONY : docker-test-run

docker-test-run :

$(DOCKER_RUN_CMD) --shm-size 2G $(DOCKER_GPUS) $(DOCKER_TEST_IMAGE_NAME) $(ARGS)