Skip to content

Commit ea25949

Browse files
committed
docs(readme): Fix test import path and add Python version badge
Fix broken test command from 'imlresearch.tests' to 'imlresearch.api.tests'. Add Python 3.10-3.12 badge.
1 parent 389173b commit ea25949

File tree

1 file changed

+4
-1
lines changed

1 file changed

+4
-1
lines changed

README.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,7 @@
11
# ImageMLResearch
2+
3+
[![Python 3.10–3.12](https://img.shields.io/badge/python-3.10%E2%80%933.12-blue.svg)](https://www.python.org/downloads/)
4+
25
ImageMLResearch is a toolkit to help with image-based machine learning projects using Python. It includes functions for data handling, preprocessing, plotting, and more. These functions are combined into a single `Researcher` class to make experimentation easier and more efficient. Please note that this toolkit is specifically designed for image classification tasks and does not support regression problems.
36

47
For comprehensive usage instructions and API details, refer to the [official documentation](https://imagemlresearch.readthedocs.io/en/api-development/index.html).
@@ -45,6 +48,6 @@ pip install --cache-dir=/opt/tmp tensorflow[and-cuda]
4548
The functionality of the code can be tested using the following command:
4649

4750
```python
48-
from imlresearch.tests import run_all_tests
51+
from imlresearch.api.tests import run_all_tests
4952
run_all_tests()
5053
```

0 commit comments

Comments
 (0)