GridSearch Docs

Class GridSearch

Performs a grid-search on the parameters of a given experiment.

Only accepts Choice as parameter sampler.

Parameters:

• experiment - (Experiment) Experiment to wrap.

Return type: n/a

Example:

exp = Experiment('name', params={'lr': Choice([1, 2, 3])})
gs = GridSearch(exp)

add_result

def add_result(self, *args, **kwargs)

Same as Experiment.add_result but also refreshes the index.

all

def all(self)

Alias for Experiment.all_results()

Example:

e.all()

all_results

def all_results(self)

Iterates through all previous results in no specific order

Parameters: n/a

Return type: iterator

Example:

for res in e.all_results():
    print(res.result)
    print(res.params)

count

def count(self)

Returns the number of JSON summaries.

Parameters: n/a

Return type: int

Example:

e.count()

list

def list(self)

Returns a SummaryList of all results.

Parameters: n/a

Return type: SummaryList

Example:

summaries = exp.list()
summaries.filter(lambda x: x.result > 0.1)

maximum

def maximum(self)

Returns the maximum result from saved results.

Parameters: n/a

Return type: float

Example:

e.maximum()

minimum

def minimum(self)

Returns the minimum result from saved results.

Parameters: n/a

Return type: float

Example:

e.minimum()

refresh_index

def refresh_index(self)

Rebuilds the index of all executed experiments.

Parameters: n/a

Returns: n/a

Example:

gs.refresh_index()

sample

def sample(self, key)

Given current params, choose the experiment that will fill the index.

Parameters:

• key - (string) parameter to sample

Return type: (float) new value of sampled parameter.

Example:

gs.sample('x')

TODO: This function is O(3n), but could be O(n).

sample_all_params

def sample_all_params(self)

Similar to Experiment.sample_all_params()

Returns the first configuration that has been executed less times than the others.

save_state

def save_state(self, path)

Saves the state of the random variables into a file.

Parameters:

• path - (string) target filepath

Return type: n/a

Example:

e.save_state(states/curr_state.pk)

seed

def seed(self, seed)

Manually set a seed value.

Parameters:

• seed - (int) random seed.

Return type: n/a

Example:

e.seed(1234)

set

def set(self, key, value)

set_state

def set_state(self, path)

Sets the state of random variables from a file

Parameters:

• path - (string) target filepath

Return type: n/a

Example:

e.set_state(states/curr_state.pk)

top

def top(self, count, fn=<function <lambda> at 0x7f77b054c8c8>)

Returns the top count best results. By default, minimum.

Parameters:

• count - (int) number of results to return.
• fn - (function) comparison function. Default: leq

Return type: dict of parameters

Example:

e.top(3)