:py:mod:`fragile.core.fractalai`
================================

.. py:module:: fragile.core.fractalai


Module Contents
---------------


Functions
~~~~~~~~~

.. autoapisummary::

   fragile.core.fractalai.l2_norm
   fragile.core.fractalai.relativize
   fragile.core.fractalai.get_alive_indexes
   fragile.core.fractalai.calculate_distance
   fragile.core.fractalai.calculate_virtual_reward
   fragile.core.fractalai.calculate_clone
   fragile.core.fractalai.fai_iteration
   fragile.core.fractalai.clone_tensor
   fragile.core.fractalai.cross_virtual_reward
   fragile.core.fractalai.cross_clone
   fragile.core.fractalai.cross_fai_iteration



Attributes
~~~~~~~~~~

.. autoapisummary::

   fragile.core.fractalai.AVAILABLE_FUNCTIONS


.. py:data:: AVAILABLE_FUNCTIONS
   

   

.. py:function:: l2_norm(x, y)

   Euclidean distance between two batches of points stacked across the first dimension.


.. py:function:: relativize(x)

   Normalize the data using a custom smoothing technique.


.. py:function:: get_alive_indexes(oobs)

   Get indexes representing random alive walkers given a vector of death conditions.


.. py:function:: calculate_distance(observs, distance_function = l2_norm, return_compas = False, oobs = None, compas = None)

   Calculate a distance metric for each walker with respect to a random companion.


.. py:function:: calculate_virtual_reward(observs, rewards, oobs = None, dist_coef = 1.0, reward_coef = 1.0, other_reward = 1.0, return_compas = False, return_distance = False, distance_function = l2_norm)

   Calculate the virtual rewards given the required data.


.. py:function:: calculate_clone(virtual_rewards, oobs = None, eps=1e-08)

   Calculate the clone indexes and masks from the virtual rewards.


.. py:function:: fai_iteration(observs, rewards, oobs = None, dist_coef = 1.0, reward_coef = 1.0, eps=1e-08, other_reward = 1.0, return_compas_dist = False, return_distance = False)

   Perform a FAI iteration.


.. py:function:: clone_tensor(x, compas_ix, will_clone)


.. py:function:: cross_virtual_reward(host_observs, host_rewards, ext_observs, ext_rewards, dist_coef = 1.0, reward_coef = 1.0, return_compas = False, distance_function = l2_norm)

   Calculate the virtual rewards between two cloud of points.


.. py:function:: cross_clone(host_virtual_rewards, ext_virtual_rewards, host_oobs = None, eps=0.001)

   Perform a clone operation between two different groups of points.


.. py:function:: cross_fai_iteration(host_observs, host_rewards, ext_observs, ext_rewards, host_oobs = None, dist_coef = 1.0, reward_coef = 1.0, distance_function = l2_norm, eps = 1e-08)

   Perform a FractalAI cloning process between two clouds of points.