Proposal: Add mypy to .pre-commit-config.yml

[wangkuiyi]

So far, the.pre-commit-config.yml file only calls black and isort. I unintentionally used https://github.pie.apple.com/aiml-oss/ml-recurrent-drafter/blob/main/.pre-commit-config.yaml and discovered the issues addressed in #827 and #828. It may be worthwhile to include mypy and other tools in the above pre-commit configuration.

[awni]

I think its a good idea, especially if we are going to use type annotations (which we do).

[wangkuiyi]

• [ ] gguf_llm/generate.py
• [ ] gguf_llm/models.py
• [ ] llama/convert.py
• [ ] mistral/convert.py
• [ ] mixtral/convert.py
• [ ] mixtral/mixtral.py
• [ ] mlx_lm/lora.py
• [ ] mlx_lm/merge.py
• [ ] mlx_lm/models/cohere.py
• [ ] mlx_lm/models/dbrx.py
• [ ] mlx_lm/models/gemma.py
• [ ] mlx_lm/models/gpt2.py
• [ ] mlx_lm/models/gpt_bigcode.py
• [ ] mlx_lm/models/internlm2.py
• [ ] mlx_lm/models/llama.py
• [ ] mlx_lm/models/minicpm.py
• [ ] mlx_lm/models/mixtral.py
• [ ] mlx_lm/models/olmo.py
• [ ] mlx_lm/models/openelm.py
• [x] mlx_lm/models/phi3.py https://github.com/ml-explore/mlx-examples/pull/833
• [x] mlx_lm/models/phi3small.py https://github.com/ml-explore/mlx-examples/pull/833
• [ ] mlx_lm/models/plamo.py
• [ ] mlx_lm/models/qwen2.py https://github.com/ml-explore/mlx-examples/pull/835
• [ ] mlx_lm/models/qwen2_moe.py https://github.com/ml-explore/mlx-examples/pull/835
• [ ] mlx_lm/models/starcoder2.py https://github.com/ml-explore/mlx-examples/pull/835
• [ ] mlx_lm/server.py
• [ ] mlx_lm/tuner/trainer.py
• [ ] mlx_lm/tuner/utils.py
• [ ] mlx_lm/utils.py
• [ ] speculative_decoding/decoder.py
• [ ] speculative_decoding/model.py
• [ ] tests/test_server.py

I ran the following command to generate the above list of checkable items:

mypy \
  --explicit-package-bases \
  --ignore-missing-imports \
  . | cut -f 1 -d ':' | sort | uniq | sed 's|^|- [ ] |'

I need --explicit-package-base; otherwise, mypy would complain an error like the following and stop working on the rest files in the project:

❯ mypy .
mistral/convert.py: error: Duplicate module named "convert" (also at "./llama/convert.py")
mistral/convert.py: note: See https://mypy.readthedocs.io/en/stable/running_mypy.html#mapping-file-paths-to-modules for more info
mistral/convert.py: note: Common resolutions include: a) using `--exclude` to avoid checking one of them, b) adding `__init__.py` somewhere, c) using `--explicit-package-bases` or adjusting MYPYPATH
Found 1 error in 1 file (errors prevented further checking)

I need --ignore-missing-imports because even if I pip-install mlx and both mlx/ and mlx/nn/ are in conda's site directory, mypy still complains that it couldn't find type informaiton of these packages.