Skip to content

Commit a8302f7

Browse files
committed
Update pipelines_overview.md
1 parent 8e6d4b6 commit a8302f7

File tree

1 file changed

+4
-2
lines changed

1 file changed

+4
-2
lines changed

docs/source/pipelines/pipelines_overview.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ CodeFlare Pipelines reimagined pipelines to provide a more intuitive API for the
2424

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

27-
Examples are provided as executable [notebooks](https://github.com/project-codeflare/codeflare/tree/main/notebooks).
27+
A set of reference examples are provided as executable [notebooks](https://github.com/project-codeflare/codeflare/tree/main/notebooks).
2828

2929
To run examples, if you haven't done so yet, clone the CodeFlare project with:
3030

@@ -46,4 +46,6 @@ The step above should automatically open a browser window and connect to a runni
4646

4747
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.
4848

49-
As a first example, we recommend the [sample pipeline](https://github.com/project-codeflare/codeflare/blob/main/notebooks/sample_pipeline.ipynb).
49+
As a first example of the API usage, see the [sample pipeline](https://github.com/project-codeflare/codeflare/blob/main/notebooks/sample_pipeline.ipynb).
50+
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.

0 commit comments

Comments
 (0)