Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix broken codes #26

Merged
merged 2 commits into from
Nov 7, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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
```
1 change: 1 addition & 0 deletions benchmarks/benchmark.py
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@
import matplotlib.pyplot as plt
import numpy as np
import pandas as pd
import scienceplots # noqa: F401
from joblib import Parallel, delayed
from mpl_toolkits.mplot3d import Axes3D
from tqdm.auto import tqdm
Expand Down
Loading
Loading