Finegrain/refiners
1
0
Fork 0
mirror of https://github.com/finegrain-ai/refiners.git synced 2024-11-09 15:02:01 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

tweak CONTRIBUTING.md section on tests

Browse source
This commit is contained in:
Pierre Chapuis 2023-12-14 18:34:23 +01:00
parent c27fd62fc5
commit 77fb8032c2
1 changed files with 6 additions and 10 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

16
CONTRIBUTING.md
View file

@ -42,7 +42,7 @@ Running end-to-end tests is pretty compute-intensive, and you must convert all t
First, install test dependencies with:
```bash
rye sync --features test
rye sync --features test,conversion
```
Then, download and convert all the necessary weights. Be aware that this will use around 50 GB of disk space:
@ -51,24 +51,20 @@ Then, download and convert all the necessary weights. Be aware that this will us
./scripts/prepare-test-weights.sh
```
To run all the tests, you will need to set the following environment variables:
Finally, run the tests:
```bash
export REFINERS_TEST_DEVICE=cuda:0
export REFINERS_TEST_WEIGHTS_DIR=$(pwd)/tests/weights
rye run pytest
```
In particular, `-k` is handy only to run tests that match a given expression, e.g.:
The `-k` option is handy to run a subset of tests that match a given expression, e.g.:
```bash
rye run pytest -k diffusion_std_init_image tests/e2e/test_diffusion.py
rye run pytest -k diffusion_std_init_image
```
You can also run tests that are lightweight and will run on CPU:
You can enforce running tests on CPU. Tests that require a GPU will be skipped.
```bash
rye run pytest -k "not test_diffusion"
REFINERS_TEST_DEVICE=cpu rye run pytest
```