def get(self, exp_id):
""" Get a summary, consisting of:
- The number of get_action calls
- The date of the last get_action call
- The number of set_reward calls
- The date of the last set_reward call
+--------------------------------------------------------------------+
| Example |
+====================================================================+
| http://example.com/stats/EXP_ID/summary |
+--------------------------------------------------------------------+
:requires: A secure cookie, obtained by logging in.
:param int exp_id: The experiment ID for the summary that are to be retrieved.
:returns: A JSON object consisting of the summary.
:raises 401: If the experiment does not belong to this user or the exp_id is wrong.
:raises 401: If user is not logged in or if there is no secure cookie available.
"""
if self.get_current_user():
if self.validate_user_experiment(exp_id):
exp = Experiment(exp_id)
response = exp.get_summary()
self.write(json.dumps(response))
else:
raise ExceptionHandler(
reason="Experiment could not be validated.",
status_code=401)
else:
raise ExceptionHandler(reason="Could not validate user.",
status_code=401)
def get(self, exp_id):
""" Get all the (manually) logged data.
+--------------------------------------------------------------------+
| Example |
+====================================================================+
| http://example.com/stats/EXP_ID/log?limit=10 |
+--------------------------------------------------------------------+
:requires: A secure cookie, obtained by logging in.
:param int exp_id: The experiment ID for the logs that are to be retrieved.
:param int limit (optional): Set an optional limit to the amount of logs returned.
:returns: A list of JSONs of the logs.
:raises 401: If the experiment does not belong to this user or the exp_id is wrong.
:raises 401: If user is not logged in or if there is no secure cookie available.
"""
if self.get_current_user():
if self.validate_user_experiment(exp_id):
limit = int(self.get_argument("limit", default=0))
exp = Experiment(exp_id)
response = exp.get_log_data(limit=limit)
self.write(json.dumps(response))
else:
raise ExceptionHandler(
reason="Experiment could not be validated.",
status_code=401)
else:
raise ExceptionHandler(reason="Could not validate user.",
status_code=401)
def get(self, exp_id):
""" Get the current theta.
+--------------------------------------------------------------------+
| Example |
+====================================================================+
| http://example.com/stats/EXP_ID/currenttheta |
+--------------------------------------------------------------------+
:requires: A secure cookie, obtained by logging in.
:param int exp_id: The experiment ID for the theta that is to be retrieved.
:returns: A JSON of the current theta.
:raises 401: If the experiment does not belong to this user or the exp_id is wrong.
:raises 401: If user is not logged in or if there is no secure cookie available.
"""
if self.get_current_user():
if self.validate_user_experiment(exp_id):
exp = Experiment(exp_id)
response = exp.get_theta()
self.write(json.dumps(response))
else:
raise ExceptionHandler(
reason="Experiment could not be validated.",
status_code=401)
else:
raise ExceptionHandler(reason="Could not validate user.",
status_code=401)
def log_theta():
""" For every experiment, if Theta logging flag is set. Log theta from
redis to mongodb.
"""
redis_db = Database()
mongo_db = MongoLog()
experiment_ids = redis_db.get_experiment_ids()
for experiment_id in experiment_ids:
exp = Experiment(experiment_id)
if exp.properties["hourly_theta"] == "True":
theta = exp.get_theta()
theta["exp_id"] = experiment_id
mongo_db.log_hourly_theta(theta)
def log_theta():
""" For every experiment, if Theta logging flag is set. Log theta from
redis to mongodb.
"""
redis_db = Database()
mongo_db = MongoLog()
experiment_ids = redis_db.get_experiment_ids()
for experiment_id in experiment_ids:
exp = Experiment(experiment_id)
properties = redis_db.get_one_experiment(experiment_id)
if properties['hourlyTheta'] == "True":
theta = exp.get_theta()
theta['exp_id'] = experiment_id
mongo_db.log_hourly_theta(theta)
print("We did it, we stored some stuff!")
def get(self, exp_id):
""" Reset the theta of an experiment.
+--------------------------------------------------------------------+
| Example |
+====================================================================+
| http://example.com/exp/EXP_ID/resetexperiment?key=KEY |
| &theta_key=THETA_KEY&theta_value=THETA_VALUE |
+--------------------------------------------------------------------+
:requires: A secure cookie obtained by logging in.
:param int exp_id: The experiment ID.
:param string key: The key of the experiment.
:param string theta_key (optional): The key for theta used when setting \
theta in the setReward and getAction code.
:param string theta_value (optional): The value for theta used when \
setting theta in the setReward and getAction code.
:raises 401: If the theta_key or theta_value does not exist or is not valid.
:raises 401: If the experiment does not belong to this user or the exp_id is wrong.
:raises 401: If user is not logged in or if there is no secure cookie available.
"""
if self.get_secure_cookie("user"):
if self.validate_user_experiment(exp_id):
key = self.get_argument("key", default=False)
theta_key = self.get_argument("theta_key", default=None)
theta_value = self.get_argument("theta_value", default=None)
__EXP__ = Experiment(exp_id, key)
status = __EXP__.delete_theta(key=theta_key, value=theta_value)
if status >= 1:
self.write(json.dumps({'status': 'success'}))
else:
raise ExceptionHandler(
reason=
"Theta_key or theta_value could not be validated.",
status_code=401)
else:
raise ExceptionHandler(
reason="Experiment could not be validated.",
status_code=401)
else:
raise ExceptionHandler(reason="Could not validate user.",
status_code=401)
def get(self, exp_id):
""" Get an action given a context for a specific exp_id
+----------------------------------------------------------------+
| Example |
+================================================================+
|http://example.com/1/getAction.json?key=XXXX&context={'age': 25}|
+----------------------------------------------------------------+
:param int exp_id: Experiment ID as specified in the url
:param JSON context: The context to be evaluated.
:param string key: The key corresponding to the experiment.
:returns: A JSON of the form: {"action": XX}
:raises AuthErorr: 401 Invalid key
"""
key = self.get_argument("key", default=False)
if not key:
self.set_status(401)
self.write("invalid key")
return
__EXP__ = Experiment(exp_id, key)
if __EXP__.is_valid():
context = json.loads(self.get_argument("context", default="{}"))
response = __EXP__.run_action_code(context)
if self.settings['debug']:
self.write(json.dumps({
'action': response,
'context': context
}))
else:
self.write(json.dumps({'action': response}))
else:
self.set_status(401) # Needs proper error handling
self.write("invalid key")
return
def get(self, exp_id):
""" Get all the (manually) logged data for experiment exp_id.
+--------------------------------------------------------------------+
| Example |
+====================================================================+
| http://example.com/stats/1/getLog.json |
+--------------------------------------------------------------------+
:requires: A secure cookie, obtained by logging in.
:param int exp_id: The experiment ID for the logs that are to be retrieved.
:returns: A JSON of JSONs of the logs.
:raises: AUTH_ERROR if there is no secure cookie available.
"""
if self.get_secure_cookie("user"):
exp = Experiment(exp_id)
response = exp.get_log_data()
self.write(json.dumps(response))
else:
self.write("AUTH_ERROR")
def get(self, exp_id):
""" Get a dict of all logged thetas
+--------------------------------------------------------------------+
| Example |
+====================================================================+
| http://example.com/stats/1/getHourlyTheta.json |
+--------------------------------------------------------------------+
:requires: A secure cookie, obtained by logging in.
:param int exp_id: The experiment ID for the thetas that are to be retrieved.
:returns: A JSON of JSONs of hourly logged thetas.
:raises: AUTH_ERROR if there is no secure cookie available.
"""
if self.get_secure_cookie("user"):
exp = Experiment(exp_id)
response = exp.get_hourly_theta()
self.write(json.dumps(response))
else:
self.write("AUTH_ERROR")
def get(self, exp_id):
""" Get the current theta for experiment id exp_id
+--------------------------------------------------------------------+
| Example |
+====================================================================+
| http://example.com/stats/1/getCurrentTheta.json |
+--------------------------------------------------------------------+
:requires: A secure cookie, obtained by logging in.
:param int exp_id: The experiment ID for the theta that is to be retrieved.
:returns: A JSON of current theta.
:raises: AUTH_ERROR if there is no secure cookie available.
"""
if self.get_secure_cookie("user"):
exp = Experiment(exp_id)
response = exp.get_theta()
self.write(json.dumps(response))
else:
self.write("AUTH_ERROR")
def get(self, exp_id):
""" Update the parameters for a given experiment
+----------------------------------------------------------------+
| Example |
+================================================================+
|http://example.com/1/setReward.json?key=XXXX&context={'age': 25}|
|&action={'action':'A'}&reward={'click':1} |
+----------------------------------------------------------------+
:param int exp_id: Experiment ID as specified in the url
:param JSON context: The context to train on.
:param JSON action: The action to train on.
:param JSON reward: The reward for the experiment.
:param string key: The key corresponding to the experiment.
:returns: A JSON of the form: {"status":true}
:raises KeyError: 400 Error if Key is not valid.
"""
key = self.get_argument("key", default=False)
__EXP__ = Experiment(exp_id, key)
if __EXP__.is_valid():
context = json.loads(self.get_argument("context", default="{}"))
action = json.loads(self.get_argument("action", default="{}"))
reward = json.loads(self.get_argument("reward", default="{}"))
__EXP__.run_reward_code(context, action, reward)
if self.settings['debug']:
self.write(
json.dumps({
'status': 'success',
'action': action,
'context': context,
'reward': reward
}))
else:
self.write(json.dumps({'status': 'success'}))
else:
self.write_error(400) # Needs proper error handling
def advice_time_out():
""" For every experiment, if the advice_id flag is set, we want to
check whether certain advice_id's have timed out according to the
experiment's own settings.
"""
redis_db = Database()
advice_db = Advice()
experiment_ids = redis_db.get_experiment_ids()
for experiment_id in experiment_ids:
# Check experiment properties
exp = Experiment(experiment_id)
if exp.properties["advice_id"] == "True":
# Get all the advices for this experiment
# Check whether or not the date has exceeded the time-out rate
delta_hours = int(exp.properties["delta_hours"])
advices_retrieved = advice_db.advices.find({
"date": {
"$lt": datetime.utcnow() - timedelta(hours=delta_hours)
}
})
for adv in advices_retrieved:
log = exp.get_by_advice_id(str(adv["_id"]))
reward = ast.literal_eval(exp.properties["default_reward"])
exp.run_reward_code(adv["context"], adv["action"], reward)
import sqlite3
from core.voting_rules import rules_global_dict
from core.elicitation_protocols import elicitation_protocols_global_dict
from core.dataset_reader import read_dataset
from core.experiment import Experiment
from core.output_writers import save_result_to_db, create_results_table_with_name
DB_PATH = ".\\db\\data.db"
retrieve_scheduled_experiments = """
SELECT * FROM experiments
WHERE Scheduled = 1
"""
conn = sqlite3.connect(DB_PATH)
c = conn.cursor()
c.execute(retrieve_scheduled_experiments)
scheduled_experiments = c.fetchall()
conn.close()
for experiment_row in scheduled_experiments:
rule = rules_global_dict[experiment_row[1]]
protocol = elicitation_protocols_global_dict[experiment_row[2]]()
dataset_name = experiment_row[3]
alternatives, profiles = read_dataset(dataset_name, DB_PATH)
results_table = experiment_row[4]
create_results_table_with_name(DB_PATH, results_table, dataset_name)
experiment = Experiment(alternatives, profiles, rule, protocol,
save_result_to_db(DB_PATH, results_table))
experiment.execute()
def get(self, exp_id): # Documentation needs update to advice_id
""" Update the parameters and set a reward for a given experiment.
For parameters, there are two options (next to the mandatory key
and exp_id). The first option is supplying all the information manually,
meaning that you supply the following parameters:
- Context
- Action
- Reward
+----------------------------------------------------------------+
| Example |
+================================================================+
|http://example.com/setreward/EXP_ID?key=KEY&context=CONTEXT |
|&action=ACTION&reward=REWARD |
+----------------------------------------------------------------+
When you have toggled the Advice ID in the experiment properties (second option),
and have received an Advice ID from the getaction call, you only have
to supply the following parameters:
- Advice ID
- Reward
+----------------------------------------------------------------+
| Example |
+================================================================+
|http://example.com/setreward/EXP_ID?key=KEY |
|&advice_id=ADVICE_ID&reward=REWARD |
+----------------------------------------------------------------+
:param int exp_id: Experiment ID as specified in the url.
:param string key: The key corresponding to the experiment.
:param JSON context (optional): The context for the current update.
:param JSON action (optional): The action for the current update.
:param string advice_id (optional): The advice_id for the current \
full update loop.
:param JSON reward: The reward for the current update.
:returns: A JSON indicating success.
:raises 400: If key is not supplied.
:raises 401: If the key or exp_id is invalid.
"""
key = self.get_argument("key", default=False)
if not key:
raise ExceptionHandler(reason="Key not supplied.", status_code=400)
__EXP__ = Experiment(exp_id, key)
if __EXP__.is_valid():
if self.get_argument("advice_id", default="") == "":
context = json.loads(self.get_argument("context",
default="{}"))
action = json.loads(self.get_argument("action", default="{}"))
else:
advice_id = self.get_argument("advice_id", default="")
log = __EXP__.get_by_advice_id(advice_id)
if log == False:
self.finish("Advice ID does not exist!")
else:
context = log['context']
action = log['action']
reward = json.loads(self.get_argument("reward", default="{}"))
__EXP__.run_reward_code(context, action, reward)
__EXP__.log_setreward_data(context, action, reward)
if self.settings['debug']:
self.write(
json.dumps({
'status': 'success',
'action': action,
'context': context,
'reward': reward
}))
else:
self.write(json.dumps({'status': 'success'}))
else:
raise ExceptionHandler(reason="Key or exp_id is invalid.",
status_code=401)
def get(self, exp_id): # Documentation needs update to advice_id
""" Get an action given a context for a specific exp_id.
+----------------------------------------------------------------+
| Example |
+================================================================+
|http://example.com/getaction/EXP_ID?key=KEY&context=CONTEXT |
+----------------------------------------------------------------+
:param int exp_id: Experiment ID as specified in the url.
:param string key: The key corresponding to the experiment.
:param JSON context (optional): The context to be evaluated.
:returns: A JSON that standard only includes action. When debug is toggled, \
it returns the context as well. When Advice ID is toggled, it will also return \
an Advice ID that can be used to set the reward later on.
:raises 400: If the key is not supplied.
:raises 401: If the key or exp_id is invalid.
"""
key = self.get_argument("key", default=False)
context = json.loads(self.get_argument("context", default="{}"))
if not key:
raise ExceptionHandler(reason="Key not supplied.", status_code=400)
__EXP__ = Experiment(exp_id, key)
if __EXP__.is_valid():
response = __EXP__.run_action_code(context)
if __EXP__.properties['advice_id'] == "True":
advice_id = __EXP__.gen_advice_id(response.copy(),
context.copy())
__EXP__.log_getaction_data(context, response)
if self.settings['debug'] and __EXP__.properties[
'advice_id'] == "True":
self.write(
json.dumps(
{
'action': response,
'context': context,
'advice_id': advice_id
},
default=json_util.default))
elif __EXP__.properties['advice_id'] == "True":
self.write(
json.dumps({
'action': response,
'advice_id': advice_id
},
default=json_util.default))
elif self.settings['debug']:
self.write(json.dumps({
'action': response,
'context': context
}))
else:
self.write(json.dumps({'action': response}))
else:
raise ExceptionHandler(reason="Key or exp_id is invalid.",
status_code=401)
[
"knowledge_graph", "wikipedia_visualisation", "ship",
"satellite", "wine_quality", "image_recognition"
]]
alternatives5 = {
"knowledge_graph", "wikipedia_visualisation", "ship", "satellite",
"wine_quality", "image_recognition"
}
profile6 = [["train", "bus", "airplane", "walk"],
["bus", "airplane", "train", "walk"],
["airplane", "train", "bus", "walk"]]
alternatives6 = {"train", "bus", "airplane", "walk"}
profile7 = [["ios", "windows", "android"], ["android", "windows", "ios"],
["windows", "ios", "android"]]
alternatives7 = {"ios", "windows", "android"}
# Build dataset
alternatives = [
alternatives1, alternatives2, alternatives3, alternatives4, alternatives5,
alternatives6, alternatives7
]
profiles = [(1, profile1), (2, profile2), (3, profile3), (4, profile4),
(5, profile5), (6, profile6), (7, profile7)]
random_pairwise = RandomPairwiseElicitationProtocol()
test_experiment = Experiment(alternatives, profiles, borda_name,
random_pairwise, save_result_to_file)
test_experiment.execute()
],
[
"satellite", "wine_quality", "image_recognition", "ship",
"knowledge_graph", "wikipedia_visualisation"
],
[
"knowledge_graph", "wikipedia_visualisation", "ship",
"satellite", "wine_quality", "image_recognition"
]]
alternatives5 = {
"knowledge_graph", "wikipedia_visualisation", "ship", "satellite",
"wine_quality", "image_recognition"
}
profile6 = [["train", "bus", "airplane", "walk"],
["bus", "airplane", "train", "walk"],
["airplane", "train", "bus", "walk"]]
alternatives6 = {"train", "bus", "airplane", "walk"}
profile7 = [["ios", "windows", "android"], ["android", "windows", "ios"],
["windows", "ios", "android"]]
alternatives7 = {"ios", "windows", "android"}
# Build dataset
alternatives = [alternatives3]
profiles = [(3, profile3)]
css_regret = CurrentSolutionHeuristicProtocol()
test_experiment = Experiment(alternatives, profiles, borda_name, css_regret,
save_result_to_file)
test_experiment.execute()
from __future__ import print_function from config import config from core.experiment import Experiment config['exp.id'] = "002" config['env.target_range_xz'] = [[-.7, +.7], [+.5, +1.0]] config['view.width'] = 1200 config['view.height'] = 800 exp = Experiment(config) exp.demo()
def get(self, exp_id):
""" Simulate your experiment based on four scripts, which create a closed feedback loop.
+--------------------------------------------------------------------+
| Example |
+====================================================================+
|http://example.com/eval/EXP_ID/simulate?N=1000&log_stats=True |
|&verbose=True&seed=10 |
+--------------------------------------------------------------------+
:requires: A secure cookie, obtained by logging in.
:param int exp_id: Experiment ID as specified in the url.
:param int N: The number of simulation draws.
:param bool log_stats: Flag for logging the results in the database (default is False)
:param bool verbose: Flag for displaying the results in the returning JSON object (default is True)
:param int seed (optional): Set numpy seed.
:returns: A JSON indicating success when verbose flag is False, and a JSON with all the data when verbose flag is True.
:raises 400: If the experiment does not belong to this user or the exp_id is wrong.
:raises 401: If user is not logged in or if there is no secure cookie available.
"""
if self.get_current_user():
if self.validate_user_experiment(exp_id):
N = int(self.get_argument("N", default=1000))
log_stats = self.get_argument("log_stats", default=False)
verbose = self.get_argument("verbose", default=True)
seed = self.get_argument("seed", default=None)
if seed is None:
seed = np.random.randint(2**32 - 1, dtype=np.uint32)
if verbose == "True":
verbose = True
else:
verbose = False
if log_stats == "True":
log_stats = True
else:
log_stats = False
__EXP__ = Experiment(exp_id)
data = {}
with self.temp_seed(int(seed)):
for i in range(N):
# Generate context
context = __EXP__.run_context_code()
# Get action
action = __EXP__.run_action_code(context)
# Generate reward
reward = __EXP__.run_get_reward_code(context, action)
# Set reward
__EXP__.run_reward_code(context, action, reward)
# Get theta
theta = __EXP__.get_theta()
# Save stats
data[str(i)] = {
'context': context.copy(),
'action': action.copy(),
'reward': reward.copy(),
'theta': theta.copy()
}
context.clear()
action.clear()
reward.clear()
if log_stats == True:
__EXP__.log_simulation_data(data.copy())
data_tmp = data.copy()
data.clear()
if verbose == True:
self.write(
json.dumps({
'simulate': 'success',
'experiment': exp_id,
'data': data_tmp
}))
else:
self.write(
json.dumps({
'simulate': 'success',
'experiment': exp_id,
'theta': theta
}))
else:
raise ExceptionHandler(
reason="Experiment could not be validated.",
status_code=401)
else:
raise ExceptionHandler(reason="Could not validate user.",
status_code=401)
