Add tests documentation

This commit is contained in:
rockerBOO
2024-12-02 13:48:30 -05:00
parent 5ab00f9b49
commit 63738ecb07

32
tests/README.md Normal file
View File

@@ -0,0 +1,32 @@
# Tests
## Install
```
pip install pytest
```
## Usage
```
pytest
```
## Contribution
Pytest is configured to run tests in this directory. It might be a good idea to add tests closer in the code, as well as doctests.
Tests are functions starting with `test_` and files with the pattern `test_*.py`.
```
def test_x():
assert 1 == 2, "Invalid test response"
```
## Resources
- https://circleci.com/blog/testing-pytorch-model-with-pytest/
- https://pytorch.org/docs/stable/testing.html
- https://github.com/pytorch/pytorch/wiki/Running-and-writing-tests
- https://github.com/huggingface/pytorch-image-models/tree/main/tests
- https://github.com/pytorch/pytorch/tree/main/test