Skip to content

Commit 8e6d4b6

Browse files
committed
Update README.md
1 parent 179c30f commit 8e6d4b6

File tree

1 file changed

+11
-3
lines changed

1 file changed

+11
-3
lines changed

README.md

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -125,7 +125,7 @@ CodeFlare Pipelines reimagined pipelines to provide a more intuitive API for the
125125

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

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

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

@@ -147,7 +147,9 @@ The step above should automatically open a browser window and connect to a runni
147147

148148
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.
149149

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

152154
## Deploy and integrate anywhere
153155

@@ -156,10 +158,16 @@ Unleash the power of pipelines by seamlessly scaling on the cloud. CodeFlare can
156158
- [IBM Cloud Code Engine](./deploy/ibm_cloud_code_engine) for detailed instructions on how to run CodeFlare on a serverless platform.
157159
- [Red Hat OpenShift](./deploy/redhat_openshift) for detailed instructions on how to run CodeFlare on OpenShift Container Platform.
158160

161+
162+
159163
## Contributing
160164

161165
Join us in making CodeFlare Better! We encourage you to take a look at our [Contributing](CONTRIBUTING.md) page.
162166

163167
## Blog
164168

165-
CodeFlare related blogs are published on our [Medium publication](https://medium.com/codeflare)
169+
CodeFlare related blogs are published on our [Medium publication](https://medium.com/codeflare).
170+
171+
## License
172+
173+
CodeFlare is an open-source project with an [Apache 2.0 license](LICENSE).

0 commit comments

Comments
 (0)