Skip to content

Commit 4a81562

Browse files
committed
Updated CodeFlare Pipelines description.
1 parent a8302f7 commit 4a81562

File tree

2 files changed

+5
-6
lines changed

2 files changed

+5
-6
lines changed

README.md

+3-4
Original file line numberDiff line numberDiff line change
@@ -119,9 +119,8 @@ Click on the link below to try CodeFlare, on a sandbox environment, without havi
119119
<img src="./images/pipelines.svg" width="296" height="180">
120120
</p>
121121

122-
## CodeFlare Pipelines
123122

124-
CodeFlare Pipelines reimagined pipelines to provide a more intuitive API for the data scientist to create AI/ML pipelines, data workflows, pre-processing, post-processing tasks, and many more which can scale from a laptop to a cluster seamlessly.
123+
**CodeFlare Pipelines** reimagined pipelines to provide a more intuitive API for the data scientist to create AI/ML pipelines, data workflows, pre-processing, post-processing tasks, and many more which can scale from a laptop to a cluster seamlessly.
125124

126125
See the API documentation [here](https://codeflare.readthedocs.io/en/latest/codeflare.pipelines.html), and reference use case documentation in the Examples section.
127126

@@ -145,11 +144,11 @@ jupyter-lab codeflare/notebooks/<example_notebook>
145144

146145
The step above should automatically open a browser window and connect to a running Jupyter server.
147146

148-
If you are using any one of the recommended cloud based deployments, examples are found in the `codeflare/notebooks` directory in the container image. The examples can be executed directly from the Jupyter environment.
147+
If you are using any one of the recommended cloud based deployments (see below), examples are found in the `codeflare/notebooks` directory in the container image. The examples can be executed directly from the Jupyter environment.
149148

150149
As a first example of the API usage, see the [sample pipeline](https://github.com/project-codeflare/codeflare/blob/main/notebooks/sample_pipeline.ipynb).
151150

152-
For an example of how CodeFlare Pipelines can be used to scale out and speed up common machine learning problems, see the [grid search](https://github.com/project-codeflare/codeflare/blob/develop/notebooks/Grid%20Search%20Sample.ipynb) example. It shows how hyperparameter optimization for a reference pipeline can be scaled with both task and data parallelism.
151+
For an example of how CodeFlare Pipelines can be used to scale out common machine learning problems, see the [grid search](https://github.com/project-codeflare/codeflare/blob/develop/notebooks/Grid%20Search%20Sample.ipynb) example. It shows how hyperparameter optimization for a reference pipeline can be scaled and accelerated with both task and data parallelism.
153152

154153
## Deploy and integrate anywhere
155154

docs/source/pipelines/pipelines_overview.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -44,8 +44,8 @@ jupyter-lab codeflare/notebooks/<example_notebook>
4444

4545
The step above should automatically open a browser window and connect to a running Jupyter server.
4646

47-
If you are using any one of the recommended cloud based deployments, examples are found in the `codeflare/notebooks` directory in the container image. The examples can be executed directly from the Jupyter environment.
47+
If you are using any one of the recommended cloud based deployments (see below), examples are found in the `codeflare/notebooks` directory in the container image. The examples can be executed directly from the Jupyter environment.
4848

4949
As a first example of the API usage, see the [sample pipeline](https://github.com/project-codeflare/codeflare/blob/main/notebooks/sample_pipeline.ipynb).
5050

51-
For an example of how CodeFlare Pipelines can be used to scale out and speed up common machine learning problems, see the [grid search](https://github.com/project-codeflare/codeflare/blob/develop/notebooks/Grid%20Search%20Sample.ipynb) example. It shows how hyperparameter optimization for a reference pipeline can be scaled with both task and data parallelism.
51+
For an example of how CodeFlare Pipelines can be used to scale out common machine learning problems, see the [grid search](https://github.com/project-codeflare/codeflare/blob/develop/notebooks/Grid%20Search%20Sample.ipynb) example. It shows how hyperparameter optimization for a reference pipeline can be scaled and accelerated with both task and data parallelism.

0 commit comments

Comments
 (0)