alpenglow.cpp package¶

The classes in this module are usually not used directly, but instead through the alpenglow.Getter class. For more info, read TODO: named parameters, memory management and self_test().

offline_learners¶

class alpenglow.cpp.OfflineLearner¶

Bases: sip.wrapper

iterate()¶

self_test()¶

class alpenglow.cpp.OfflineIteratingLearnerParameters¶

Bases: sip.wrapper

number_of_iterations¶

seed¶

class alpenglow.cpp.OfflineIteratingLearner¶

Bases: alpenglow.cpp.OfflineLearner

add_gradient_updater()¶

add_simple_updater()¶

iterate()¶

self_test()¶

set_gradient_computer()¶

set_model()¶

set_recommender_data()¶

class alpenglow.cpp.OfflineIteratingImplicitLearner¶

Bases: alpenglow.cpp.OfflineLearner

add_gradient_updater()¶

add_simple_updater()¶

iterate()¶

self_test()¶

set_gradient_computer()¶

set_model()¶

set_negative_sample_generator()¶

set_recommender_data()¶

class alpenglow.cpp.OfflineIteratingImplicitLearnerParameters¶

Bases: sip.wrapper

number_of_iterations¶

seed¶

gradient_computers¶

class alpenglow.cpp.GradientComputerPointWise¶

Bases: alpenglow.cpp.GradientComputer

get_gradient()¶

self_test()¶

set_objective()¶

update()¶

class alpenglow.cpp.GradientComputer¶

Bases: alpenglow.cpp.Updater

add_gradient_updater()¶

self_test()¶

set_model()¶

ranking¶

class alpenglow.cpp.RankComputerParameters¶

Bases: sip.wrapper

random_seed¶

top_k¶

class alpenglow.cpp.RankComputer¶

Bases: alpenglow.cpp.INeedExperimentEnvironment, alpenglow.cpp.Initializable

get_rank()¶

init()¶

self_test()¶

set_experiment_environment()¶

set_model()¶

set_model_filter()¶

set_top_pop_container()¶

set_train_matrix()¶

general_interfaces¶

class alpenglow.cpp.Updater¶

Bases: sip.wrapper

self_test()¶

update()¶

class alpenglow.cpp.Initializable¶

Bases: sip.wrapper

This interface signals that the implementing class has to be initialized by the experiment runner. The experiment runner calls the initialize() method, which in return calls the class-specific implementation of init() and sets the is_initialized() flag if the initialization was successful. The init() method can check whether the neccessary dependencies have been initialized or not before initializing the instance; and should return the success value accordingly.

If the initialization was not successful, the experiment runner keeps trying to initialize the not-yet initialized objects, thus resolving dependency chains.

init()¶

Has to be implemented by the component.

Returns:	Whether the initialization was successful.
Return type:	bool

initialize()¶

Returns:	Whether the initialization was successful.
Return type:	bool

is_initialized()¶

Returns:	Whether the component has already been initialized.
Return type:	bool

class alpenglow.cpp.INeedExperimentEnvironment¶

Bases: sip.wrapper

set_experiment_environment()¶

Filters¶

This is the filters header file.

class alpenglow.cpp.DummyModelFilter¶

Bases: alpenglow.cpp.ModelFilter, alpenglow.cpp.INeedExperimentEnvironment, alpenglow.cpp.Initializable

init()¶

run()¶

self_test()¶

set_experiment_environment()¶

set_items()¶

set_users()¶

class alpenglow.cpp.ModelFilter¶

Bases: sip.wrapper

active()¶

run()¶

self_test()¶

class alpenglow.cpp.AvailabilityFilter¶

Bases: alpenglow.cpp.ModelFilter

This is the docstring for AvailabilityFilter. This filter filters the set of available items based on (time,itemId,duration) triplets. These have to be preloaded before using this filter.

Sample code

def some_function():
  interesting = False
  print 'This line is highlighted.'
  print 'This one is not...'
  print '...but this one is.'

# this is python code
f = rs.AvailabilityFilter()
f.add_availability(10,1,10) #item 1 is available in the time interval (10,20)

active()¶

add_availability()¶

get_global_items()¶

run(rec_dat)¶

Summary line.

Extended description of function.

Parameters:	arg1 (int) – Description of arg1 arg2 (str) – Description of arg2
Returns:	Description of return value
Return type:	bool

self_test()¶

class alpenglow.cpp.FactorModelFilter¶

Bases: alpenglow.cpp.ModelFilter, alpenglow.cpp.INeedExperimentEnvironment

get_global_items()¶

get_global_users()¶

run()¶

self_test()¶

set_experiment_environment()¶

set_items()¶

set_model()¶

set_users()¶

loggers¶

class alpenglow.cpp.MemoryRankingLoggerParameters¶

Bases: sip.wrapper

min_time¶

out_file¶

class alpenglow.cpp.RankingLogs¶

Bases: sip.wrapper

logs¶

top_k¶

class alpenglow.cpp.MemoryRankingLogger¶

Bases: alpenglow.cpp.Logger

run()¶

set_model()¶

set_rank_computer()¶

set_ranking_logs()¶

class alpenglow.cpp.RankingLog¶

Bases: sip.wrapper

id¶

item¶

prediction¶

rank¶

score¶

time¶

user¶

class alpenglow.cpp.ListConditionalMetaLogger¶

Bases: alpenglow.cpp.ConditionalMetaLogger

should_run()¶

class alpenglow.cpp.ListConditionalMetaLoggerParameters¶

Bases: sip.wrapper

should_run_vector¶

class alpenglow.cpp.ProceedingLogger¶

Bases: alpenglow.cpp.Logger, alpenglow.cpp.Initializable, alpenglow.cpp.INeedExperimentEnvironment

init()¶

run()¶

self_test()¶

set_data_iterator()¶

set_experiment_environment()¶

class alpenglow.cpp.OnlinePredictorParameters¶

Bases: sip.wrapper

file_name¶

min_time¶

time_frame¶

class alpenglow.cpp.OnlinePredictor¶

Bases: alpenglow.cpp.Logger

run()¶

self_test()¶

set_prediction_creator()¶

class alpenglow.cpp.Logger¶

Bases: sip.wrapper

run()¶

self_test()¶

class alpenglow.cpp.ConditionalMetaLogger¶

Bases: alpenglow.cpp.Logger, alpenglow.cpp.Initializable

init()¶

run()¶

self_test()¶

set_logger()¶

should_run()¶

class alpenglow.cpp.InterruptLogger¶

Bases: alpenglow.cpp.Logger

run()¶

class alpenglow.cpp.OnlinePredictions¶

Bases: sip.wrapper

ids¶

items¶

ranks¶

scores¶

times¶

users¶

class alpenglow.cpp.PredictionLogger¶

Bases: alpenglow.cpp.Logger

get_predictions()¶

run()¶

self_test()¶

set_prediction_creator()¶

models¶

class alpenglow.cpp.ModelGradientUpdater¶

Bases: sip.wrapper

beginning_of_updating_cycle()¶

end_of_updating_cycle()¶

self_test()¶

update()¶

class alpenglow.cpp.ModelSimpleUpdater¶

Bases: alpenglow.cpp.Updater

self_test()¶

update()¶

class alpenglow.cpp.ModelMultiUpdater¶

Bases: sip.wrapper

self_test()¶

update()¶

class alpenglow.cpp.MassPredictor¶

Bases: sip.wrapper

predict()¶

set_model()¶

models.baseline¶

class alpenglow.cpp.TransitionProbabilityModelUpdater¶

Bases: alpenglow.cpp.ModelSimpleUpdater

self_test()¶

set_model()¶

update()¶

class alpenglow.cpp.TransitionProbabilityModelUpdaterParameters¶

Bases: sip.wrapper

filter_freq_updates¶

label_file_name¶

label_transition_mode¶

mode¶

class alpenglow.cpp.NearestNeighborModelUpdater¶

Bases: alpenglow.cpp.ModelSimpleUpdater

end_of_updating()¶

self_test()¶

set_model()¶

update()¶

class alpenglow.cpp.NearestNeighborModelUpdaterParameters¶

Bases: sip.wrapper

compute_similarity_period¶

period_mode¶

class alpenglow.cpp.TransitionProbabilityModel¶

Bases: alpenglow.cpp.Model, alpenglow.cpp.ModelFilter

add()¶

prediction()¶

self_test()¶

class alpenglow.cpp.PersonalPopularityModelUpdater¶

Bases: alpenglow.cpp.ModelSimpleUpdater

self_test()¶

set_model()¶

update()¶

class alpenglow.cpp.PopularityTimeFrameModelUpdater¶

Bases: alpenglow.cpp.ModelSimpleUpdater

self_test()¶

set_model()¶

update()¶

class alpenglow.cpp.PopularityTimeFrameModelUpdaterParameters¶

Bases: sip.wrapper

tau¶

class alpenglow.cpp.NearestNeighborModelParameters¶

Bases: sip.wrapper

direction¶

gamma¶

gamma_threshold¶

norm¶

num_of_neighbors¶

class alpenglow.cpp.NearestNeighborModel¶

Bases: alpenglow.cpp.Model, alpenglow.cpp.ModelFilter

add()¶

prediction()¶

self_test()¶

class alpenglow.cpp.PersonalPopularityModel¶

Bases: alpenglow.cpp.Model

add()¶

prediction()¶

class alpenglow.cpp.PopularityModel¶

Bases: alpenglow.cpp.Model

add()¶

prediction()¶

class alpenglow.cpp.PopularityModelUpdater¶

Bases: alpenglow.cpp.ModelSimpleUpdater

self_test()¶

set_model()¶

update()¶

models.factor¶

class alpenglow.cpp.AsymmetricFactorModelGradientUpdater¶

Bases: alpenglow.cpp.ModelGradientUpdater

beginning_of_updating_cycle()¶

end_of_updating_cycle()¶

self_test()¶

set_model()¶

update()¶

class alpenglow.cpp.AsymmetricFactorModelGradientUpdaterParameters¶

Bases: sip.wrapper

cumulative_item_updates¶

learning_rate¶

class alpenglow.cpp.SvdppModelParameters¶

Bases: sip.wrapper

begin_max¶

begin_min¶

dimension¶

gamma¶

history_weight¶

norm_type¶

seed¶

use_sigmoid¶

user_vector_weight¶

class alpenglow.cpp.SvdppModel¶

Bases: alpenglow.cpp.Model

add()¶

clear()¶

prediction()¶

self_test()¶

class alpenglow.cpp.AsymmetricFactorModelParameters¶

Bases: sip.wrapper

begin_max¶

begin_min¶

dimension¶

gamma¶

initialize_all¶

max_item¶

norm_type¶

seed¶

use_sigmoid¶

class alpenglow.cpp.AsymmetricFactorModel¶

Bases: alpenglow.cpp.Model

add()¶

clear()¶

prediction()¶

self_test()¶

class alpenglow.cpp.FactorModel¶

Bases: alpenglow.cpp.Model, alpenglow.cpp.SimilarityModel, alpenglow.cpp.Initializable

add()¶

clear()¶

init()¶

prediction()¶

self_test()¶

set_item_recency()¶

set_user_recency()¶

similarity()¶

class alpenglow.cpp.FactorModelParameters¶

Bases: sip.wrapper

begin_max¶

begin_min¶

dimension¶

initialize_all¶

max_item¶

max_user¶

use_item_bias¶

use_sigmoid¶

use_user_bias¶

class alpenglow.cpp.FactorModelGradientUpdaterParameters¶

Bases: sip.wrapper

learning_rate¶

learning_rate_bias¶

regularization_rate¶

regularization_rate_bias¶

turn_off_item_bias_updates¶

turn_off_item_factor_updates¶

turn_off_user_bias_updates¶

turn_off_user_factor_updates¶

class alpenglow.cpp.FactorModelGradientUpdater¶

Bases: alpenglow.cpp.ModelGradientUpdater

self_test()¶

set_model()¶

update()¶

class alpenglow.cpp.AsymmetricFactorModelUpdater¶

Bases: alpenglow.cpp.ModelSimpleUpdater

self_test()¶

set_model()¶

update()¶

class alpenglow.cpp.SvdppModelGradientUpdater¶

Bases: alpenglow.cpp.ModelGradientUpdater

beginning_of_updating_cycle()¶

end_of_updating_cycle()¶

init()¶

self_test()¶

set_model()¶

update()¶

class alpenglow.cpp.SvdppModelGradientUpdaterParameters¶

Bases: sip.wrapper

cumulative_item_updates¶

learning_rate¶

class alpenglow.cpp.SvdppModelUpdater¶

Bases: alpenglow.cpp.ModelSimpleUpdater

self_test()¶

set_model()¶

update()¶

class alpenglow.cpp.SimilarityModel¶

Bases: sip.wrapper

similarity()¶

class alpenglow.cpp.Model¶

Bases: sip.wrapper

add()¶

clear()¶

prediction()¶

read()¶

self_test()¶

write()¶

online_experiment¶

class alpenglow.cpp.OnlineExperimentParameters¶

Bases: sip.wrapper

initialize_all¶

lookback¶

max_item¶

max_time¶

max_user¶

min_time¶

random_seed¶

top_k¶

class alpenglow.cpp.OnlineExperiment¶

Bases: sip.wrapper

add_logger()¶

add_updater()¶

inject_experiment_environment_into()¶

run()¶

self_test()¶

set_recommender_data_iterator()¶

class alpenglow.cpp.ExperimentEnvironment¶

Bases: sip.wrapper

get_max_time()¶

get_min_time()¶

get_popularity_container()¶

get_popularity_sorted_container()¶

get_random()¶

get_recommender_data_iterator()¶

get_top_k()¶

get_train_matrix()¶

is_item_new_for_user()¶

is_lookback()¶

set_parameters()¶

update()¶

offline_evaluators¶

class alpenglow.cpp.OfflinePredictions¶

Bases: sip.wrapper

items¶

ranks¶

users¶

class alpenglow.cpp.OfflineRankingComputer¶

Bases: sip.wrapper

compute()¶

set_items()¶

set_toplist_creator()¶

set_users()¶

class alpenglow.cpp.OfflineRankingComputerParameters¶

Bases: sip.wrapper

top_k¶

class alpenglow.cpp.PrecisionRecallEvaluatorParameters¶

Bases: sip.wrapper

cutoff¶

test_file_name¶

test_file_type¶

time¶

class alpenglow.cpp.PrecisionRecallEvaluator¶

Bases: alpenglow.cpp.OfflineEvaluator

evaluate()¶

self_test()¶

set_model()¶

set_model_filter()¶

set_train_data()¶

class alpenglow.cpp.OfflineEvaluator¶

Bases: sip.wrapper

evaluate()¶

self_test()¶

recommender_data¶

class alpenglow.cpp.InlineAttributeReader¶

Bases: sip.wrapper

read_attribute()¶

self_test()¶

class alpenglow.cpp.ShuffleIterator¶

Bases: alpenglow.cpp.RecommenderDataIterator

get()¶

get_following_timestamp()¶

get_future()¶

init()¶

next()¶

class alpenglow.cpp.ShuffleIteratorParameters¶

Bases: sip.wrapper

seed¶

class alpenglow.cpp.RecommenderDataIterator¶

Bases: alpenglow.cpp.Initializable

get()¶

get_counter()¶

get_following_timestamp()¶

get_future()¶

has_next()¶

init()¶

next()¶

set_recommender_data()¶

size()¶

class alpenglow.cpp.DataframeData¶

Bases: alpenglow.cpp.RecommenderData

add_recdats()¶

get()¶

init()¶

size()¶

class alpenglow.cpp.FactorRepr¶

Bases: sip.wrapper

entity¶

factors¶

class alpenglow.cpp.FactorModelReader¶

Bases: sip.wrapper

read()¶

class alpenglow.cpp.UserItemFactors¶

Bases: sip.wrapper

item_factors¶

user_factors¶

class alpenglow.cpp.RecommenderDataParameters¶

Bases: sip.wrapper

file_name¶

type¶

class alpenglow.cpp.RecDat¶

Bases: sip.wrapper

category¶

eval¶

id¶

item¶

score¶

time¶

user¶

class alpenglow.cpp.RecommenderData¶

Bases: alpenglow.cpp.Initializable

get()¶

get_items_into()¶

get_rec_data()¶

get_users_into()¶

init()¶

items()¶

matrix()¶

read_from_file()¶

set_attribute_container()¶

set_max_time()¶

set_rec_dats()¶

size()¶

users()¶

class alpenglow.cpp.RecPred¶

Bases: sip.wrapper

prediction¶

score¶

offline_experiment¶

class alpenglow.cpp.OfflineExperiment¶

Bases: sip.wrapper

add_offline_evaluator()¶

add_offline_learner()¶

run()¶

self_test()¶

utils¶

class alpenglow.cpp.Bias¶

Bases: sip.wrapper

clear()¶

get()¶

init()¶

update()¶

class alpenglow.cpp.SpMatrix¶

Bases: sip.wrapper

clear()¶

erase()¶

get()¶

has_value()¶

increase()¶

insert()¶

read_from_file()¶

resize()¶

row_size()¶

size()¶

update()¶

write_into_file()¶

class alpenglow.cpp.TopPopContainer¶

Bases: sip.wrapper

get_index()¶

get_item()¶

has_changed()¶

increase()¶

reduce()¶

set_threshold()¶

size()¶

class alpenglow.cpp.PopContainer¶

Bases: sip.wrapper

clear()¶

get()¶

increase()¶

reduce()¶

resize()¶

class alpenglow.cpp.PowerLawRecency¶

Bases: alpenglow.cpp.Recency

get()¶

update()¶

class alpenglow.cpp.Recency¶

Bases: sip.wrapper

get()¶

update()¶

class alpenglow.cpp.PowerLawRecencyParameters¶

Bases: sip.wrapper

delta_t¶

exponent¶

class alpenglow.cpp.Random¶

Bases: sip.wrapper

get()¶

get_arctg()¶

get_geometric()¶

get_linear()¶

set()¶

class alpenglow.cpp.PredictionCreatorPersonalized¶

Bases: alpenglow.cpp.PredictionCreator

run()¶

self_test()¶

class alpenglow.cpp.PredictionCreatorGlobalParameters¶

Bases: alpenglow.cpp.PredictionCreatorParameters

initial_threshold¶

class alpenglow.cpp.PredictionCreatorGlobal¶

Bases: alpenglow.cpp.PredictionCreator

run()¶

self_test()¶

class alpenglow.cpp.PredictionCreatorParameters¶

Bases: sip.wrapper

lookback¶

top_k¶

class alpenglow.cpp.PredictionCreatorPersonalizedParameters¶: Bases: alpenglow.cpp.PredictionCreatorParameters

class alpenglow.cpp.PredictionCreator¶

Bases: alpenglow.cpp.INeedExperimentEnvironment, alpenglow.cpp.Initializable

init()¶

run()¶

self_test()¶

set_experiment_environment()¶

set_filter()¶

set_model()¶

set_train_matrix()¶

online_learners¶

class alpenglow.cpp.LearnerPeriodicDelayedWrapper¶

Bases: alpenglow.cpp.Updater

self_test()¶

set_wrapped_learner()¶

update()¶

class alpenglow.cpp.LearnerPeriodicDelayedWrapperParameters¶

Bases: sip.wrapper

delay¶

period¶

class alpenglow.cpp.PeriodicImplicitGradientLearnerParameters¶

Bases: alpenglow.cpp.PeriodicLearnerParameters

learn¶

number_of_iterations¶

seed¶

turn_off_random_shuffling¶

class alpenglow.cpp.PeriodicImplicitGradientLearner¶

Bases: alpenglow.cpp.PeriodicLearner

add_iteration_logger()¶

self_test()¶

set_gradient_computer()¶

set_negative_sample_generator()¶

class alpenglow.cpp.PeriodicLearnerParameters¶

Bases: sip.wrapper

base_in_file_name¶

base_out_file_name¶

clear_model¶

mode¶

period_length¶

read_model¶

samplenum_in_periods¶

start_time¶

write_model¶

class alpenglow.cpp.PeriodicLearner¶

Bases: alpenglow.cpp.Updater, alpenglow.cpp.Initializable, alpenglow.cpp.INeedExperimentEnvironment

add_gradient_updater()¶

add_multi_updater()¶

add_simple_updater()¶

init()¶

self_test()¶

set_experiment_environment()¶

set_model()¶

set_recommender_data_iterator()¶

update()¶

class alpenglow.cpp.ImplicitGradientLearner¶

Bases: alpenglow.cpp.Updater, alpenglow.cpp.Initializable, alpenglow.cpp.INeedExperimentEnvironment

add_gradient_updater()¶

add_multi_updater()¶

add_simple_updater()¶

init()¶

self_test()¶

set_experiment_environment()¶

set_gradient_computer()¶

set_model()¶

set_negative_sample_generator()¶

set_train_matrix()¶

update()¶

class alpenglow.cpp.PeriodicSamplingLearnerParameters¶

Bases: alpenglow.cpp.PeriodicImplicitGradientLearnerParameters

distribution¶

geometric_param¶

number_of_samples¶

y¶

class alpenglow.cpp.PeriodicSamplingLearner¶

Bases: alpenglow.cpp.PeriodicImplicitGradientLearner

self_test()¶

class alpenglow.cpp.OfflineImplicitGradientLearnerParameters¶: Bases: alpenglow.cpp.PeriodicImplicitGradientLearnerParameters

class alpenglow.cpp.OfflineImplicitGradientLearner¶

Bases: alpenglow.cpp.PeriodicImplicitGradientLearner

self_test()¶

objectives¶

class alpenglow.cpp.ObjectiveListWise¶

Bases: sip.wrapper

get_gradient()¶

class alpenglow.cpp.ObjectivePairWise¶: Bases: sip.wrapper

class alpenglow.cpp.ObjectivePointWise¶

Bases: sip.wrapper

get_gradient()¶

class alpenglow.cpp.ObjectiveMSE¶

Bases: alpenglow.cpp.ObjectivePointWise

get_gradient()¶

negative_sample_generators¶

class alpenglow.cpp.UniformNegativeSampleGeneratorParameters¶

Bases: sip.wrapper

filter_repeats¶

initialize_all¶

max_item¶

negative_rate¶

seed¶

class alpenglow.cpp.UniformNegativeSampleGenerator¶

Bases: alpenglow.cpp.NegativeSampleGenerator, alpenglow.cpp.Initializable, alpenglow.cpp.INeedExperimentEnvironment

init()¶

self_test()¶

set_experiment_environment()¶

set_items()¶

set_train_matrix()¶

class alpenglow.cpp.NegativeSampleGenerator¶

Bases: alpenglow.cpp.Updater

add_updater()¶

self_test()¶

update()¶

alpenglow.cpp package¶

offline_learners¶

gradient_computers¶

ranking¶

general_interfaces¶

Filters¶

loggers¶

models¶

models.baseline¶

models.factor¶

online_experiment¶

offline_evaluators¶

recommender_data¶

offline_experiment¶

utils¶

online_learners¶

objectives¶

negative_sample_generators¶

implicit_data_creator¶