metric.h File Reference

Copyright 2014-2023 by XGBoost Contributors. More...

#include <dmlc/registry.h>
#include <xgboost/base.h>
#include <xgboost/data.h>
#include <xgboost/host_device_vector.h>
#include <xgboost/model.h>
#include <functional>
#include <memory>
#include <string>
#include <utility>
#include <vector>

Go to the source code of this file.

Data Structures
class	xgboost::Metric
	interface of evaluation metric used to evaluate model performance. This has nothing to do with training, but merely act as evaluation purpose. More...
struct	xgboost::MetricReg
	Registry entry for Metric factory functions. The additional parameter const char* param gives the value after @, can be null. For example, metric map@3, then: param == "3". More...

Namespaces
namespace	xgboost
	namespace of xgboost

Macros
#define	XGBOOST_REGISTER_METRIC(UniqueId, Name)
	Macro to register metric.

Detailed Description

Copyright 2014-2023 by XGBoost Contributors.

interface of evaluation metric function supported in xgboost.

Author

Tianqi Chen, Kailong Chen

Macro Definition Documentation

XGBOOST_REGISTER_METRIC

#define XGBOOST_REGISTER_METRIC	(		UniqueId,
			Name
	)

Value:

  ::xgboost::MetricReg&  __make_ ## MetricReg ## _ ## UniqueId ## __ =  \
      ::dmlc::Registry< ::xgboost::MetricReg>::Get()->__REGISTER__(Name)

Macro to register metric.

// example of registering a objective ndcg@k
XGBOOST_REGISTER_METRIC(RMSE, "ndcg")
.describe("Rooted mean square error.")
.set_body([](const char* param) {
    int at_k = atoi(param);
    return new NDCG(at_k);
  });