Skip to content

Commit da55d86

Browse files
committed
Updated documentation.
1 parent 2f049e3 commit da55d86

File tree

2 files changed

+29
-38
lines changed

2 files changed

+29
-38
lines changed

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ This project is under active development. See the [Documentation](https://codefl
4545

4646
### Run in your laptop
4747

48-
#### Instaling locally
48+
#### Installing locally
4949

5050
CodeFlare can be installed from PyPI.
5151

@@ -132,4 +132,4 @@ Unleash the power of pipelines by seamlessly scaling on the cloud. CodeFlare can
132132

133133
## Contributing
134134

135-
If you are interested in joining us and make CodeFlare better, we encourage you to take a look at our [Contributing](CONTRIBUTING.md) page.
135+
Join us making CodeFlare Better! We encourage you to take a look at our [Contributing](CONTRIBUTING.md) page.

docs/source/getting_started/installation.md

Lines changed: 27 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,32 @@ limitations under the License.
2020

2121
### Run in your laptop
2222

23+
#### Instaling locally
24+
25+
CodeFlare can be installed from PyPI.
26+
27+
Prerequisites:
28+
* [Python 3.8+](https://www.python.org/downloads/)
29+
* [Jupyter Lab](https://www.python.org/downloads/) *(to run examples)*
30+
31+
We recommend installing Python 3.8.7 using
32+
[pyenv](https://github.com/pyenv/pyenv).
33+
34+
35+
Install from PyPI:
36+
```bash
37+
pip3 install --upgrade codeflare
38+
```
39+
40+
41+
Alternatively, you can also build locally with:
42+
```shell
43+
git clone https://github.com/project-codeflare/codeflare.git
44+
pip3 install --upgrade pip
45+
pip3 install .
46+
pip3 install -r requirements.txt
47+
```
48+
2349
#### Using Docker
2450

2551
You can try CodeFlare by running the docker image from [Docker Hub](https://hub.docker.com/r/projectcodeflare/codeflare/tags):
@@ -41,45 +67,10 @@ It should produce an output similar to the one below, where you can then find th
4167
or http://127.0.0.1:8888/?token=<token>
4268
```
4369

44-
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 `sample_pipeline.ipynb` notebook.
45-
4670
#### Using Binder service
4771

4872
You can try out some of CodeFlare features using the My Binder service.
4973

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

52-
[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/project-codeflare/codeflare.git/main)
53-
54-
#### Instaling locally
55-
56-
CodeFlare can be installed from PyPI.
57-
58-
Prerequisites:
59-
* [Python 3.8+](https://www.python.org/downloads/)
60-
* [Jupyter Lab](https://www.python.org/downloads/) *(to run examples)*
61-
62-
We recommend installing Python 3.8.7 using
63-
[pyenv](https://github.com/pyenv/pyenv).
64-
65-
66-
Install from PyPI:
67-
```bash
68-
pip3 install --upgrade codeflare
69-
```
70-
71-
72-
Alternatively, you can also build locally with:
73-
```shell
74-
git clone https://github.com/project-codeflare/codeflare.git
75-
pip3 install --upgrade pip
76-
pip3 install .
77-
pip3 install -r requirements.txt
78-
```
79-
80-
Run the sample pipelines with:
81-
```shell
82-
jupyter-lab notebooks/<example_notebook>
83-
```
84-
85-
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.
76+
[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/project-codeflare/codeflare.git/main)

0 commit comments

Comments
 (0)