You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+11-3Lines changed: 11 additions & 3 deletions
Original file line number
Diff line number
Diff line change
@@ -125,7 +125,7 @@ CodeFlare Pipelines reimagined pipelines to provide a more intuitive API for the
125
125
126
126
See the API documentation [here](https://codeflare.readthedocs.io/en/latest/codeflare.pipelines.html), and reference use case documentation in the Examples section.
127
127
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).
129
129
130
130
To run examples, if you haven't done so yet, clone the CodeFlare project with:
131
131
@@ -147,7 +147,9 @@ The step above should automatically open a browser window and connect to a runni
147
147
148
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.
149
149
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.
151
153
152
154
## Deploy and integrate anywhere
153
155
@@ -156,10 +158,16 @@ Unleash the power of pipelines by seamlessly scaling on the cloud. CodeFlare can
156
158
-[IBM Cloud Code Engine](./deploy/ibm_cloud_code_engine) for detailed instructions on how to run CodeFlare on a serverless platform.
157
159
-[Red Hat OpenShift](./deploy/redhat_openshift) for detailed instructions on how to run CodeFlare on OpenShift Container Platform.
158
160
161
+
162
+
159
163
## Contributing
160
164
161
165
Join us in making CodeFlare Better! We encourage you to take a look at our [Contributing](CONTRIBUTING.md) page.
162
166
163
167
## Blog
164
168
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