Skip to content

Commit b400366

Browse files
add pre-commit documantation into the readme
Signed-off-by: Diego-Castan <[email protected]>
1 parent 65c9031 commit b400366

File tree

1 file changed

+36
-0
lines changed

1 file changed

+36
-0
lines changed

install_pod_files/v3/README.md

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,3 +28,39 @@ wget <https://huggingface.co/datasets/anon8231489123/ShareGPT_Vicuna_unfiltered/
2828
Note:
2929
If you have an error that pandas or dataset packages are missed, we need to run:
3030
pip install vllm[bench]
31+
32+
# Install development environment (in pod, but pre-commit has been also installed in my mac)
33+
34+
1- Install UV:
35+
>> curl -LsSf https://astral.sh/uv/install.sh | sh
36+
37+
2- New venv
38+
>> uv venv --python 3.12 --seed
39+
>> source .venv/bin/activate
40+
41+
3- In CUDA environments:
42+
>> uv pip install -r requirements/common.txt -r requirements/dev.txt --torch-backend=auto
43+
44+
Linting, formatting and static type checking
45+
>> pre-commit install
46+
47+
You can manually run pre-commit with
48+
>> pre-commit run --all-files --show-diff-on-failure
49+
50+
To manually run something from CI that does not run
51+
locally by default, you can run:
52+
>> pre-commit run mypy-3.9 --hook-stage manual --all-files
53+
54+
Unit tests
55+
>> pytest tests/
56+
57+
Run tests for a single test file with detailed output
58+
>> pytest -s -v tests/test_logger.py
59+
60+
4- (In just MAC or local)
61+
>> uv pip install pre-commit
62+
>> pre-commit
63+
64+
5- To run just pre-commit with a hook do:
65+
>> pre-commit run <hook_id>
66+
Check list in .pre-commit-config.yaml

0 commit comments

Comments
 (0)