From 7973e62933fb24db80a43c9eab6c64400840365b Mon Sep 17 00:00:00 2001 From: Hamza Tahir Date: Wed, 12 Feb 2025 20:49:38 +0100 Subject: [PATCH 1/3] Add some sdkdocs links --- docs/book/user-guide/production-guide/understand-stacks.md | 4 ++++ docs/book/user-guide/starter-guide/create-an-ml-pipeline.md | 4 ++++ 2 files changed, 8 insertions(+) diff --git a/docs/book/user-guide/production-guide/understand-stacks.md b/docs/book/user-guide/production-guide/understand-stacks.md index 6b18ea2513c..dd95ffa5895 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/create-an-ml-pipeline.md b/docs/book/user-guide/starter-guide/create-an-ml-pipeline.md index 254d645b6f3..ea03053a9d2 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: From cdc77dc55b95c140d755607a4e0b2216dd241b25 Mon Sep 17 00:00:00 2001 From: Hamza Tahir Date: Thu, 13 Feb 2025 20:04:10 +0100 Subject: [PATCH 2/3] Add some more --- docs/book/user-guide/production-guide/README.md | 4 ++++ docs/book/user-guide/starter-guide/README.md | 4 ++++ 2 files changed, 8 insertions(+) diff --git a/docs/book/user-guide/production-guide/README.md b/docs/book/user-guide/production-guide/README.md index 2f751cbbe3b..d756a94871f 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/starter-guide/README.md b/docs/book/user-guide/starter-guide/README.md index 5baac6431ee..0aaf3441a4a 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
From 2656691d7869a6be9e960c31d106f21c3147772e Mon Sep 17 00:00:00 2001 From: Hamza Tahir Date: Thu, 13 Feb 2025 23:07:59 +0100 Subject: [PATCH 3/3] README --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index bd91ff63dbd..489257a41ce 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.