create_metric_definition

重要提示

此功能的部分或全部属于预览版内容。 相关内容和功能可能会发生更改。

create_metric_definition(metric_properties: dict, skip_save_to_lakehouse: bool = False, skip_duplicate_check: bool = False)  

参数:

  • metric_properties (dict):需要创建的指标的属性。 请注意,请确保以 ConfigAndDemoData 湖屋中 ESGMetrics/Config 文件夹中的 metrics_definitions_config.json 文件中指定的相同方式提供属性。 有关更多信息,请转到 预构建的 ESG 指标库
  • skip_save_to_lakehouse (bool,optional):更新 DataFrame,但不保存到湖屋。
  • skip_duplicate_check (bool,optional):跳过检查重复的指标名称。

描述:
将新指标添加到指标定义 DataFrame。

提高:

  • ValueError:如果已存在同名的量度。

用法示例:

metrics_manager = MetricsManager()
metric_properties = {  
    "metric_name": "Gross Scope 1 greenhouse gas emissions",  
    "measure_name": "Emissions",  
    "dimensions": ["EmissionsAggregate[UnitOfMeasureName]", "EmissionsAggregate[ReportingPeriod]"],  
    "filters": {"EmissionsAggregate[isRolledUp]": ["False"], "EmissionsAggregate[Scope]": ["Scope 1"], "EmissionsAggregate[AccountingMethod]": ["Location based", None]},  
    "sustainability_area": "Climate Change",  
    "labels": {"Reporting standard": ["CSRD"], "Disclosure datapoint": ["E1-6_07", "E1-6_01"]}  
}  
metrics_manager.create_metric_definition(metric_properties)