models.actual_causation

Objects that represent structures used in actual causation.

pyphi.models.actual_causation.greater_than_zero(alpha)

Return True if alpha is greater than zero, accounting for numerical errors.

class pyphi.models.actual_causation.AcRepertoireIrreducibilityAnalysis(alpha, state, direction, mechanism, purview, partition, probability, partitioned_probability, node_labels=None)

A minimum information partition for ac_coef calculation.

These can be compared with the built-in Python comparison operators (<, >, etc.). First, \(\alpha\) values are compared. Then, if these are equal up to PRECISION, the size of the mechanism is compared.

alpha

float – This is the difference between the mechanism’s unpartitioned and partitioned actual probability.

state

tuple[int] – state of system in specified direction (cause, effect)

direction

str – The temporal direction specifiying whether this analysis should be calculated with cause or effect repertoires.

mechanism

tuple[int] – The mechanism to analyze.

purview

tuple[int] – The purview over which the unpartitioned actual probability differs the least from the actual probability of the partition.

partition

tuple[Part, Part] – The partition that makes the least difference to the mechanism’s repertoire.

probability

float – The probability of the state in the previous/next timestep.

partitioned_probability

float – The probability of the state in the partitioned repertoire.

unorderable_unless_eq = ['direction']
order_by()

Return a list of values to compare for ordering.

The first value in the list has the greatest priority; if the first objects are equal the second object is compared, etc.

__bool__()

An AcRepertoireIrreducibilityAnalysis is True if it has \(\alpha > 0\).

phi

Alias for \(\alpha\) for PyPhi utility functions.

to_json()

Return a JSON-serializable representation.

A maximally irreducible actual cause or effect.

These can be compared with the built-in Python comparison operators (<, >, etc.). First, \(\alpha\) values are compared. Then, if these are equal up to PRECISION, the size of the mechanism is compared.

alpha

float – The difference between the mechanism’s unpartitioned and partitioned actual probabilities.

phi

Alias for \(\alpha\) for PyPhi utility functions.

direction

Direction – Either CAUSE or EFFECT.

mechanism

list[int] – The mechanism for which the action is evaluated.

purview

list[int] – The purview over which this mechanism’s \(\alpha\) is maximal.

ria

AcRepertoireIrreducibilityAnalysis – The irreducibility analysis for this mechanism.

node_labels
unorderable_unless_eq = ['direction']
order_by()

Return a list of values to compare for ordering.

The first value in the list has the greatest priority; if the first objects are equal the second object is compared, etc.

__bool__()

An CausalLink is True if \(\alpha > 0\).

to_json()

Return a JSON-serializable representation.

class pyphi.models.actual_causation.Event

A mechanism which has both an actual cause and an actual effect.

actual_cause

CausalLink – The actual cause of the mechanism.

actual_effect

CausalLink – The actual effect of the mechanism.

Create new instance of Event(actual_cause, actual_effect)

mechanism

The mechanism of the event.

class pyphi.models.actual_causation.Account(causal_links)

The set of CausalLink with \(\alpha > 0\). This includes both actual causes and actual effects.

irreducible_causes

The set of irreducible causes in this Account.

irreducible_effects

The set of irreducible effects in this Account.

to_json()
classmethod from_json(dct)
class pyphi.models.actual_causation.DirectedAccount(causal_links)

The set of CausalLink with \(\alpha > 0\) for one direction of a transition.

class pyphi.models.actual_causation.AcSystemIrreducibilityAnalysis(alpha=None, direction=None, account=None, partitioned_account=None, transition=None, cut=None)

An analysis of transition-level irreducibility (\(\mathcal{A}\)).

Contains the \(\mathcal{A}\) value of the Transition, the causal account, and all the intermediate results obtained in the course of computing them.

alpha

float – The \(\mathcal{A}\) value for the transition when taken against this analysis, i.e. the difference between the unpartitioned account and this analysis’s partitioned account.

account

Account – The account of the whole transition.

partitioned_account

Account – The account of the partitioned transition.

transition

Transition – The transition this analysis was calculated for.

cut

ActualCut – The minimal partition.

before_state

Return the actual previous state of the Transition.

after_state

Return the actual current state of the Transition.

unorderable_unless_eq = ['direction']
order_by()

Return a list of values to compare for ordering.

The first value in the list has the greatest priority; if the first objects are equal the second object is compared, etc.

__bool__()

An AcSystemIrreducibilityAnalysis is True if it has \(\mathcal{A} > 0\).

to_json()