turi::pattern_mining::rule_list Class Reference

#include <toolkits/pattern_mining/rule_mining.hpp>

Public Member Functions
flex_list	get_top_k_rules (const size_t &top_k=TOP_K_MAX, const size_t &score_type=CONF_SCORE, const std::shared_ptr< topk_indexer > &indexer=nullptr) const

Detailed Description

rule_list class A collection of rule structs

Definition at line 64 of file rule_mining.hpp.

Member Function Documentation

get_top_k_rules()

flex_list turi::pattern_mining::rule_list::get_top_k_rules	(	const size_t &	top_k = TOP_K_MAX,
		const size_t &	score_type = CONF_SCORE,
		const std::shared_ptr< topk_indexer > &	indexer = nullptr
	)		const

Extract top_k rules

Args: top_k (size_t) - maximum number of rules to return score_type (size_t) - see score_rules() for explanation of score types indexer (topk_indexer) - convert itemset ids to items Returns: top_rules (vector of flex_list) - the top k rules as flex_list{ [LHS] , [RHS], score}

---

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

• toolkits/pattern_mining/rule_mining.hpp