CausalIQ Core API Reference¶
This is the entry point for the API documentation. It is organised by module, with each module briefly described here to ease navigation of the API and avoid overlong pages.
Main Package¶
The main causaliq_core package exports:
SOFTWARE_VERSION: Legacy software version constant for compatibility- Package metadata (
__version__,VERSION, etc.)
Modules¶
Bayesian Networks¶
Bayesian Networks functionality including network structures, conditional distributions, and I/O operations.
Cache¶
SQLite-backed caching infrastructure with shared token dictionary:
- TokenCache: Core cache with connection management
- Compressors: Pluggable compressors (Compressor, JsonCompressor)
CLI¶
Command-line interface functionality for CausalIQ Core.
Graph¶
Graph-related enumerations and utilities for edge types and marks used in causal discovery.
R Integration¶
Subprocess-based R session management, data conversion, and bnlearn graph utilities:
- Session Management:
run_r_script, Rscript discovery - Availability:
is_r_available,is_r_package_available - Data Conversion:
data_to_r_dataframe,r_arcs_to_edges - bnlearn Utilities:
bnlearn_cpdag,bnlearn_compare,bnlearn_import - Exceptions:
RNotAvailableError,RPackageNotAvailableError,RRuntimeError
Utils¶
Comprehensive utility module with specialized functional areas:
- Mathematical Functions: Number formatting and logarithm calculations
- Environment Detection: System information with caching
- Random Numbers: Reproducible random number generation
- Timing Utilities: Performance measurement and timeouts
- Enhanced enumeration functionality