Skip to content

Commit d722c5c

Browse files
committed
Bump test-dependency ezmsg-simbiophys to 1.3.0 and fixup README.md
1 parent e48a5cd commit d722c5c

2 files changed

Lines changed: 36 additions & 4 deletions

File tree

README.md

Lines changed: 35 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,10 +6,42 @@ This repository contains a Python package with modules for machine learning (ML)
66
77
Processing units include dimensionality reduction, linear regression, and classification that can be initialized with known weights, or adapted on-the-fly with incoming (labeled) data. Machine-learning code depends on `river`, `scikit-learn`, `numpy`, and `torch`.
88

9-
## Getting Started
9+
## Installation
1010

11-
This ezmsg namespace package is still highly experimental and under active development. It is not yet available on PyPI, so you will need to install it from source. The easiest way to do this is to use the `pip` command to install the package directly from GitHub:
11+
Install from PyPI:
1212

1313
```bash
14-
pip install git+https://github.com/ezmsg-org/ezmsg-learn
14+
pip install ezmsg-learn
1515
```
16+
17+
Or install the latest development version:
18+
19+
```bash
20+
pip install git+https://github.com/ezmsg-org/ezmsg-learn@dev
21+
```
22+
23+
## Dependencies
24+
25+
- `ezmsg`
26+
- `ezmsg-baseproc`
27+
- `ezmsg-sigproc`
28+
- `numpy`
29+
- `scipy`
30+
- `scikit-learn`
31+
- `river`
32+
33+
34+
## Development
35+
36+
We use [`uv`](https://docs.astral.sh/uv/getting-started/installation/) for development.
37+
38+
1. Install [`uv`](https://docs.astral.sh/uv/getting-started/installation/) if not already installed.
39+
2. Fork this repository and clone your fork locally.
40+
3. Open a terminal and `cd` to the cloned folder.
41+
4. Run `uv sync` to create a `.venv` and install dependencies.
42+
5. (Optional) Install pre-commit hooks: `uv run pre-commit install`
43+
6. After making changes, run the test suite: `uv run pytest tests`
44+
45+
## License
46+
47+
MIT License - see [LICENSE](LICENSE) for details.

pyproject.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ lint = [
2727
"ruff>=0.12.9",
2828
]
2929
test = [
30-
"ezmsg-simbiophys>=1.0.0",
30+
"ezmsg-simbiophys>=1.3.0",
3131
"hmmlearn>=0.3.3",
3232
"pytest>=8.4.1",
3333
]

0 commit comments

Comments
 (0)