diff --git a/README.md b/README.md index bd91ff63db..489257a41c 100644 --- a/README.md +++ b/README.md @@ -75,6 +75,8 @@ --- +Need help with documentation? Visit our [docs site](https://docs.zenml.io) for comprehensive guides and tutorials, or browse the [SDK reference](https://sdkdocs.zenml.io/) to find specific functions and classes. + ## ⭐️ Show Your Support If you find ZenML helpful or interesting, please consider giving us a star on GitHub. Your support helps promote the project and lets others know that it's worth checking out. diff --git a/docs/book/user-guide/production-guide/README.md b/docs/book/user-guide/production-guide/README.md index 2f751cbbe3..d756a94871 100644 --- a/docs/book/user-guide/production-guide/README.md +++ b/docs/book/user-guide/production-guide/README.md @@ -22,4 +22,8 @@ Like in the starter guide, make sure you have a Python environment ready and `vi By the end, you will have completed an [end-to-end](end-to-end.md) MLOps project that you can use as inspiration for your own work. Let's get right into it! +{% hint style="info" %} +Throughout this guide, we will be referencing internal ZenML functions and classes, which are more easily discoverable in the [SDK Docs](https://sdkdocs.zenml.io/). Consult the SDK docs if you're ever stuck! +{% endhint %} +
ZenML Scarf
diff --git a/docs/book/user-guide/production-guide/understand-stacks.md b/docs/book/user-guide/production-guide/understand-stacks.md index 6b18ea2513..dd95ffa589 100644 --- a/docs/book/user-guide/production-guide/understand-stacks.md +++ b/docs/book/user-guide/production-guide/understand-stacks.md @@ -221,4 +221,8 @@ To run a pipeline using the new stack: Keep this code handy as we'll be using it in the next chapters! +{% hint style="info" %} +If you ever want to learn more about individual ZenML functions or classes, check out the [SDK Docs](https://sdkdocs.zenml.io/) +{% endhint %} +
ZenML Scarf
diff --git a/docs/book/user-guide/starter-guide/README.md b/docs/book/user-guide/starter-guide/README.md index 5baac6431e..0aaf3441a4 100644 --- a/docs/book/user-guide/starter-guide/README.md +++ b/docs/book/user-guide/starter-guide/README.md @@ -20,4 +20,8 @@ Before jumping in, make sure you have a Python environment ready and `virtualenv Let this guide be not only your introduction to ZenML but also a foundational asset in your MLOps toolkit. Prepare your development environment, and let's get started! +{% hint style="info" %} +Throughout this guide, we will be referencing internal ZenML functions and classes, which are more easily discoverable in the [SDK Docs](https://sdkdocs.zenml.io/). Consult the SDK docs if you're ever stuck! +{% endhint %} +
ZenML Scarf
diff --git a/docs/book/user-guide/starter-guide/create-an-ml-pipeline.md b/docs/book/user-guide/starter-guide/create-an-ml-pipeline.md index 254d645b6f..ea03053a9d 100644 --- a/docs/book/user-guide/starter-guide/create-an-ml-pipeline.md +++ b/docs/book/user-guide/starter-guide/create-an-ml-pipeline.md @@ -273,6 +273,10 @@ training_pipeline.write_run_configuration_template(path='/local/path/to/config.y Check out [this section](../../how-to/pipeline-development/use-configuration-files/README.md) for advanced configuration options. +{% hint style="info" %} +If you ever want to learn more about individual ZenML functions or classes, check out the [SDK Docs](https://sdkdocs.zenml.io/) +{% endhint %} + ## Full Code Example This section combines all the code from this section into one simple script that you can use to run easily: