Installation

Install from source:

git clone https://github.com/bojai-org/bojai.git
cd bojai
pip install .

Getting Started

You can use BojAI in two main ways:

1. Use a Built-In Model

Start a full ML pipeline from UI or CLI without writing any code:

1. Run bojai list --pipelines to see what pipelines are available. To learn more about each pipeline, visit its page on our docs site.

2. Run bojai build --pipeline chosen-pipeline-name

3. Run bojai start --pipeline built-pipeline-name to use the pipeline in CLI mode, or bojai start --pipeline built-pipeline-name --ui to use it in UI mode.

2. Create Your Own Custom Model or Pipeline

1. Run bojai create --pipeline give-your-pipeline-a-name --directory where/you/want/to/save to copy files into a folder and save it in the specified directory.

2. This folder contains files where you can implement your data processing logic, model, training and eval loop, and usage logic. Click here for detailed steps.

3. Run bojai build --pipeline give-your-pipeline-a-name --directory path/to/directory/with/implementation

4. Run bojai start --pipeline built-pipeline-name to use the pipeline in CLI mode, or bojai start --pipeline built-pipeline-name --ui to use it in UI mode.