Welcome to OARS’s documentation!

Contents:

Optimal Algorithms for Resolvent Splitting (oars)

This package provides tools for building custom proximal splitting algorithms.

Using and citing the package

This code comes jointly with the following reference:

Bassett, R. L., & Barkley, P. (2024). Optimal Design of Resolvent Splitting Algorithms.

When using the package in a project, please use this Bibtex entry:

@article{bassett2024optimaldesignresolventsplitting,
      title={Optimal Design of Resolvent Splitting Algorithms},
      author={Robert L Bassett and Peter Barkley},
      journal={arXiv preprint arXiv:2407.16159},
      year={2024},
      url={https://arxiv.org/abs/2407.16159},
}

Installation

After cloning the repository, the package can be installed with pip install .

Quick Start

See the quick start guide in the documentation.

Documentation

You can find the documentation for this package on readthedocs.

Reproducibility

If you would like to run the experiments from our paper, use pip install .[paper] and run the paper.ipynb notebook in the examples directory.