pyro-ppl/pyro

[FR] get mcmc.summary() as DataFrame

Open

#3,013 opened on 2022年1月26日

GitHub で見る
 (6 comments) (1 reaction) (0 assignees)Python (8,211 stars) (981 forks)batch import
enhancementhelp wantedusability

説明

First of all thanks for the great package!

Issue Description

One of the useful features of the MCMC class is the MCMC.summary() method which prints summary statistics of the sampled chain.

In this issue I'm asking for the feature to be able to get this table as a Pandas DataFrame.

Code Snippet

def model(data):
    ...

nuts_kernel = NUTS(model)
mcmc = MCMC(nuts_kernel, num_samples=500)
mcmc.run(data)
mcmc.summary()

It would be very helpful if there was a simple way to get mcmc.summary as DataFrame or perhaps alternatively as a dict which can become a DataFrame.

コントリビューターガイド

技術スタック
pythonpandas
領域
datamachine learning
Issue 種別
feature
難度新しい貢献者にとっての実装難度です。1 は非常に小さな変更、5 は専門的な作業です。
2
推定時間経験ある貢献者が調査、実装、テスト、pull request 準備にかけるおおよその時間範囲です。
1-3 hours
活動状況Issue が今どれだけ取り組みやすいかを示します。新しい、活発、古い、ブロック中、またはメンテナー入力待ちなどです。
fresh
明確さ期待される変更、受け入れ条件、次の手順がどれだけ明確かを示します。
clear
前提条件
familiarity with Pyro's MCMC classbasic pandas knowledge
初心者向け度初回貢献者にどれだけ取り組みやすいかを 1-100 で推定したスコアです。
75
調査方針
The feature request is to extend the `MCMC.summary()` method (likely defined in `pyro/infer/mcmc.py`) to optionally return a pandas DataFrame. The current implementation prints a table. A new parameter (e.g., `as dataframe=False`) could be added to return a DataFrame when set to True. The summary statistics are stored internally; extracting them into a dict and converting to DataFrame should be straightforward. Check the existing ` summary` helper and the `Diagnostics` module for formatting. No prior PRs exist for this issue.