Skip to content

Commit d3679a8

Browse files
committed
Updated README.
1 parent c0c75cb commit d3679a8

File tree

3 files changed

+837
-1221
lines changed

3 files changed

+837
-1221
lines changed

README.md

Lines changed: 26 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -34,33 +34,46 @@ Status](https://travis-ci.com/project-codeflare/codeflare.svg?branch=main)](http
3434
[![Documentation Status](https://readthedocs.org/projects/codeflare/badge/?version=latest)](https://codeflare.readthedocs.io/en/latest/?badge=latest)
3535
[![GitHub](https://img.shields.io/badge/issue_tracking-github-blue.svg)](https://github.com/project-codeflare/codeflare/issues)
3636

37-
> **⚠ UPDATE**
38-
> 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.
37+
<!-- >> **⚠ UPDATE**
38+
> 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. -->
3939

4040
# Scale complex AI/ML pipelines anywhere
4141

4242
CodeFlare is a framework to simplify the integration, scaling and acceleration of complex multi-step analytics and machine learning pipelines on the cloud.
4343

4444
Its main features are:
4545

46+
* **Simplified User Experience**:
47+
Interactive and rich command line interface and live dashboards enabling automation to deploy, run and monitor end-to-end pipelines, significantly minimizing the effort and skills needed to scale AI and ML workflows.
48+
4649
* **Pipeline execution and scaling**:
47-
CodeFlare Pipelines faciltates the definition and parallel execution of pipelines. It unifies pipeline workflows across multiple frameworks while providing nearly optimal scale-out parallelism on pipelined computations.
50+
Built with Ray Workflows, CodeFlare Pipelines faciltates the definition and parallel execution of pipelines. It unifies pipeline workflows across multiple frameworks while providing nearly optimal scale-out parallelism on pipelined computations.
4851
<!--CodeFlare Pipelines facilities the definition and parallel execution of pipelines. It unifies pipeline workflows across multiple platforms such as [scikit-learn](https://scikit-learn.org/) and [Apache Spark](https://spark.apache.org/), while providing nearly optimal scale-out parallelism on pipelined computations.-->
4952

5053
* **Deploy and integrate anywhere**:
5154
CodeFlare simplifies deployment and integration by enabling a serverless user experience with the integration with Red Hat OpenShift and IBM Cloud Code Engine and providing adapters and connectors to make it simple to load data and connect to data services.
5255

5356
<p align="center">
54-
<img src="./images/codeflare_arch_diagram.svg" width="876" height="476">
57+
<img src="./images/codeflare_arch_diagram.svg" width="880" height="640">
5558
</p>
5659

57-
## Release status
60+
<!-- ## Release status
5861
5962
This project is under active development. See the [Documentation](https://codeflare.readthedocs.io/en/latest/index.html) for design descriptions and the latest version of the APIs.
63+
-->
6064

65+
---
6166
## Quick start
6267

63-
### Run in your laptop
68+
### Run on your laptop
69+
70+
### Installing CodeFlare client
71+
72+
See instructions [here](https://github.com/project-codeflare/codeflare-cli) for installing CodeFlare CLI and Dashboard.
73+
74+
<p align="center">
75+
<img src="./images/codeflare_cli.svg" width="150" height="150">
76+
</p>
6477

6578
#### Instaling locally
6679

@@ -74,7 +87,6 @@ We recommend installing Python 3.8.6 using
7487
[pyenv](https://github.com/pyenv/pyenv). You can find [here](https://codeflare.readthedocs.io/en/latest/getting_started/setting_python_env.html) recommended steps to set up the Python environment.
7588

7689

77-
7890
Install from PyPI:
7991
```bash
8092
pip3 install --upgrade pip # CodeFlare requires pip >21.0
@@ -89,6 +101,7 @@ pip3 install --upgrade pip
89101
pip3 install .
90102
```
91103

104+
<!--
92105
#### Using Docker
93106
94107
You can try CodeFlare by running the docker image from [Docker Hub](https://hub.docker.com/r/projectcodeflare/codeflare/tags):
@@ -107,15 +120,18 @@ It should produce an output similar to the one below, where you can then find th
107120
...
108121
[I <time_stamp> ServerApp] http://127.0.0.1:8888/lab
109122
```
123+
-->
110124

111-
#### Using Binder service
125+
<!-- #### Using Binder service
112126
113127
You can try out some of CodeFlare features using the My Binder service.
114128
115129
Click on the link below to try CodeFlare, on a sandbox environment, without having to install anything.
116130
117131
[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/project-codeflare/codeflare.git/develop)
132+
-->
118133

134+
---
119135

120136
## Pipeline execution and scaling
121137

@@ -158,12 +174,9 @@ For an example of how CodeFlare Pipelines can be used to scale out common machin
158174

159175
## Deploy and integrate anywhere
160176

161-
Unleash the power of pipelines by seamlessly scaling on the cloud. CodeFlare can be deployed on any Kubernetes-based platform, including [IBM Cloud Code Engine](https://www.ibm.com/cloud/code-engine) and [Red Hat OpenShift Container Platform](https://www.openshift.com).
162-
163-
- [IBM Cloud Code Engine](./deploy/ibm_cloud_code_engine) for detailed instructions on how to run CodeFlare on a serverless platform.
164-
- [Red Hat OpenShift](./deploy/redhat_openshift) for detailed instructions on how to run CodeFlare on OpenShift Container Platform.
165-
177+
CodeFlare is built on [Red Hat OpenShift Container Platform](https://www.openshift.com) and can be deployed anywhere, from on-prem to cloud, and integrate easily with other cloud-native ecosystems.
166178

179+
See [Running with Red Hat OpenShift](./deploy/redhat_openshift) for detailed instructions on how to run CodeFlare on OpenShift Container Platform.
167180

168181
## Contributing
169182

0 commit comments

Comments
 (0)