QuickRank  v2.0
QuickRank: A C++ suite of Learning to Rank algorithms
Public Member Functions | List of all members
quickrank::optimization::pre_learning::PreLearningOptimization Class Reference

#include <pre_learning_opt.h>

Inheritance diagram for quickrank::optimization::pre_learning::PreLearningOptimization:
quickrank::optimization::Optimization

Public Member Functions

bool is_pre_learning () const
 
- Public Member Functions inherited from quickrank::optimization::Optimization
 Optimization ()
 
 Optimization (const pugi::xml_document &model)
 Generates a LTR_Algorithm instance from a previously saved XML model. More...
 
virtual ~Optimization ()=default
 
 Optimization (const Optimization &other)=delete
 Avoid inefficient copy constructor. More...
 
Optimizationoperator= (const Optimization &)=delete
 Avoid inefficient copy assignment. More...
 
virtual std::string name () const =0
 Returns the name of the optimizer. More...
 
virtual bool need_partial_score_dataset () const =0
 
virtual void optimize (std::shared_ptr< learning::LTR_Algorithm > algo, std::shared_ptr< data::Dataset > training_dataset, std::shared_ptr< data::Dataset > validation_dataset, std::shared_ptr< metric::ir::Metric > metric, size_t partial_save, const std::string model_filename)=0
 Executes the optimization process. More...
 
virtual void save (std::string model_filename, int suffix=-1) const
 Save the current model to the output_file. More...
 
virtual pugi::xml_document * get_xml_model () const =0
 Return the xml model representing the current object. More...
 

Additional Inherited Members

- Public Types inherited from quickrank::optimization::Optimization
enum  OptimizationAlgorithm { OptimizationAlgorithm::EPRUNING }
 
- Static Public Member Functions inherited from quickrank::optimization::Optimization
static std::shared_ptr< Optimizationload_model_from_file (std::string model_filename)
 Load a model from a given XML file. More...
 
static OptimizationAlgorithm getOptimizationAlgorithm (std::string name)
 
static std::string getPruningMethod (OptimizationAlgorithm optAlgo)
 
- Static Public Attributes inherited from quickrank::optimization::Optimization
static const std::vector< std::string > optimizationAlgorithmNames
 
- Protected Member Functions inherited from quickrank::optimization::Optimization
virtual std::ostream & put (std::ostream &os) const =0
 Prints the description of Algorithm, including its parameters. More...
 

Member Function Documentation

bool quickrank::optimization::pre_learning::PreLearningOptimization::is_pre_learning ( ) const
inlinevirtual

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