-
Notifications
You must be signed in to change notification settings - Fork 461
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
Changes from all commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
db7c91f
draft README file
strickvl 5b6f8b7
update with templates info
strickvl 86c5ed5
updated following PR comments
strickvl c5e9e34
Merge branch 'develop' into doc/OSS-2414-readme-for-examples-folder
strickvl 5f781c3
reorder table
strickvl File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 | | | ||
|
||
## ❓ 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/)! |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
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?
There was a problem hiding this comment.
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..