Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add README for examples folder #1860

Merged
merged 5 commits into from
Oct 6, 2023
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
40 changes: 40 additions & 0 deletions examples/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
# ZenML Use Cases

This folder contains examples of ZenML pipelines. These are more involved use
cases with production-ready pipelines, with the exception of
some that will be indicated in the table below.

These core demonstrations of ZenML showcase the power of the framework in real
scenarios that use cloud infrastructure or other cloud components.
Explanations for how to use and run the use cases can be found in the README
associated with each sub-folder.

{% hint style="info" %}
This directory previously contained examples of ZenML integrations and how to
use them. These have been ingested into the core library as integration tests.
It is therefore still possible to view the code at
[`/tests/integration/examples`](https://github.com/zenml-io/zenml/tree/main/tests/integration/examples)
but for explanations on how to use them, please refer to our dedicated [Component
guide](https://docs.zenml.io/stacks-and-components/component-guide) in our
documentation which has been updated with all the latest information.
{% endhint %}

Note that our full use cases are all implemented as templates so you can start
with our code and then adapt the specifics to your individual needs. To learn
more about how to do this, please [visit our dedicated documentation
page](https://docs.zenml.io/user-guide/starter-guide/using-project-templates) on
this.

| Name | Description | Integrations | Core Project |
| ---- | ----------- | ------------ | ------------ |
| quickstart | This is our quickstart example showcasing basic functionality and a workflow to get you started with the ZenML framework | mlflow | ✅ |
| e2e | Trains one or more scikit-learn classification models to make predictions on tabular classification datasets | scikit-learn | ✅ |
| generative_chat | LEGACY: constructs a vector store to be used by a LLM-based chatbot based on documentation and data from a variety of sources | langchain, llama-index, slack | |
| label_studio_annotation | LEGACY: shows how to use the Label Studio integration for annotation in a computer-vision use case and series of pipelines | label_studio, pillow | |
| label_studio_text_annotation | LEGACY: shows how to use the Label Studio integration in a NLP / text-based use case and series of pipelines | label_studio | |
Comment on lines +32 to +34
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actually, why do we even mention these?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Because the README should guide people as to what's in the folder. When we remove those LEGACY ones I'd say we can update the README to reflect that, but it's more confusing to just not mention them at all..


## ❓ Questions / Further Assistance

If you have any questions about how to get going with these use cases, or if
you're wondering how you can adapt them to your particular needs, please do
[reach out to us on Slack](https://zenml.io/slack-invite/)!