olympus package¶
Subpackages¶
PENDING
olympus.olympus¶
- 
class 
olympus.olympus.Olympus(*args, **kwargs)[source]¶ Bases:
olympus.objects.abstract_object.ObjectMaster class of the olympus package
creates empty object and loads defaults
- Parameters
 me (str) – arbitrary name to identify the object
indent (int) – number of spaces used in string representation
- 
add(prop, attr)¶ dynamically adds property and attribute to object
- Parameters
 prop (any) – property associated with attribute
attr (any) – property value
- 
benchmark(dataset='alkox', planners='all', database=<Database (name=olympus_ce09b6d1, kind=sqlite)>, num_ind_runs=5, num_iter=3)[source]¶ - Parameters
 dataset (str) – the dataset to use
- 
property 
defaults¶ 
- 
from_dict(info_dict)¶ returns object representation of given dictionary
- Parameters
 info_dict (dict) – dictionary to be represented
- Returns
 Object representation of dictionary
- Return type
 Object
- 
from_json(json_file='config.json')¶ 
- 
get(prop)¶ returns attribute associated with given property
- Parameters
 prop (any) – valid property
- Returns
 attribute associated with property
- Return type
 any
- 
reset()¶ 
- 
run(planner='Phoenics', dataset='alkox', model='BayesNeuralNet', goal='default', campaign=<Campaign (dataset=n/a, model=n/a, planner=n/a, num_iter=0)>, database=<Database (name=olympus_1b136bde, kind=sqlite)>, num_iter=3)[source]¶ 
- 
run_analytic(planner='Phoenics', surface='dejong', param_dim=2, goal='minimize', campaign=<Campaign (dataset=n/a, model=n/a, planner=n/a, num_iter=0)>, database=<Database (name=olympus_de48b93c, kind=sqlite)>, num_iter=3)[source]¶ 
- 
to_dict(exclude=[])¶ returns dictionary representation of presented object
- Parameters
 exclude (list of any) – properties to be excluded
- Returns
 representation of presented object
- Return type
 dict
- 
to_json(json_file='config.json')¶ 
- 
update(prop, attr)¶