ai.evolv

Interface AscendClient

public interface AscendClient

Method Summary

Modifier and Type	Method and Description
void	confirm() Sends a confirmed event to Ascend.
void	contaminate() Sends a contamination event to Ascend.
void	emitEvent(java.lang.String key) Emits a generic event to be recorded by Ascend.
void	emitEvent(java.lang.String key, java.lang.Double score) Emits a generic event to be recorded by Ascend.
<T> T	get(java.lang.String key, T defaultValue) Retrieves a value from the participant's allocation, returns a default upon error.
<T> void	subscribe(java.lang.String key, T defaultValue, AscendAction<T> function) Retrieves a value from Ascend asynchronously and applies some custom action.

Method Detail

get

<T> T get(java.lang.String key,
          T defaultValue)

Retrieves a value from the participant's allocation, returns a default upon error.

Given a unique key this method will retrieve the key's associated value. A default value can also be specified in case any errors occur during the values retrieval. If the allocation call times out or fails the default value is always returned. This method is blocking, it will wait till the allocation is available and then return.

Type Parameters:

T - type of value to be returned

Parameters:

key - a unique key identifying a specific value in the participants allocation

defaultValue - a default value to return upon error

Returns:

a value associated with the given key

subscribe

<T> void subscribe(java.lang.String key,
                   T defaultValue,
                   AscendAction<T> function)

Retrieves a value from Ascend asynchronously and applies some custom action.

This method is non blocking. It will preform the programmed action once the allocation is available. If there is already of stored allocation it will immediately apply the value retrieved and then when the new allocation returns it will reapply the new changes if the experiment has changed.

Type Parameters:

T - type of value to be returned

Parameters:

key - a unique key identifying a specific value in the participants allocation

defaultValue - a default value to return upon error

function - a handler that is invoked when the allocation is updated

emitEvent

void emitEvent(java.lang.String key,
               java.lang.Double score)

Emits a generic event to be recorded by Ascend.

Sends an event to Ascend to be recorded and reported upon. Also records a generic score value to be associated with the event.

Parameters:

key - the identifier of the event

score - a score to be associated with the event

emitEvent

void emitEvent(java.lang.String key)

Emits a generic event to be recorded by Ascend.

Sends an event to Ascend to be recorded and reported upon.

Parameters:

key - the identifier of the event

confirm

void confirm()

Sends a confirmed event to Ascend.

Method produces a confirmed event which confirms the participant's allocation. Method will not do anything in the event that the allocation timed out or failed.

contaminate

void contaminate()

Sends a contamination event to Ascend.

Method produces a contamination event which will contaminate the participant's allocation. Method will not do anything in the event that the allocation timed out or failed.