Medial Code Documentation
Loading...
Searching...
No Matches
Public Member Functions | Protected Member Functions
xgboost::metric::EvalRank Struct Referenceabstract

Evaluate rank list. More...

Inheritance diagram for xgboost::metric::EvalRank:
xgboost::MetricNoCache xgboost::metric::EvalRankConfig xgboost::Metric xgboost::Configurable

Public Member Functions

double Eval (const HostDeviceVector< bst_float > &preds, const MetaInfo &info) override
 
const char * Name () const override
 
- Public Member Functions inherited from xgboost::MetricNoCache
double Evaluate (HostDeviceVector< float > const &predts, std::shared_ptr< DMatrix > p_fmat) final
 Evaluate a metric with DMatrix as input.
 
- Public Member Functions inherited from xgboost::Metric
virtual void Configure (const std::vector< std::pair< std::string, std::string > > &)
 Configure the Metric with the specified parameters.
 
void LoadConfig (Json const &) override
 Load configuration from JSON object By default, metric has no internal configuration; override this function to maintain internal configuration.
 
void SaveConfig (Json *p_out) const override
 Save configuration to JSON object By default, metric has no internal configuration; override this function to maintain internal configuration.
 
 ~Metric () override=default
 virtual destructor
 

Protected Member Functions

 EvalRank (const char *name, const char *param)
 
virtual double EvalGroup (PredIndPairContainer *recptr) const =0
 

Additional Inherited Members

- Static Public Member Functions inherited from xgboost::Metric
static MetricCreate (const std::string &name, Context const *ctx)
 create a metric according to name.
 
- Data Fields inherited from xgboost::metric::EvalRankConfig
unsigned topn {std::numeric_limits<unsigned>::max()}
 
std::string name
 
bool minus {false}
 
- Protected Attributes inherited from xgboost::Metric
Context const * ctx_ {nullptr}
 

Detailed Description

Evaluate rank list.

Member Function Documentation

◆ Eval()

double xgboost::metric::EvalRank::Eval ( const HostDeviceVector< bst_float > &  preds,
const MetaInfo info 
)
inlineoverridevirtual

◆ Name()

const char * xgboost::metric::EvalRank::Name ( ) const
inlineoverridevirtual
Returns
name of metric

Implements xgboost::Metric.


The documentation for this struct was generated from the following file: