File size: 866 Bytes
f7c8b4e
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
# Installation

```{toctree}
:hidden:
```

βˆ‡-Prox works with PyTorch. To install Pytorch, please follow the [PyTorch installation instructions](https://pytorch.org/get-started/locally/).


**Install with pip**

```bash
pip install dprox
```

**Install from source**

```bash
pip install git+https://github.com/princeton-computational-imaging/Delta-Prox.git
```

**Editable installation**

You will need an editable install if you would like to:

1. Use the main version of the source code.
2. Need to test changes in the code.

To do so, clone the repository and install πŸŽ‰ Delta Prox with the following commands:

```
git clone git+https://github.com/princeton-computational-imaging/Delta-Prox.git
cd DeltaProx
pip install -e .
```

```{caution}
Note that you must keep the DeltaProx folder for editable installation if you want to keep using the library.
```