statsmodels.tsa.statespace.news.NewsResults.summary_details¶
-
NewsResults.summary_details(source=
'news', impact_date=None, impacted_variable=None, update_date=None, updated_variable=None, groupby='update date', sparsify=True, float_format='%.2f', multiple_tables=False)[source]¶ 创建包含详细影响的汇总表;按日期、变量
- Parameters:¶
- source{
news,revisions} 要汇总的冲击来源。默认是“新闻”。
- impact_date
int,str,datetime,list,array,orslice,optional 指定要显示的特定影响期的观察索引标签或标签切片。影响日期描述了受影响变量受到新闻影响的时期。如果提供了此参数,输出表将仅显示此影响日期或日期。请注意,此参数传递给 Pandas 的 loc 访问器,因此它应与模型的索引标签相对应。如果模型是使用列表或 numpy 数组中的数据创建的,则这些标签将是零索引的观察整数。
- impacted_variable
str,list,array,orslice,optional 观测变量的标签或标签切片,指定要显示的特定受影响变量。受影响的变量描述了受到新闻影响的变量。如果您不知道变量的标签,请检查模型实例的endog_names属性。
- update_date
int,str,datetime,list,array,orslice,optional 观察索引标签或标签切片,指定要显示的特定更新周期。更新日期描述了生成新闻的新数据点可用的周期。有关这些标签的详细信息,请参阅关于impact_date的注释。
- updated_variable
str,list,array,orslice,optional 观测变量的标签或标签切片,指定要显示的特定更新变量。更新变量描述了受新闻影响的变量。如果您不知道变量的标签,请检查模型实例的endog_names属性。
- groupby{
updatedate,updateddate,impactdate,impacteddate} 详细信息表中用于分组结果的主要变量。默认是按更新日期分组。
- sparsifybool,
optional,defaultTrue 将此设置为 False,以便表格在每一行中包含多级索引的每个键。
- float_format
str,optional 用于将数字转换为字符串的格式化字符串语法。 默认值为‘%.2f’。
- multiple_tablesbool,
optional 如果设置为True,此函数将返回一个表格列表,每个表格对应一个唯一的groupby级别。默认值为False,在这种情况下,此函数返回一个单一表格。
- source{
- Returns:¶
- details_table
SimpleTableorlistofSimpleTable 表格或表格列表,描述每次更新(即来自特定变量/日期的消息)如何转化为每个受影响变量/日期的预测变化。
此表包含有关更新及其影响的信息。更新是先前结果集中未提供的新观测数据点。每次更新都会产生新闻,而新闻可能会导致受影响变量的预测发生变化。特定新闻(来自某日期对某些变量的更新)对某日期变量的影响程度取决于可以从模型结果中计算出的权重。
此表中包含的更新相关数据有:
更新日期 : 新增数据点的日期。
更新变量 : 添加了新数据点的变量。
forecast (prev) : 之前模型为给定更新变量和日期所预测的值。
observed : 新数据点的观测值。
新闻 : 新闻是指在给定的更新变量和日期下,观测值与之前预测值之间的差异。
此表中包含的与影响相关的数据有:
影响日期 : 与影响相关的一个日期。
受影响的变量 : 受到新闻影响的变量。
权重 : 从给定的更新日期和更新变量对给定的受影响变量在给定的影响日期上的新闻权重。
影响:在影响日期对受影响变量的平滑估计/预测的修订,具体基于在更新日期由更新变量生成的新闻。
- details_table