<!-- {% comment %} Copyright 2021, 2022, 2023 IBM Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. {% endcomment %} --> <p align="center"> <img src="./images/codeflare_square.svg" width="200" height="200"> </p> <!-- <p align="center"> <img src="./images/pipelines.svg" width="340" height="207"> </p> -->

<!-- >> **⚠ UPDATE** > CodeFlare is evolving! Check our [updates](https://github.com/project-codeflare/codeflare#pipeline-execution-and-scaling) for CodeFlare Pipelines and related contributions to Ray Workflows under Ray project. -->

Simplified and efficient AI/ML on the hybrid cloud

CodeFlare provides a simple, user-friendly abstraction for developing, scaling, and managing resources for distributed AI/ML on the Hybrid Cloud platform with OpenShift Container Platform.

---

📦 Stack Components and Features

CodeFlare stack consists of the following main components. This project is organized as a metarepo, gathering pointers and artifacts to deploy and use the stack.

• Simplified user experience: CodeFlare SDK and CLI to define, develop, and control remote distributed compute jobs and infrastructure from either a python-based environment or command-line interface

• Efficient resource management: Multi-Cluster Application Dispatcher (MCAD) for queueing, resource quotas, and management of batch jobs. And Instascale for on-demand resource scaling of an OpenShift cluster

• Automated and streamlined deployment: CodeFlare Operator for automating deployment and configuration of the Project CodeFlare stack

With CodeFlare stack, users automate and simplify the execution and scaling of the steps in the life cycle of model development, from data pre-processing, distributed model training, model adaptation and validation.

Through transparent integration with Ray and PyTorch frameworks, and the rich library ecosystem that run on them, CodeFlare enables data scientists to spend more time on model development and minimum time on resource deployment and scaling.

See below our stack and how to get started.

---

⚙️ Project CodeFlare Ecosystem

In addition to running standalone, Project CodeFlare is deployed as part of and integrated with the Open Data Hub, leveraging OpenShift Container Platform.

With OpenShift, CodeFlare can be deployed anywhere, from on-prem to cloud, and integrate easily with other cloud-native ecosystems.

<p align="center"> <img src="./images/codeflare_stack.svg" width="506" height="520"> </p>

---

🛠️ Getting Started

Learning

Watch this video for an introduction to Project CodeFlare and what the stack can do.

Quick Start

To get started using the Project CodeFlare stack, try this end-to-end example!

For more basic walk-throughs and in-depth tutorials, see our demo notebooks!

Development

See more details in any of the component repos linked above, or get started by taking a look at the project board for open tasks/issues!

Architecture

We attempt to document all architectural decisions in our ADR documents. Start here to understand the architectural details of Project CodeFlare.

---

🎉 Getting Involved and Contributing

Join our Slack community to get involved or ask questions.

Blog

CodeFlare related blogs are published on our Medium publication.

License

CodeFlare is an open-source project with an Apache 2.0 license.