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.

Sign up for GitHub

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 chapter names #212

Merged
merged 2 commits into from
Dec 6, 2021
Merged

Add chapter names #212

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5c58aae
remove extra space
strickvl Dec 6, 2021
3ff96d7
update chapter names
strickvl Dec 6, 2021
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
2 changes: 1 addition & 1 deletion docs/book/guides/low-level-api/chapter-1.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
description: Create your first step.
description: Create your first step.
---

If you want to see the code for this chapter of the guide, head over to the [GitHub](https://github.com/zenml-io/zenml/tree/main/examples/low_level_guide/chapter_1.py).
Expand Down
2 changes: 1 addition & 1 deletion docs/book/guides/low-level-api/chapter-2.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ description: Add some normalization

If you want to see the code for this chapter of the guide, head over to the [GitHub](https://github.com/zenml-io/zenml/tree/main/examples/low_level_guide/chapter_2.py).

# Normalize the data.
# Normalize the data

Now before writing any trainers we can actually normalize our data to make sure we get better results. To do this let's add another step and make the pipeline a bit more complex.

Expand Down
2 changes: 1 addition & 1 deletion docs/book/guides/low-level-api/chapter-3.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ description: Train some models.

If you want to see the code for this chapter of the guide, head over to the [GitHub](https://github.com/zenml-io/zenml/tree/main/examples/low_level_guide/chapter_3.py).

# Train and evaluate the model.
# Train and evaluate the model

Finally we can train and evaluate our model.

Expand Down
6 changes: 4 additions & 2 deletions docs/book/guides/low-level-api/chapter-4.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,11 @@ description: Leverage caching.

If you want to see the code for this chapter of the guide, head over to the [GitHub](https://github.com/zenml-io/zenml/tree/main/examples/low_level_guide/chapter_4.py).

# Swap out implementations of individual steps and see caching in action
# Caching in action

What if we don't want to use TensorFlow but rather a [scikit-learn](https://scikit-learn.org/) model? This is easy to do.
What if we don't want to use TensorFlow but rather a
[scikit-learn](https://scikit-learn.org/) model? This is easy to do. Swap out
implementations of individual steps and see caching save you time and money!

## Create steps

Expand Down
2 changes: 1 addition & 1 deletion docs/book/guides/low-level-api/chapter-5.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ description: Materialize artifacts as you want.

If you want to see the code for this chapter of the guide, head over to the [GitHub](https://github.com/zenml-io/zenml/tree/main/examples/low_level_guide/chapter_5.py).

# Materialize artifacts the way you want to consume them.
# Materialize artifacts the way you want to consume them

At this point, the precise way that data passes between the steps has been a bit of a mystery to us. There is, of course, a mechanism to serialize and deserialize stuff flowing between steps. We can now take control of this mechanism if we require further control.

Expand Down
16 changes: 8 additions & 8 deletions docs/book/toc.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,15 +10,15 @@
## Guides

* [Low Level API](guides/low-level-api/README.md)
* [Chapter 1](guides/low-level-api/chapter-1.md)
* [Chapter 2](guides/low-level-api/chapter-2.md)
* [Chapter 3](guides/low-level-api/chapter-3.md)
* [Chapter 4](guides/low-level-api/chapter-4.md)
* [Chapter 5](guides/low-level-api/chapter-5.md)
* [Chapter 6](guides/low-level-api/chapter-6.md)
* [Chapter 7](guides/low-level-api/chapter-7.md)
* [Create a step](guides/low-level-api/chapter-1.md)
* [Normalize data](guides/low-level-api/chapter-2.md)
* [Train & Evaluate](guides/low-level-api/chapter-3.md)
* [Caching](guides/low-level-api/chapter-4.md)
* [Materialize artifacts](guides/low-level-api/chapter-5.md)
* [Import dynamic data](guides/low-level-api/chapter-6.md)
* [Deploy to production](guides/low-level-api/chapter-7.md)
* [High Level API](guides/high-level-api/README.md)
* [Chapter 1](guides/high-level-api/chapter-1.md)
* [Coming Soon](guides/high-level-api/chapter-1.md)
* [Post Execution Workflow](guides/post-execution-workflow.md)
* [Pipeline Configuration](guides/pipeline-configuration.md)
* [Deploy Pipelines to Production](guides/deploy\_to\_production.md)
Expand Down