CARLA
CARLA: A Python Library to Benchmark Algorithmic Recourse and Counterfactual Explanation Algorithms
File Explorer
Download Latest Version (.zip)- main.yml
- __init__.py
- data.py
- __init__.py
- catalog.py
- csv_catalog.py
- load_data.py
- online_catalog.py
- __init__.py
- causal_model.py
- synthethic_data.py
- __init__.py
- load_catalog.py
- __init__.py
- distributions.py
- load_scm.py
- scm.py
- __init__.py
- steps.py
- transformers.py
- __init__.py
- __init__.py
- evaluation.py
- __init__.py
- distance.py
- redundancy.py
- success_rate.py
- time.py
- violations.py
- ynn.py
- __init__.py
- benchmark.py
- process_nans.py
- __init__.py
- mlmodel.py
- __init__.py
- model_ann.py
- __init__.py
- model_ann.py
- __init__.py
- model_linear.py
- __init__.py
- model_linear.py
- __init__.py
- catalog.py
- load_model.py
- parse_xgboost.py
- train_model.py
- trees.py
- __init__.py
- predict.py
- __init__.py
- __init__.py
- barplot.py
- plotting.py
- stripplot.py
- swarmplot.py
- __init__.py
- recourse_method.py
- __init__.py
- losses.py
- __init__.py
- autoencoder.py
- csvae.py
- vae.py
- __init__.py
- save_load.py
- training.py
- __init__.py
- model.py
- __init__.py
- action_set.py
- constraints.py
- cost.py
- model.py
- sampler.py
- samplers.py
- __init__.py
- model.py
- __init__.py
- model.py
- __init__.py
- fc_gauss_cat.py
- models.py
- train.py
- vae_training.py
- __init__.py
- __init__.py
- CLUE_counterfactuals.py
- __init__.py
- gauss_cat.py
- layers.py
- probability.py
- radam.py
- utils.py
- __init__.py
- __init__.py
- __init__.py
- model.py
- __init__.py
- crud.py
- __init__.py
- model.py
- __init__.py
- model.py
- __init__.py
- face_method.py
- __init__.py
- model.py
- __init__.py
- model.py
- __init__.py
- distances.py
- model.py
- __init__.py
- gs_counterfactuals.py
- __init__.py
- model.py
- __init__.py
- model.py
- __init__.py
- roar.py
- __init__.py
- model.py
- __init__.py
- wachter.py
- __init__.py
- model.py
- __init__.py
- __init__.py
- counterfactuals.py
- immutables.py
- __init__.py
- __init__.py
- _version.py
- data_catalog.yaml
- logging.yaml
- mlmodel_catalog.yaml
- architecture.jpg
- adult.csv
- benchmark_example.ipynb
- how_to_use_carla.ipynb
- how_to_use_carla_causal.ipynb
- plotting_example.ipynb
- benchmarking.rst
- conf.py
- data.rst
- examples.rst
- index.rst
- installation.rst
- license.rst
- mlmodel.rst
- plotting.rst
- recourse.rst
- setup.py
- tutorial.rst
- .nojekyll
- make.bat
- Makefile
- run_experiment.py
- carla_logo.png
- carla_logo_square.png
- motivating_cartoon.png
- ann_adult_input_13.h5
- ann_compas_input_7.h5
- ann_give_me_some_credit_input_10.h5
- ann_heloc_input_21.h5
- test_api.py
- test_autoencoder.py
- test_benchmark.py
- test_causal_recourse.py
- test_cfmodel.py
- test_check_hyperparams.py
- test_data.py
- test_distributions.py
- test_evaluations.py
- test_mlmodel.py
- test_mlmodel_train.py
- test_sampler.py
- test_scm.py
- test_xgboost.py
- .flake8
- .gitignore
- .pre-commit-config.yaml
- .readthedocs.yaml
- experimental_setup.yaml
- LICENSE
- Makefile
- MANIFEST.in
- README.md
- requirements-dev.txt
- setup.cfg
- setup.py
# Installation Guide
git clone https://github.com/carla-recourse/CARLA
Downloads the entire project code from GitHub to your computer.
cd CARLA
Moves into the project folder you just downloaded.
2. Official Install Script
Easy Recommended- Python 3 Python is required to use pip.
pip install carla-recourse
Installs the package published on PyPI directly β no need to clone the source.
pip install -U pip setuptools wheel
Installs the package published on PyPI directly β no need to clone the source.
Pulled directly from this repo's README.
3. Python
Easypip install carla-recourse
Installs the package published on PyPI directly β no need to clone the source.
pip install -U pip setuptools wheel
Installs the package published on PyPI directly β no need to clone the source.
pip install -e .
Installs the Python libraries listed in requirements.txt (or similar).
pip install -r requirements-dev.txt
Installs the Python libraries listed in requirements.txt (or similar).
python -m pytest test/*
Runs the Python script (or module).
Pulled directly from this repo's README.
4. Make
Medium- Git Needed to download the project code from GitHub.
- Make Usually pre-installed on Linux/macOS. On Windows, install separately (e.g. via MSYS2 or WSL).
make requirements
Compiles the code based on the generated build configuration to produce an executable.
make test
Compiles the code based on the generated build configuration to produce an executable.
make install-dev
Compiles the code based on the generated build configuration to produce an executable.
Pulled directly from this repo's README.