Skip to content

Commit

Permalink
fix readme
Browse files Browse the repository at this point in the history
  • Loading branch information
zalgo3 committed Nov 7, 2024
1 parent b0c14f7 commit bbd2653
Show file tree
Hide file tree
Showing 2 changed files with 20 additions and 11 deletions.
27 changes: 18 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,35 +22,44 @@ Note that FISTA also requires $f$ to be convex.

- Documentation: https://zalgo3.github.io/zfista/

## Requirements
### Requirements
- Python 3.9 or later

## Install
```sh
### Install
```Shell
pip install zfista
```

## Quickstart
### Quickstart
```python
from zfista import minimize_proximal_gradient
help(minimize_proximal_gradient)
```

## Examples
## For developers

### Installation
```Shell
pip install -e .
```

### Examples
You can run some examples on jupyter notebooks.
```Shell
pip install -e ".[examples]"
jupyter notebook
```

## Testing
### Testing
You can run all tests by
```Shell
python -m unittest discover
pip install tox
tox
```

## Benchmark
### Benchmark
You can run the benchmark by
```Shell
pip install -U joblib matplotlib pandas SciencePlots tqdm
pip install -e ".[bench]"
python runtests.py
```
4 changes: 2 additions & 2 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -25,15 +25,15 @@ docs = [
"sphinxcontrib-katex",
"sphinx_rtd_theme",
]
benchmarks = [
bench = [
"joblib",
"matplotlib",
"pandas",
"SciencePlots",
"tqdm"
]
examples = [
"zfista[benchmarks]",
"zfista[bench]",
"jupyter",
"PyWavelets",
"scikit-image",
Expand Down

0 comments on commit bbd2653

Please sign in to comment.