Skip to content

Commit

Permalink
added a paragraph linking it to our production guide (#30)
Browse files Browse the repository at this point in the history
  • Loading branch information
bcdurak authored Jan 16, 2024
1 parent 153a51b commit dc46e27
Showing 1 changed file with 12 additions and 2 deletions.
14 changes: 12 additions & 2 deletions template/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,16 @@ Settings of your project are:
- All notifications disabled
{%- endif %}

> [!NOTE]
> If you are coming from [our production guide](https://docs.zenml.io/user-guide/production-guide),
> you can apply the same principles that you have seen in the guide to this project.
> You can [connect it to remote storage](https://docs.zenml.io/user-guide/production-guide/remote-storage),
> [run it with a cloud orchestrator](https://docs.zenml.io/user-guide/production-guide/cloud-orchestration),
> [attach a git repository to it](https://docs.zenml.io/user-guide/production-guide/connect-code-repository),
> and much more. If you are looking to try these steps with a simpler example,
> feel free to take a look at [our starter template](https://github.com/zenml-io/template-starter)
> as well.
## 👋 Introduction

Welcome to your newly generated "{{project_name}}" project! This is
Expand All @@ -49,7 +59,7 @@ The project contains a collection of standard and custom ZenML steps,
pipelines and other artifacts and useful resources that can serve as a
solid starting point for your smooth journey with ZenML.

What to do first? You can start by giving the the project a quick run. The
What to do first? You can start by giving the project a quick run. The
project is ready to be used and can run as-is without any further code
changes! You can try it right away by installing ZenML, the needed
ZenML integration and then calling the CLI included in the project. We also
Expand Down Expand Up @@ -85,7 +95,7 @@ python run.py --help
for your generated project. For example, you could disable hyperparameters
tuning and use your favorite model architecture or promote every trained model,
if you haven't already!
* take a look at [the project structure](#📜-project-structure) and the code
* take a look at [the project structure](#-project-structure) and the code
itself. The code is heavily commented and should be easy to follow.
* read the [ZenML documentation](https://docs.zenml.io) to learn more about
various ZenML concepts referenced in the code and to get a better sense of
Expand Down

0 comments on commit dc46e27

Please sign in to comment.