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().

loggers

class alpenglow.cpp.InputLoggerParameters

Bases: sip.wrapper

output_file
class alpenglow.cpp.InputLogger

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

autocalled_initialize()
run()
self_test()
class alpenglow.cpp.Logger

Bases: sip.wrapper

run()
self_test()
class alpenglow.cpp.RankingLog

Bases: sip.wrapper

id
item
prediction
rank
score
time
user
class alpenglow.cpp.RankingLogs

Bases: sip.wrapper

logs
top_k
class alpenglow.cpp.MemoryRankingLoggerParameters

Bases: sip.wrapper

memory_log
min_time
out_file
class alpenglow.cpp.MemoryRankingLogger

Bases: alpenglow.cpp.Logger

run()
set_model()
set_rank_computer()
set_ranking_logs()
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.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()
class alpenglow.cpp.InterruptLogger

Bases: alpenglow.cpp.Logger

run()
class alpenglow.cpp.ListConditionalMetaLoggerParameters

Bases: sip.wrapper

should_run_vector
class alpenglow.cpp.ListConditionalMetaLogger

Bases: alpenglow.cpp.ConditionalMetaLogger

should_run()
class alpenglow.cpp.ConditionalMetaLogger

Bases: alpenglow.cpp.Logger

run()
self_test()
set_logger()
should_run()
class alpenglow.cpp.ProceedingLogger

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

autocalled_initialize()
run()
self_test()
set_data_iterator()
set_experiment_environment()

online_experiment

class alpenglow.cpp.OnlineExperimentParameters

Bases: sip.wrapper

exclude_known
initialize_all
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

do_exclude_known()
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()
set_parameters()
update()

data_generators

class alpenglow.cpp.CompletePastDataGenerator

Bases: alpenglow.cpp.DataGenerator, alpenglow.cpp.NeedsExperimentEnvironment, alpenglow.cpp.Initializable

autocalled_initialize()
generate_recommender_data()
self_test()
set_experiment_environment()
set_recommender_data_iterator()
class alpenglow.cpp.SamplingDataGeneratorParameters

Bases: sip.wrapper

distribution
geometric_param
number_of_samples
y
class alpenglow.cpp.SamplingDataGenerator

Bases: alpenglow.cpp.DataGenerator, alpenglow.cpp.Initializable, alpenglow.cpp.NeedsExperimentEnvironment

autocalled_initialize()
generate_recommender_data()
self_test()
set_experiment_environment()
set_recommender_data_iterator()
class alpenglow.cpp.TimeframeDataGeneratorParameters

Bases: sip.wrapper

timeframe_length
class alpenglow.cpp.TimeframeDataGenerator

Bases: alpenglow.cpp.DataGenerator, alpenglow.cpp.NeedsExperimentEnvironment, alpenglow.cpp.Initializable

autocalled_initialize()
generate_recommender_data()
self_test()
set_experiment_environment()
set_recommender_data_iterator()
class alpenglow.cpp.DataGenerator

Bases: sip.wrapper

generate_recommender_data()

online_learners

class alpenglow.cpp.PeriodicOfflineLearnerWrapperParameters

Bases: sip.wrapper

base_in_file_name
base_out_file_name
clear_model
learn
read_model
write_model
class alpenglow.cpp.PeriodicOfflineLearnerWrapper

Bases: alpenglow.cpp.Updater

add_offline_learner()
self_test()
set_data_generator()
set_model()
set_period_computer()
update()
class alpenglow.cpp.LearnerPeriodicDelayedWrapperParameters

Bases: sip.wrapper

delay
period
class alpenglow.cpp.LearnerPeriodicDelayedWrapper

Bases: alpenglow.cpp.Updater

self_test()
set_wrapped_learner()
update()

general_interfaces

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 autocalled_initialize() and sets the is_initialized() flag if the initialization was successful. The autocalled_initialize() 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.

Initializing and inheritance. Assume that class Parent implements Initializable, and the descendant Child needs further initialization. In that case Child has to override autocalled_initialize(), and call Parent::autocalled_initialize() in the overriding function first, continuing only if the parent returned true. If the init of the parent was succesful, but the children failed, then the children has to store the success of the parent and omit calling the initialization of the parent later.

autocalled_initialize()

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.NeedsExperimentEnvironment

Bases: sip.wrapper

set_experiment_environment()
class alpenglow.cpp.Updater

Bases: sip.wrapper

self_test()
update()

objectives

class alpenglow.cpp.ObjectivePointWise

Bases: sip.wrapper

get_gradient()
class alpenglow.cpp.ObjectivePairWise

Bases: sip.wrapper

class alpenglow.cpp.ObjectiveListWise

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.NeedsExperimentEnvironment

autocalled_initialize()
self_test()
set_experiment_environment()
set_items()
set_train_matrix()
class alpenglow.cpp.NegativeSampleGenerator

Bases: alpenglow.cpp.Updater

add_updater()
self_test()
update()

offline_evaluators

class alpenglow.cpp.OfflineEvaluator

Bases: sip.wrapper

evaluate()
self_test()
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.OfflineRankingComputerParameters

Bases: sip.wrapper

top_k
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()

utils

class alpenglow.cpp.Random

Bases: sip.wrapper

get()
get_arctg()
get_boolean()
get_discrete()
get_geometric()
get_linear()
set()
class alpenglow.cpp.PopContainer

Bases: sip.wrapper

clear()
get()
increase()
reduce()
resize()
class alpenglow.cpp.TopPopContainer

Bases: sip.wrapper

get_index()
get_item()
has_changed()
increase()
reduce()
set_threshold()
size()
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.Bias

Bases: sip.wrapper

clear()
get()
init()
update()
class alpenglow.cpp.SparseAttributeContainerParameters

Bases: sip.wrapper

class alpenglow.cpp.SparseAttributeContainer

Bases: sip.wrapper

get_max_attribute_index()
class alpenglow.cpp.FileSparseAttributeContainer

Bases: alpenglow.cpp.SparseAttributeContainer

load_from_file()
class alpenglow.cpp.PredictionCreatorParameters

Bases: sip.wrapper

exclude_known
top_k
class alpenglow.cpp.PredictionCreator

Bases: alpenglow.cpp.NeedsExperimentEnvironment, alpenglow.cpp.Initializable

autocalled_initialize()
run()
self_test()
set_experiment_environment()
set_filter()
set_model()
set_train_matrix()
class alpenglow.cpp.PredictionCreatorGlobalParameters

Bases: alpenglow.cpp.PredictionCreatorParameters

initial_threshold
class alpenglow.cpp.PredictionCreatorGlobal

Bases: alpenglow.cpp.PredictionCreator

autocalled_initialize()
run()
self_test()
class alpenglow.cpp.PredictionCreatorPersonalizedParameters

Bases: alpenglow.cpp.PredictionCreatorParameters

class alpenglow.cpp.PredictionCreatorPersonalized

Bases: alpenglow.cpp.PredictionCreator

autocalled_initialize()
run()
self_test()
class alpenglow.cpp.PeriodComputerParameters

Bases: sip.wrapper

period_length
period_mode
start_time
class alpenglow.cpp.PeriodComputer

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

autocalled_initialize()
end_of_period()
get_period_num()
self_test()
set_experiment_environment()
set_parameters()
set_recommender_data_iterator()
update()
class alpenglow.cpp.Recency

Bases: sip.wrapper

get()
update()
class alpenglow.cpp.PowerLawRecencyParameters

Bases: sip.wrapper

delta_t
exponent
class alpenglow.cpp.PowerLawRecency

Bases: alpenglow.cpp.Recency

get()
update()

gradient_computers

class alpenglow.cpp.GradientComputer

Bases: alpenglow.cpp.Updater

add_gradient_updater()
self_test()
set_model()
class alpenglow.cpp.GradientComputerPointWise

Bases: alpenglow.cpp.GradientComputer

self_test()
set_objective()
update()

recommender_data

class alpenglow.cpp.InlineAttributeReader

Bases: sip.wrapper

read_attribute()
self_test()
class alpenglow.cpp.DataframeData

Bases: alpenglow.cpp.RecommenderData

add_recdats()
autocalled_initialize()
get()
size()
class alpenglow.cpp.ShuffleIteratorParameters

Bases: sip.wrapper

seed
class alpenglow.cpp.ShuffleIterator

Bases: alpenglow.cpp.RecommenderDataIterator

autocalled_initialize()
get()
get_actual()
get_following_timestamp()
get_future()
next()
class alpenglow.cpp.RandomIteratorParameters

Bases: sip.wrapper

seed
shuffle_mode
class alpenglow.cpp.RandomIterator

Bases: alpenglow.cpp.RecommenderDataIterator

autocalled_initialize()
get()
get_actual()
get_following_timestamp()
get_future()
next()
restart()
shuffle()
class alpenglow.cpp.RecDat

Bases: sip.wrapper

category
eval
id
item
score
time
user
class alpenglow.cpp.RecPred

Bases: sip.wrapper

prediction
score
class alpenglow.cpp.RecommenderData

Bases: alpenglow.cpp.Initializable

autocalled_initialize()
clear()
get()
get_all_items()
get_all_users()
get_full_matrix()
get_items_into()
get_rec_data()
get_users_into()
set_rec_data()
size()
class alpenglow.cpp.LegacyRecommenderDataParameters

Bases: sip.wrapper

file_name
max_time
type
class alpenglow.cpp.LegacyRecommenderData

Bases: alpenglow.cpp.RecommenderData

autocalled_initialize()
read_from_file()
set_attribute_container()
class alpenglow.cpp.FactorRepr

Bases: sip.wrapper

entity
factors
class alpenglow.cpp.UserItemFactors

Bases: sip.wrapper

item_factors
user_factors
class alpenglow.cpp.FactorModelReader

Bases: sip.wrapper

read()
class alpenglow.cpp.EigenFactorModelReader

Bases: sip.wrapper

read()
class alpenglow.cpp.SimpleIterator

Bases: alpenglow.cpp.RecommenderDataIterator

autocalled_initialize()
get()
get_actual()
get_following_timestamp()
get_future()
next()
class alpenglow.cpp.RecommenderDataIterator

Bases: alpenglow.cpp.Initializable

autocalled_initialize()
get()
get_actual()
get_counter()
get_following_timestamp()
get_future()
has_next()
next()
set_recommender_data()
size()

models

models.baseline

class alpenglow.cpp.PersonalPopularityModel

Bases: alpenglow.cpp.Model

prediction()
class alpenglow.cpp.TransitionProbabilityModelUpdaterParameters

Bases: sip.wrapper

filter_freq_updates
label_file_name
label_transition_mode
mode
class alpenglow.cpp.TransitionProbabilityModelUpdater

Bases: alpenglow.cpp.Updater

self_test()
set_model()
update()
class alpenglow.cpp.PopularityModelUpdater

Bases: alpenglow.cpp.Updater

self_test()
set_model()
update()
class alpenglow.cpp.PopularityModel

Bases: alpenglow.cpp.Model

prediction()
class alpenglow.cpp.PopularityTimeFrameModelUpdaterParameters

Bases: sip.wrapper

tau
class alpenglow.cpp.PopularityTimeFrameModelUpdater

Bases: alpenglow.cpp.Updater

self_test()
set_model()
update()
class alpenglow.cpp.NearestNeighborModelParameters

Bases: sip.wrapper

direction
gamma
gamma_threshold
norm
num_of_neighbors
class alpenglow.cpp.NearestNeighborModel

Bases: alpenglow.cpp.Model

prediction()
self_test()
class alpenglow.cpp.NearestNeighborModelUpdaterParameters

Bases: sip.wrapper

compute_similarity_period
period_mode
class alpenglow.cpp.NearestNeighborModelUpdater

Bases: alpenglow.cpp.Updater

self_test()
set_model()
update()
class alpenglow.cpp.PersonalPopularityModelUpdater

Bases: alpenglow.cpp.Updater

self_test()
set_model()
update()
class alpenglow.cpp.TransitionProbabilityModel

Bases: alpenglow.cpp.Model

clear()
prediction()
self_test()

models.factor

class alpenglow.cpp.FmModelParameters

Bases: sip.wrapper

begin_max
begin_min
dimension
item_attributes
seed
user_attributes
class alpenglow.cpp.FmModel

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

autocalled_initialize()
clear()
prediction()
self_test()
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.SvdppModelUpdater

Bases: alpenglow.cpp.Updater

self_test()
set_model()
update()
class alpenglow.cpp.AsymmetricFactorModelGradientUpdaterParameters

Bases: sip.wrapper

cumulative_item_updates
learning_rate
class alpenglow.cpp.AsymmetricFactorModelGradientUpdater

Bases: alpenglow.cpp.ModelGradientUpdater

beginning_of_updating_cycle()
end_of_updating_cycle()
self_test()
set_model()
update()
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.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.FactorModel

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

add()
autocalled_initialize()
clear()
prediction()
self_test()
set_item_recency()
set_user_recency()
similarity()
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.SvdppModelGradientUpdaterParameters

Bases: sip.wrapper

cumulative_item_updates
learning_rate
class alpenglow.cpp.SvdppModelGradientUpdater

Bases: alpenglow.cpp.ModelGradientUpdater

beginning_of_updating_cycle()
end_of_updating_cycle()
self_test()
set_model()
update()
class alpenglow.cpp.AsymmetricFactorModelUpdater

Bases: alpenglow.cpp.Updater

self_test()
set_model()
update()
class alpenglow.cpp.FmModelUpdaterParameters

Bases: sip.wrapper

learning_rate
class alpenglow.cpp.FmModelUpdater

Bases: alpenglow.cpp.Updater

self_test()
set_model()
update()
class alpenglow.cpp.EigenFactorModelParameters

Bases: sip.wrapper

begin_max
begin_min
dimension
lemp_bucket_size
seed
class alpenglow.cpp.EigenFactorModel

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

add()
autocalled_initialize()
clear()
prediction()
resize()
self_test()

models.combination

class alpenglow.cpp.WeightedModelStructure

Bases: sip.wrapper

distribution_
is_initialized()
models_
class alpenglow.cpp.WMSUpdater

Bases: sip.wrapper

set_wms()
class alpenglow.cpp.ToplistCombinationModel

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

add()
add_model()
autocalled_initialize()
inject_wms_into()
prediction()
self_test()
set_experiment_environment()
class alpenglow.cpp.RandomChoosingCombinedModelExpertUpdaterParameters

Bases: sip.wrapper

eta
loss_type
top_k
class alpenglow.cpp.RandomChoosingCombinedModelExpertUpdater

Bases: alpenglow.cpp.Updater, alpenglow.cpp.WMSUpdater, alpenglow.cpp.Initializable, alpenglow.cpp.NeedsExperimentEnvironment

autocalled_initialize()
self_test()
set_experiment_environment()
set_wms()
update()
class alpenglow.cpp.Evaluator

Bases: sip.wrapper

get_loss()
get_score()
self_test()
class alpenglow.cpp.CombinedModelParameters

Bases: sip.wrapper

log_file_name
log_frequency
use_user_weights
class alpenglow.cpp.CombinedModel

Bases: alpenglow.cpp.Model

add()
add_model()
prediction()
class alpenglow.cpp.RandomChoosingCombinedModel

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

add()
add_model()
autocalled_initialize()
inject_wms_into()
prediction()
self_test()
set_experiment_environment()
class alpenglow.cpp.ExternalModelParameters

Bases: sip.wrapper

mode
class alpenglow.cpp.ExternalModel

Bases: alpenglow.cpp.Model

add()
clear()
prediction()
read_predictions()
self_test()
class alpenglow.cpp.SimilarityModel

Bases: sip.wrapper

self_test()
similarity()
class alpenglow.cpp.ModelGradientUpdater

Bases: sip.wrapper

beginning_of_updating_cycle()
end_of_updating_cycle()
self_test()
update()
class alpenglow.cpp.ModelMultiUpdater

Bases: sip.wrapper

self_test()
update()
class alpenglow.cpp.Model

Bases: sip.wrapper

add()
clear()
prediction()
read()
self_test()
write()
class alpenglow.cpp.MassPredictor

Bases: sip.wrapper

predict()
set_model()

implicit_data_creator

Filters

This is the filters header file.

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

Sample code

def some_function():
  interesting = False
  print 'This line is highlighted.'
  print 'This one is not...'
  print '...but this one is.'
1
2
3
# 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()
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.DummyModelFilter

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

autocalled_initialize()
run()
self_test()
set_experiment_environment()
set_items()
set_users()
class alpenglow.cpp.FactorModelFilter

Bases: alpenglow.cpp.ModelFilter, alpenglow.cpp.NeedsExperimentEnvironment

autocalled_initialize()
get_global_items()
get_global_users()
run()
self_test()
set_experiment_environment()
set_items()
set_model()
set_users()
class alpenglow.cpp.ModelFilter

Bases: sip.wrapper

active()
run()
self_test()

ranking

class alpenglow.cpp.RankComputerParameters

Bases: sip.wrapper

random_seed
top_k
class alpenglow.cpp.RankComputer

Bases: alpenglow.cpp.NeedsExperimentEnvironment, alpenglow.cpp.Initializable

autocalled_initialize()
get_rank()
self_test()
set_experiment_environment()
set_model()
set_model_filter()
set_top_pop_container()
set_train_matrix()

offline_learners

class alpenglow.cpp.OfflineEigenFactorModelALSLearnerParameters

Bases: sip.wrapper

alpha
clear_before_fit
implicit
number_of_iterations
regularization_lambda
class alpenglow.cpp.OfflineEigenFactorModelALSLearner

Bases: alpenglow.cpp.OfflineLearner

fit()
iterate()
self_test()
set_copy_from_model()
set_copy_to_model()
set_model()
class alpenglow.cpp.OfflineLearner

Bases: sip.wrapper

fit()
self_test()
class alpenglow.cpp.OfflineExternalModelLearnerParameters

Bases: sip.wrapper

in_name_base
mode
out_name_base
class alpenglow.cpp.OfflineExternalModelLearner

Bases: alpenglow.cpp.OfflineLearner

fit()
set_model()
class alpenglow.cpp.OfflineIteratingOnlineLearnerWrapperParameters

Bases: sip.wrapper

number_of_iterations
seed
shuffle
class alpenglow.cpp.OfflineIteratingOnlineLearnerWrapper

Bases: alpenglow.cpp.OfflineLearner

add_early_updater()
add_iterate_updater()
add_updater()
fit()
self_test()