Skip to content

Commit ca12ed8

Browse files
authored
Add pytest instructions and GitHub action (#6)
1 parent fb97fd0 commit ca12ed8

File tree

3 files changed

+29
-1
lines changed

3 files changed

+29
-1
lines changed

.github/workflows/test.yml

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
name: Test
2+
on: [push, pull_request]
3+
jobs:
4+
test:
5+
runs-on: ubuntu-latest
6+
steps:
7+
- uses: actions/checkout@v4
8+
- name: Set up Python
9+
uses: actions/setup-python@v5
10+
with:
11+
python-version: '3.x'
12+
- name: Install dependencies
13+
run: |
14+
python -m pip install --upgrade pip
15+
pip install -r requirements.txt
16+
- name: Test with pytest
17+
run: |
18+
pip install pytest
19+
pytest ./src/
20+

README.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# metrax
22

3-
`metrax` is an official JAX metrics library.
3+
`metrax` is a library with standard eval metrics implementations in JAX.
44

55
## Installation
66

@@ -12,6 +12,12 @@ pip install google-metrax
1212

1313
## Development
1414

15+
Run the tests:
16+
17+
```sh
18+
pytest src/metrax
19+
```
20+
1521
Develop the docs locally:
1622

1723
```

requirements.txt

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
clu==0.0.12
2+
scikit-learn==1.6.1

0 commit comments

Comments
 (0)