pyphi_config.yml

# PyPhi configuration
# ~~~~~~~~~~~~~~~~~~~
# See the documentation for ``pyphi.config`` for more info.
---
# The measure to use when computing actual causation alpha values.
ACTUAL_CAUSATION_MEASURE: PMI
# In certain cases, making a cut can actually cause a previously reducible
# concept to become a proper, irreducible concept. Assuming this can never
# happen can increase performance significantly, however the obtained results
# are not strictly accurate (IIT 3.0).
ASSUME_CUTS_CANNOT_CREATE_NEW_CONCEPTS: false
# Controls whether the potential purviews of the mechanisms of a network are
# cached. Speeds up calculations when the same network is used repeatedly, but
# takes up additional memory, and makes network initialization slow.
CACHE_POTENTIAL_PURVIEWS: true
# Controls whether cause and effect repertoires are cached.
CACHE_REPERTOIRES: true
# The measure to use when computing big-phi (IIT 3.0).
CES_DISTANCE: SUM_SMALL_PHI
# Controls whether subsystem caches are automatically cleared after computing
# the SIA for the subsystem.
CLEAR_SUBSYSTEM_CACHES_AFTER_COMPUTING_SIA: false
# Controls how distinction phi is normalized.
DISTINCTION_PHI_NORMALIZATION: NUM_CONNECTIONS_CUT
# The version of the theory to use.
IIT_VERSION: 4.0
# The path for the log file.
LOG_FILE: pyphi.log
# The log level to write to `LOG_FILE`.
LOG_FILE_LEVEL: INFO
# The log level to write to stdout.
LOG_STDOUT_LEVEL: WARNING
# Some functions are memoized using an in-memory cache. This is the maximum
# percentage of memory that these caches can collectively use.
MAXIMUM_CACHE_MEMORY_PERCENTAGE: 50
# Determine how ties among specified states are broken.
STATE_TIE_RESOLUTION: PHI
# Determine how ties among MIPs are broken.
MIP_TIE_RESOLUTION: [NORMALIZED_PHI, NEGATIVE_PHI]
# Determine how ties among maximally irreducible purviews are broken.
PURVIEW_TIE_RESOLUTION: PHI
# Controls the number of CPU cores used in parallel evaluation. Negative
# numbers count backwards from the total number of available cores, with
# ``-1`` meaning all available cores.
NUMBER_OF_CORES: -1
# Global switch to turn off parallelization: if ``False``, parallelization is
# never used, regardless of parallelization settings for individual options;
# otherwise parallelization is determined by those settings.
# IMPORTANT:
#   Parallelization requires extra dependencies, which must be
#   installed with `pyphi[parallel]`.
PARALLEL: false
# Controls parallel evaluation of candidate systems within a network.
PARALLEL_COMPLEX_EVALUATION:
  chunksize: 64
  parallel: false
  sequential_threshold: 16
  progress: true
# Controls parallel evaluation of candidate mechanisms.
PARALLEL_CONCEPT_EVALUATION:
  chunksize: 256
  parallel: false
  sequential_threshold: 64
  progress: true
# Controls parallel evaluation of system partitions.
PARALLEL_CUT_EVALUATION:
  chunksize: 4096
  parallel: false
  sequential_threshold: 1024
  progress: false
# Controls parallel evaluation of candidate purviews.
PARALLEL_PURVIEW_EVALUATION:
  chunksize: 256
  parallel: false
  sequential_threshold: 64
  progress: true
# Controls parallel evaluation of mechanism partitions.
PARALLEL_MECHANISM_PARTITION_EVALUATION:
  chunksize: 4096
  parallel: false
  sequential_threshold: 1024
  progress: true
# Controls parallel evaluation of relations.
# Only applies if RELATION_COMPUTATION = 'CONCRETE'.
PARALLEL_RELATION_EVALUATION:
  chunksize: 4096
  parallel: false
  sequential_threshold: 1024
  progress: true
# Controls the partitioning scheme for distinctions.
PARTITION_TYPE: ALL
# Controls the numerical precision with which to compare phi values against each
# other and zero.
PRECISION: 13
# Print numbers as fractions if the denominator isn't too big.
PRINT_FRACTIONS: true
# Global switch to turn off progress bars: if ``False``, progress bars are never
# used, regardless of progress settings for individual options; otherwise the
# use of progress bars is determined by those settings.
PROGRESS_BARS: true
# Keyword arguments to ``ray.init()``. Controls the initialization of the Ray
# cluster used for parallelization / distributed computation.
RAY_CONFIG: {}
# Use a Redis server as a MICE cache.
REDIS_CACHE: false
# Redis connection configuration
REDIS_CONFIG:
  db: 0
  host: localhost
  port: 6379
  test_db: 1
# Controls the definition of the upper bound of the sum of relation phi when
# analyzing a system.
RELATION_COMPUTATION: CONCRETE
# The measure to use when computing integration ("EMD", "KLD", "L1", ...)
REPERTOIRE_DISTANCE: GENERALIZED_INTRINSIC_DIFFERENCE
# The measure to use when computing intrinsic information and findind the
# specified state
REPERTOIRE_DISTANCE_INFORMATION: GENERALIZED_INTRINSIC_DIFFERENCE
# Controls whether pretty __str__-like formatting is used in repr calls.
REPR_VERBOSITY: 2
# Controls whether SIA calculations short-circuit if an a-priori reducibility
# condition is found.
SHORTCIRCUIT_SIA: true
# In some applications of this library, you may want to allow single
# micro-nodes with a self-loop to have nonzero Phi. See ``pyphi.config`` for
# details.
SINGLE_MICRO_NODES_WITH_SELFLOOPS_HAVE_PHI: false
# The type of system cuts to use (IIT 3.0)
SYSTEM_CUTS: 3.0_STYLE
# Whether to include the complete partition in partition set; currently only
# applies to "SET_UNI/BI".
SYSTEM_PARTITION_INCLUDE_COMPLETE: false
# Controls the partitioning scheme for the system.
SYSTEM_PARTITION_TYPE: SET_UNI/BI
# Controls whether a system is validated for conditional independence.
VALIDATE_CONDITIONAL_INDEPENDENCE: true
# Controls whether a subsystem's state is validated when the subsystem is
# created.
VALIDATE_SUBSYSTEM_STATES: true
# Whether to suppress the welcome message.
WELCOME_OFF: false