Files
OpenBB/website/content/sdk/reference/portfolio/metric/kelly.md
DidierRLopes 4ad995fdd0 Docs/terminalpro and improvement (#5622)
* add first iteration of content for Terminal Pro

* Update index.md

* Update dashboards.md

* Update folders.md

* Update grouping.md

* Update report.md

* Update templates.md

* Update quick-start.md

* Update index.md

* Update index.md

* Update home.md

* Update news.md

* Update index.md

* Update index.md

* Update index.md

* Update data-provider.md

* Update chat-with-widget.md

* Update data-manipulation.md

* Update forecasting.md

* fix: images self closing tags

* fix: only pro visitors can see pro

* inter font

* improve SEO content and restructuring

* add new package for toggle on tutorials

* move folder around

* improve main page of each prod

* small updates and improvements

* fix logo above

* small improvement in headtitle for portfolio funcs

* fix typos from OpenAI's GPT-4

* fix _category_ json

* remove generic SEO words

* add script that generates SEO for documentation

* add missing file

* remove sdk warning message

* fix links for andrew

---------

Co-authored-by: jose-donato <zmcdonato@gmail.com>
Co-authored-by: jose-donato <43375532+jose-donato@users.noreply.github.com>
Co-authored-by: andrewkenreich <andrew.kenreich@gmail.com>
2023-10-30 21:01:29 +00:00

1.5 KiB
Vendored

title, description, keywords
title description keywords
kelly This page provides information on how to use the 'kelly' function from the OpenBB portfolio management library. With detailed parameter explanations to calculate the kelly criterion and examples of usage, it is a valuable reference for portfolio management within the OpenBB environment.
kelly criterion
portfolio management
openbb.portfolio.metric.kelly
portfolio engine
portfolio load

import HeadTitle from '@site/src/components/General/HeadTitle.tsx';

Get kelly criterion

Source Code: [link]

openbb.portfolio.metric.kelly(portfolio_engine: portfolio_engine.PortfolioEngine)

Parameters

Name Type Description Default Optional
portfolio_engine PortfolioEngine PortfolioEngine class instance, this will hold transactions and perform calculations.
Use portfolio.load to create a PortfolioEngine.
None False

Returns

Type Description
pd.DataFrame DataFrame of kelly criterion of the portfolio during different time periods

Examples

from openbb_terminal.sdk import openbb
p = openbb.portfolio.load("openbb_terminal/miscellaneous/portfolio_examples/holdings/example.csv")
output = openbb.portfolio.metric.kelly(p)