create_metric_definition
Importante
Algunas o todas estas funciones están disponibles como parte de una versión preliminar. El contenido y la funcionalidad están sujetos a cambios.
create_metric_definition(metric_properties: dict, skip_save_to_lakehouse: bool = False, skip_duplicate_check: bool = False)
Parámetros:
- metric_properties (dict): Propiedades de la métrica que se creará. Tenga en cuenta que debe asegurarse de proporcionar las propiedades de la misma manera que se especifica en el archivo metrics_definitions_config.json en la carpeta ESGMetrics/Config en ConfigAndDemoData almacén de lago de datos. Para obtener más información, visite la Biblioteca de métricas ESG preconstruidas.
- skip_save_to_lakehouse (bool, opcional): actualiza el DataFrame pero no lo guarda en almacén de lago de datos.
- skip_duplicate_check (bool, opcional): omite cuenta corriente para nombres de métricas duplicados.
Descripción:
Agrega una nueva métrica al DataFrame de definiciones de métricas.
Aumenta:
ValueError:Si ya existe una métrica con el mismo nombre.
Ejemplo de uso:
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)
