xgboost::Metric 类参考

用于评估模型性能的评估指标接口。这与训练无关，仅用于评估目的。更多...

#include <metric.h>

xgboost::Metric 的继承图

xgboost::Metric 的协作图

公共成员函数
virtual void	Configure (const std::vector< std::pair< std::string, std::string > > &)
	使用指定参数配置 Metric。更多...
void	LoadConfig (Json const &) override
	从 JSON 对象加载配置。默认情况下，度量标准没有内部配置；覆盖此函数以维护内部配置。更多...
void	SaveConfig (Json *p_out) const override
	将配置保存到 JSON 对象。默认情况下，度量标准没有内部配置；覆盖此函数以维护内部配置。更多...
virtual double	Evaluate (HostDeviceVector< bst_float > const &preds, std::shared_ptr< DMatrix > p_fmat)=0
	使用 DMatrix 作为输入评估度量标准。更多...
virtual const char *	Name () const =0
	~Metric () override=default
	虚拟析构函数 更多...
从 xgboost::Configurable 继承的公共成员函数
virtual	~Configurable ()=default

静态公共成员函数
static Metric *	Create (const std::string &name, Context const *ctx)
	根据名称创建度量标准。更多...

保护属性
Context const *	ctx_ {nullptr}

详细描述

用于评估模型性能的评估指标接口。这与训练无关，仅用于评估目的。

构造函数和析构函数文档

~Metric()

xgboost::Metric::~Metric ( )

overridedefault

虚析构函数

成员函数文档

Configure()

virtual void xgboost::Metric::Configure ( const std::vector< std::pair< std::string, std::string > > &  )

inlinevirtual

使用指定参数配置 Metric。

参数

args

目标函数的参数。

Create()

static Metric* xgboost::Metric::Create ( const std::string &  name, Context const *  ctx  )

static

根据名称创建度量标准。

参数

name	度量标准的名称。名称可以是 metric[@]param 形式，名称将在注册表中进行匹配。
ctx	全局上下文

返回

创建的度量标准。

Evaluate()

virtual double xgboost::Metric::Evaluate ( HostDeviceVector< bst_float > const &  preds, std::shared_ptr< DMatrix >  p_fmat  )

纯虚函数

使用 DMatrix 作为输入评估度量标准。

参数

preds	预测
p_fmat	包含标签等相关信息的 DMatrix。

LoadConfig()

void xgboost::Metric::LoadConfig ( Json const &  )

inlineoverridevirtual

从 JSON 对象加载配置。默认情况下，度量标准没有内部配置；覆盖此函数以维护内部配置。

参数

in	包含配置的 JSON 对象

实现了 xgboost::Configurable。

Name()

virtual const char* xgboost::Metric::Name ( ) const

纯虚函数

返回

度量标准名称

SaveConfig()

void xgboost::Metric::SaveConfig ( Json *  p_out ) const

inlineoverridevirtual

将配置保存到 JSON 对象。默认情况下，度量标准没有内部配置；覆盖此函数以维护内部配置。

参数

out	指向输出 JSON 对象的指针

实现了 xgboost::Configurable。

成员数据文档

ctx_

Context const* xgboost::Metric::ctx_ {nullptr}

protected

---

此类的文档由以下文件生成

• /home/docs/checkouts/readthedocs.org/user_builds/xgboost/checkouts/stable/include/xgboost/metric.h