mirror of
https://github.com/OpenBB-finance/OpenBB.git
synced 2026-11-03 07:51:49 +00:00
4ad995fdd0
* 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>
1.5 KiB
Vendored
1.5 KiB
Vendored
title, description, keywords
| title | description | keywords | ||||
|---|---|---|---|---|---|---|
| commonsense | This documentation page includes details on how to get the commonsense ratio for a portfolio within the OpenBB-framework using Python. It explains the use of the PortfolioEngine class and provides examples using the openbb.portfolio.load and openbb.portfolio.metric.commonsense functions. |
|
import HeadTitle from '@site/src/components/General/HeadTitle.tsx';
Get common sense ratio
Source Code: [link]
openbb.portfolio.metric.commonsense(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 the portfolios and the benchmarks common sense ratio 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.commonsense(p)