You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
@@ -72,72 +69,29 @@ Head over to the **[documentation on ReadTheDocs](https://pyportfolioopt.readthe
72
69
-[Contributing](#contributing)
73
70
-[Getting in touch](#getting-in-touch)
74
71
75
-
## Getting started
76
-
77
-
If you would like to play with PyPortfolioOpt interactively in your browser, you may launch Binder [here](https://mybinder.org/v2/gh/pyportfolio/pyportfolioopt/main). It takes a
78
-
while to set up, but it lets you try out the cookbook recipes without having to deal with all of the requirements.
79
-
80
-
_Note: macOS users will need to install [Command Line Tools](https://osxdaily.com/2014/02/12/install-command-line-tools-mac-os-x/)._
81
-
82
-
_Note: if you are on windows, you first need to installl C++. ([download](https://visualstudio.microsoft.com/thank-you-downloading-visual-studio/?sku=BuildTools&rel=16), [install instructions](https://drive.google.com/file/d/0B4GsMXCRaSSIOWpYQkstajlYZ0tPVkNQSElmTWh1dXFaYkJr/view))_
83
-
84
-
This project is available on PyPI, meaning that you can just:
85
-
86
-
```bash
87
-
pip install PyPortfolioOpt
88
-
```
89
-
90
-
(you may need to follow separate installation instructions for [cvxopt](https://cvxopt.org/install/index.html#) and [cvxpy](https://www.cvxpy.org/install/)).
91
-
92
-
However, it is best practice to use a dependency manager within a virtual environment.
93
-
My current recommendation is to get yourself set up with [poetry](https://github.com/sdispater/poetry) then just run
94
-
95
-
```bash
96
-
poetry add PyPortfolioOpt
97
-
```
72
+
## 🚀 Installation
98
73
99
-
Otherwise, clone/download the project and in the project directory run:
74
+
### Using pip
100
75
101
76
```bash
102
-
python setup.py install
77
+
pip install pyportfolioopt
103
78
```
104
79
105
-
PyPortfolioOpt supports Docker. Build your first container with `docker build -f docker/Dockerfile . -t pypfopt`. You can use the image to run tests or even launch a Jupyter server.
80
+
### From source
106
81
107
-
```bash
108
-
# iPython interpreter:
109
-
docker run -it pypfopt poetry run ipython
110
-
111
-
# Jupyter notebook server:
112
-
docker run -it -p 8888:8888 pypfopt poetry run jupyter notebook --allow-root --no-browser --ip 0.0.0.0
113
-
# click on http://127.0.0.1:8888/?token=xxx
114
-
115
-
# Pytest
116
-
docker run -t pypfopt poetry run pytest
117
-
118
-
# Bash
119
-
docker run -it pypfopt bash
120
-
```
121
-
122
-
For more information, please read [this guide](https://docker-curriculum.com/#introduction).
123
-
124
-
### For development
125
-
126
-
If you would like to make major changes to integrate this with your proprietary system, it probably makes sense to clone this repository and to just use the source code.
Here is an example on real life stock data, demonstrating how easy it is to find the long-only portfolio that maximises the Sharpe ratio (a measure of risk-adjusted returns).
92
+
Here is an example on real life stock data,
93
+
demonstrating how easy it is to find the long-only portfolio
94
+
that maximises the Sharpe ratio (a measure of risk-adjusted returns).
141
95
142
96
```python
143
97
import pandas as pd
@@ -190,7 +144,10 @@ Annual volatility: 22.2%
190
144
Sharpe Ratio: 1.28
191
145
```
192
146
193
-
This is interesting but not useful in itself. However, PyPortfolioOpt provides a method which allows you to convert the above continuous weights to an actual allocation that you could buy. Just enter the most recent prices, and the desired portfolio size ($10,000 in this example):
147
+
This is interesting but not useful in itself.
148
+
However, PyPortfolioOpt provides a method which allows you to
149
+
convert the above continuous weights to an actual allocation
150
+
that you could buy. Just enter the most recent prices, and the desired portfolio size ($10,000 in this example):
194
151
195
152
```python
196
153
from pypfopt.discrete_allocation import DiscreteAllocation, get_latest_prices
_Disclaimer: nothing about this project constitues investment advice, and the author bears no responsibiltiy for your subsequent investment decisions. Please refer to the [license](https://github.com/PyPortfolio/PyPortfolioOpt/blob/main/LICENSE.txt) for more information._
171
+
_Disclaimer: nothing about this project constitues investment advice,
172
+
and the author bears no responsibiltiy for your subsequent investment decisions.
173
+
Please refer to the [license](https://github.com/PyPortfolio/PyPortfolioOpt/blob/main/LICENSE.txt) for more information._
215
174
216
175
## An overview of classical portfolio optimization methods
217
176
218
-
Harry Markowitz's 1952 paper is the undeniable classic, which turned portfolio optimization from an art into a science. The key insight is that by combining assets with different expected returns and volatilities, one can decide on a mathematically optimal allocation which minimises the risk for a target return – the set of all such optimal portfolios is referred to as the **efficient frontier**.
177
+
Harry Markowitz's 1952 paper is the undeniable classic,
178
+
which turned portfolio optimization from an art into a science.
179
+
The key insight is that by combining assets with different expected returns and volatilities,
180
+
one can decide on a mathematically optimal allocation which minimises
181
+
the risk for a target return – the set of all such optimal portfolios is referred to as the **efficient frontier**.
Although much development has been made in the subject, more than half a century later, Markowitz's core ideas are still fundamentally important and see daily use in many portfolio management firms.
225
-
The main drawback of mean-variance optimization is that the theoretical treatment requires knowledge of the expected returns and the future risk-characteristics (covariance) of the assets. Obviously, if we knew the expected returns of a stock life would be much easier, but the whole game is that stock returns are notoriously hard to forecast. As a substitute, we can derive estimates of the expected return and covariance based on historical data – though we do lose the theoretical guarantees provided by Markowitz, the closer our estimates are to the real values, the better our portfolio will be.
187
+
Although much development has been made in the subject, more than half a century later,
188
+
Markowitz's core ideas are still fundamentally important and see daily use in many portfolio management firms.
189
+
The main drawback of mean-variance optimization is that the theoretical
190
+
treatment requires knowledge of the expected returns and the future risk-characteristics (covariance) of the assets. Obviously, if we knew the expected returns of a stock life would be much easier, but the whole game is that stock returns are notoriously hard to forecast. As a substitute, we can derive estimates of the expected return and covariance based on historical data – though we do lose the theoretical guarantees provided by Markowitz, the closer our estimates are to the real values, the better our portfolio will be.
226
191
227
192
Thus this project provides four major sets of functionality (though of course they are intimately related)
0 commit comments