Skip to content

Commit 61d722e

Browse files
committed
put 'how to disable-asserts' tip in doc instead of tests docstring
Signed-off-by: Sophie du Couédic <[email protected]>
1 parent 6e7ea76 commit 61d722e

File tree

4 files changed

+3
-15
lines changed

4 files changed

+3
-15
lines changed

docs/contributing/README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -55,6 +55,9 @@ For additional features and advanced configurations, refer to the official [MkDo
5555

5656
## Testing
5757

58+
!!! tip
59+
When running tests, if errors occur, these can be analyzed/debugged by setting `DISABLE_ASSERTS = True` in spyre_util.py and by rerunning the test using `pytest --capture=no tests/spyre/test_spyre_basic.py`. After debugging, `DISABLE_ASSERTS` should be reset to `False`.
60+
5861
### Testing Locally on CPU (No Spyre card)
5962

6063
Optionally, download the `ibm-ai-platform/micro-g3.3-8b-instruct-1b` model:

tests/e2e/test_spyre_basic.py

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,5 @@
11
"""Verification of vLLM output by comparing with HF
22
3-
If errors occur, these can be analyzed/debugged by setting
4-
`DISABLE_ASSERTS = True` in spyre_util.py and by rerunning the
5-
test using `pytest --capture=no tests/spyre/test_spyre_basic.py`
6-
After debugging, `DISABLE_ASSERTS` should be reset to `False`.
7-
83
Run `python -m pytest tests/e2e/test_spyre_basic.py`.
94
"""
105

tests/e2e/test_spyre_max_new_tokens.py

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -31,11 +31,6 @@ def test_output(
3131
The same prompts are also input to HF. The generated output
3232
including text, token ids, and logprobs, is verified to be
3333
identical for vLLM and HF.
34-
35-
If errors occur, these can be analyzed/debugged by setting
36-
'DISABLE_ASSERTS = True' in spyre_util.py and by rerunning the
37-
test using 'pytest --capture=no tests/spyre/test_spyre_max_new_tokens.py'
38-
After debugging, DISABLE_ASSERTS should be reset to 'False'.
3934
'''
4035

4136
prompts = get_chicken_soup_prompts(4)

tests/e2e/test_spyre_warmup_shapes.py

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -34,11 +34,6 @@ def test_output(
3434
The same prompts are also input to HF. The generated
3535
output including text, token ids, and logprobs, is
3636
verified to be identical for vLLM and HF.
37-
38-
If errors occur, these can be analyzed/debugged by setting
39-
'DISABLE_ASSERTS = True' in spyre_util.py and by rerunning the
40-
test using 'pytest --capture=no tests/spyre/test_spyre_warmup_shapes.py'
41-
After debugging, DISABLE_ASSERTS should be reset to 'False'.
4237
'''
4338

4439
prompts = get_chicken_soup_prompts(4)

0 commit comments

Comments
 (0)