Skip to content

Commit cadca02

Browse files
committed
Update README.md
1 parent 716e561 commit cadca02

File tree

1 file changed

+7
-10
lines changed

1 file changed

+7
-10
lines changed

README.md

Lines changed: 7 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -39,13 +39,11 @@ CodeFlare simplifies deployment and integration by enabling a serverless user ex
3939

4040
This project is under active development. See the [design document](https://docs.google.com/document/d/1t1K8N07TcbBKBgrcI6jf9tPow00cOKE9whnEVxOd4-U/edit) for more information on our design goals.
4141

42-
<p>&nbsp;</p>
42+
## Quick start
4343

44-
# Quick start
44+
### Run in your laptop
4545

46-
## Run in your laptop
47-
48-
### Using Docker
46+
#### Using Docker
4947

5048
You can try CodeFlare by running the docker images from [Docker Hub](https://hub.docker.com/r/projectcodeflare/codeflare/tags):
5149
- `projectcodeflare/codeflare:latest` has the latest released version installed.
@@ -68,16 +66,15 @@ It should produce an output similar to that below, where you can then find the U
6866

6967
Once the notebook is loaded, you can find a selection of examples in `codeflare/notebooks`, which can be executed directly from Jupyter environment. As a first example, we recommend the ` codeflare//notebooks/sample_pipeline.ipynb`.
7068

71-
### Using Binder service
69+
#### Using Binder service
7270

7371
You can try out some of CodeFlare features using the My Binder service.
7472

7573
Click on a link below to try CodeFlare, on a sandbox environment, without having to install anything.
7674

7775
[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/project-codeflare/codeflare.git/master)
7876

79-
80-
### Instaling locally
77+
#### Instaling locally
8178

8279
CodeFlare can be installed from PyPI.
8380

@@ -110,13 +107,13 @@ jupyter-lab sample_pipeline.ipynb
110107

111108
The pipeline will use `ray.init()` to start a local Ray cluster. See [configuring Ray](https://docs.ray.io/en/master/configure.html) to ensure you are able to run a Ray cluster locally.
112109

113-
## Scale in the cloud
110+
### Scale in the cloud
114111

115112
Unleash the power of pipelines by seamlessly scaling on the cloud. CodeFlare can be deployed with IBM Cloud Code Engine.
116113

117114
Go to [CodeFlare on IBM Code Engine](./deploy/ibm_cloud_code_engine) for detailed instructions on how to run CodeFlare at scale.
118115

119116

120-
# Contributing
117+
## Contributing
121118

122119
If you are interested in joining us and make CodeFlare Pipeline better, we encourage you to take a look at our [Contributing](CONTRIBUTING.md) page.

0 commit comments

Comments
 (0)