mirror of
https://github.com/OpenBB-finance/OpenBB.git
synced 2026-11-02 15:32:04 +00:00
* Update generate_terminal_markdown.py * updates * update workflows * Automated Change * tests * tests * Automated Change * Update test_generate_docs.py * Automated Change * updates * Automated Change * Update gen-docs.yml * Update test.yml * Automated Change * Update test.yml * Automated Change * Update generate_sdk_markdown.py * Automated Change * test * Automated Change * testtt23 * Automated Change * Update generate_sdk_markdown.py * Automated Change * Automated Change * added empting reference folders before autogen docs * updates * Automated Change * update tests gitactions * Automated Change * up * Automated Change * Automated Change * update pytest * Automated Change * tests * Automated Change * examples update * Automated Change * Update generate_sdk_markdown.py * Automated Change * Update test.yml * Update generate_sdk_markdown.py * strip * Automated Change * Workflow : check test update * Automated Change * Automated Change * Automated Change * Update test.yml * Automated Change * Update test.yml * Automated Change * Automated Change * up * Automated Change * Update generate_sdk_markdown.py * Automated Change * update workflows * fix guides * testing * Update gh-pages.yml * Update gh-pages.yml Co-authored-by: tehcoderer <tehcoderer@users.noreply.github.com> Co-authored-by: Jeroen Bouma <jer.bouma@gmail.com> Co-authored-by: Chavithra PARANA <chavithra@gmail.com> Co-authored-by: Chavithra <Chavithra@users.noreply.github.com> Co-authored-by: jose-donato <43375532+jose-donato@users.noreply.github.com> Co-authored-by: jose-donato <jose-donato@users.noreply.github.com>
1.8 KiB
Vendored
1.8 KiB
Vendored
title, description
| title | description |
|---|---|
| file | OpenBB SDK Function |
file
Load portfolio optimization engine from file
Source Code: [link]
openbb.portfolio.po.file(portfolio_engine: portfolio_optimization.po_engine.PoEngine, parameters_file_path: str)
Parameters
| Name | Type | Description | Default | Optional |
|---|---|---|---|---|
| portfolio_engine | PoEngine | Portfolio optimization engine, by default None Use portfolio.po.load to load a portfolio engine |
None | False |
| parameters_file_path | str | Parameters file full path, by default None | None | False |
Returns
| Type | Description |
|---|---|
| Dict | Loaded parameters |
Examples
from openbb_terminal.sdk import openbb
p = openbb.portfolio.po.load(symbols_file_path="~/openbb_terminal/miscellaneous/portfolio_examples/allocation/60_40_Portfolio.xlsx")
p.get_params()
{}
parameters = openbb.portfolio.po.file(portfolio_engine=p, parameters_file_path="~/openbb_terminal/miscellaneous/portfolio_examples/optimization/defaults.ini")
Parameters:
interval : 3y
log_returns : 0
freq : d
maxnan : 0.05
threshold : 0.3
alpha : 0.05
p.get_params()
{'interval': '3y',
'log_returns': '0',
'freq': 'd',
'maxnan': '0.05',
'threshold': '0.3',
'alpha': '0.05'}
p.set_params({"risk_free_rate": 0.05})
p.get_params()
{'interval': '3y',
'log_returns': '0',
'freq': 'd',
'maxnan': '0.05',
'threshold': '0.3',
'alpha': '0.05',
'risk_free_rate': 0.05}
weights, performance = openbb.portfolio.po.maxsharpe(portfolio_engine=p)