Awesome

CausalVLR is a python open-source framework for causal relation discovery, causal inference that implements state-of-the-art causal learning algorithms for various visual-linguistic reasoning tasks, such as VQA, Image/Video Captioning, Model Generalization and Robustness, Medical Report Generation, etc.

📘Documentation | 🛠️Installation | 👀Model Zoo | 🆕Update News | 🚀Ongoing Projects | 🤔Reporting Issues

<a id="table-of-contents">📄 Table of Contents </a>

• 📄 Table of Contents
• 📚 Introduction
• 🚀 What's New
• 👨‍🏫 Get Started
• 👀 Model Zoo
• 🎫 License
• 🖊️ Citation
• 🙌 Contribution
• 🤝 Acknowledgement
• 🏗️ Projects in HCPLab

<a id="introduction">📚 Introduction <a href="#table-of-contents">🔝</a> </a>

CausalVLR is a python open-source framework based on PyTorch for causal relation discovery, causal inference that implements state-of-the-art causal learning algorithms for various visual-linguistic reasoning tasks, detail see on Documentation.

• Modular Design

  We decompose the causal framework of visual-linguistic tasks into different components and one can easily construct a customized causal-reasoning framework by combining different modules.

• Support of multiple tasks

  The toolbox directly supports multiple visual-linguistic reasoning tasks such as VQA, Image/Video Caption, Medical Report Generation, Model Generalization and Robustness and so on.

• State of the art

  The toolbox stems from the codebase developed by the HCPLab team, who dedicated to solving a variety of complex logic tasks through causal reasoning, and we keep pushing it forward.

❗ Note: The framework is actively being developed. Feedbacks (issues, suggestions, etc.) are highly encouraged.

<a id="whats-new">🚀 What's New <a href="#table-of-contents">🔝</a> </a>

🔥 2024.04.07.

• 重磅专著《多模态大模型：新一代人工智能技术范式》 在线资源已上线!

🔥 2023.12.12.

• The paper of CaCo-CoT for Faithful Reasoning task in LLMs is opening!

🔥 2023.8.19.

• v0.0.2 was released in 8/19/2023
• Support CaCo-CoT for Faithful Reasoning task in LLMs

🔥 2023.6.29.

• v0.0.1 was released in 6/30/2023
• Support VLCI for Medical Report Generation task
• Support CAMDA (T-PAMI 2023) for Causality-Aware Medical Diagnosis task
• Support CMCIR (T-PAMI 2023) for Event-Level Visual Question Answering task
• Support VCSR (ACM MM 2023) for Video Question Answering task
• Support Robust Fine-tuning (CVPR 2023) for Model Generalization and Robustness

✨ CaCo-CoT-Towards CausalGPT: A Multi-Agent Approach for Faithful Knowledge Reasoning via Promoting Causal Consistency in LLMs

✨ VLCI-Visual Causal Intervention for Radiology Report Generation

✨ CMCIR-Cross-modal Causal Intervention for Event-level Video Question Answering

<a id="get-started">👨‍🏫 Getting Started <a href="#table-of-contents">🔝</a> </a>

Please see Overview for the general introduction of <a hraf="">CausalVLR</a>.

For detailed user guides and advanced guides, please refer to our documentation, and here is the code structure of toolbox.

Installation

Please refer to Installation for installation instructions in documentation.

Briefly, to use CausalVLR, we could install it using pip:

git clone https://github.com/HCPLab-SYSU/CausalVLR.git
pip install -e .

or install from PyPI:

pip install hcpcvlr

Running examples

For causal discovery, there are various running examples in the test directory.

For the implemented modules, we provide unit tests for the convenience of developing your own methods.

Please feel free to let us know if you have any recommendation regarding datasets with high-quality. We are grateful for any effort that benefits the development of causality community.

<a id="license"> 🎫 License <a href="#table-of-contents">🔝</a> </a>

This project is released under the <a hraf="https://github.com/HCPLab-SYSU/CausalVLR/LICENSE">Apache 2.0 license</a>.

<a id="citation"> 🖊️ Citation <a href="#table-of-contents">🔝</a> </a>

If you find this project useful in your research, please consider cite:

@misc{liu2023causalvlr,
      title={CausalVLR: A Toolbox and Benchmark for Visual-Linguistic Causal Reasoning}, 
      author={Yang Liu and Weixing Chen and Guanbin Li and Liang Lin},
      year={2023},
      eprint={2306.17462},
      archivePrefix={arXiv},
      primaryClass={cs.CV}
}

<a id="contribution"> 🙌 Contribution <a href="#table-of-contents">🔝</a> </a>

Please feel free to open an issue if you find anything unexpected. We are always targeting to make our community better!

<a id="acknowledgement"> 🤝 Acknowledgement <a href="#table-of-contents">🔝</a> </a>

CausalVLR is an open-source project and We appreciate all the contributors who implement their methods or add new features and users who give valuable feedback. We wish that the toolbox and benchmark could serve the growing research community by providing a flexible toolkit to reimplement existing methods and develop their new models.

🪐 The review paper here can provide some help

Causal Reasoning Meets Visual Representation Learning: A Prospective Study

Machine Intelligence Research (MIR) 2022
A Review paper for causal reasoning and visual representation learning

@article{
  liu2022causal,
  title={Causal Reasoning Meets Visual Representation Learning: A Prospective Study},
  author={Liu, Yang and Wei, Yu-Shen and Yan, Hong and Li, Guan-Bin and Lin, Liang},
  journal={Machine Intelligence Research},
  pages={1--27},
  year={2022},
  publisher={Springer}
  }

<a id="hcp">🏗️ Projects in HCPLab<a href="#table-of-contents">🔝</a> </a>

• HCP-Diffusion is a toolbox for Stable Diffusion models based on 🤗 Diffusers. It facilitates flexiable configurations and component support for training, in comparison with webui and sd-scripts.