API Reference ============= This section provides auto-generated API documentation from the Impact Engine source code. Engine ------ .. automodule:: impact_engine_measure.engine :members: :undoc-members: :show-inheritance: Results ------- .. automodule:: impact_engine_measure.results :members: :show-inheritance: Metrics Layer ------------- Manager ^^^^^^^ .. automodule:: impact_engine_measure.metrics.manager :members: :undoc-members: :show-inheritance: Base Interface ^^^^^^^^^^^^^^ .. automodule:: impact_engine_measure.metrics.base :members: :undoc-members: :show-inheritance: Catalog Simulator Adapter ^^^^^^^^^^^^^^^^^^^^^^^^^ .. automodule:: impact_engine_measure.metrics.catalog_simulator.adapter :members: :undoc-members: :show-inheritance: File Adapter ^^^^^^^^^^^^ .. automodule:: impact_engine_measure.metrics.file.adapter :members: :undoc-members: :show-inheritance: Models Layer ------------ Manager ^^^^^^^ .. automodule:: impact_engine_measure.models.manager :members: :show-inheritance: Base Interface ^^^^^^^^^^^^^^ .. automodule:: impact_engine_measure.models.base :members: :show-inheritance: Interrupted Time Series Adapter ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. automodule:: impact_engine_measure.models.interrupted_time_series.adapter :members: :undoc-members: :show-inheritance: Experiment Adapter ^^^^^^^^^^^^^^^^^^ .. automodule:: impact_engine_measure.models.experiment.adapter :members: :undoc-members: :show-inheritance: Metrics Approximation Adapter ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. automodule:: impact_engine_measure.models.metrics_approximation.adapter :members: :undoc-members: :show-inheritance: Nearest Neighbour Matching Adapter ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. automodule:: impact_engine_measure.models.nearest_neighbour_matching.adapter :members: :undoc-members: :show-inheritance: Subclassification Adapter ^^^^^^^^^^^^^^^^^^^^^^^^^ .. automodule:: impact_engine_measure.models.subclassification.adapter :members: :undoc-members: :show-inheritance: Synthetic Control Adapter ^^^^^^^^^^^^^^^^^^^^^^^^^ .. automodule:: impact_engine_measure.models.synthetic_control.adapter :members: :undoc-members: :show-inheritance: Storage Layer ------------- Manager ^^^^^^^ .. automodule:: impact_engine_measure.storage.manager :members: :undoc-members: :show-inheritance: Base Interface ^^^^^^^^^^^^^^ .. automodule:: impact_engine_measure.storage.base :members: :undoc-members: :show-inheritance: Artifact Store Adapter ^^^^^^^^^^^^^^^^^^^^^^ .. automodule:: impact_engine_measure.storage.artifact_store_adapter :members: :undoc-members: :show-inheritance: