CBX Experiments

Welcome to the CBX Experiments repository. This project is dedicated to exploring and experimenting with various CBX techniques and methodologies. It is built upon the CBXpy.

Table of Contents

• Introduction
• Installation
• Usage
• Contributing
• License

Introduction

This repository contains a collection of experiments and research related to CBX. The goal is to provide insights and results that can help in understanding and improving CBX techniques.

Installation

To get started with this project, clone the repository and install the necessary dependencies. For this use poetry

git clone https://github.com/phierhager/cbx-experiments.git
cd cbx-experiments
poetry install
poetry shell

Usage

Detailed instructions on how to run the experiments and use the code can be found in the documentation directory in the workflow Jupyter notebook. To run experiments with the command line use:

python run_experiment.py --config configs/experiment1.yaml

Contributing

We welcome contributions from the community. If you would like to contribute, please follow these steps:

1. Fork the repository.
2. Create a new branch for your feature or bugfix.
3. Commit your changes and push the branch to your fork.
4. Create a pull request with a detailed description of your changes.

License

This project is licensed under the Apache License. See the LICENSE file for more details.