Skip to content

Commit 4a73302

Browse files
htahir1htahir1
committed
Add a quickstart to the docs
2 parents 182a15d + 0facb02 commit 4a73302

File tree

66 files changed

+1815
-16
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

66 files changed

+1815
-16
lines changed

‎.github/workflows/docs.yml‎

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
name: deploy-docs
2+
3+
on:
4+
# Trigger the workflow on push to main branch
5+
push:
6+
branches:
7+
- main
8+
9+
# This job installs dependencies, build the book, and pushes it to `gh-pages`
10+
jobs:
11+
build-and-deploy-book:
12+
runs-on: ${{ matrix.os }}
13+
strategy:
14+
matrix:
15+
os: [ubuntu-latest]
16+
python-version: [3.8]
17+
steps:
18+
- uses: actions/checkout@v2
19+
20+
# Install dependencies
21+
- name: Set up Python ${{ matrix.python-version }}
22+
uses: actions/setup-python@v1
23+
with:
24+
python-version: ${{ matrix.python-version }}
25+
- name: Install dependencies
26+
run: |
27+
pip install -r requirements.txt
28+
29+
# Build the book
30+
- name: Build the book
31+
run: |
32+
jupyter-book build docs/book
33+
34+
# Deploy the book's HTML to gh-pages branch
35+
- name: GitHub Pages action
36+
uses: peaceiris/[email protected]
37+
with:
38+
github_token: ${{ secrets.GITHUB_TOKEN }}
39+
publish_dir: docs/book/_build/html

‎.gitignore‎

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -140,6 +140,4 @@ local_test/
140140
.zenml/
141141
test.py
142142
!cloudbuild.yaml
143-
144-
# ZenML
145-
.zenml/
143+
docs/book/_build/

‎docs/CODE_GUIDLINES.md‎ renamed to ‎CODE_GUIDLINES.md‎

File renamed without changes.

‎README.md‎

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -16,13 +16,14 @@
1616
[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/zenml)](https://pypi.org/project/zenml/)
1717
[![PyPI Status](https://pepy.tech/badge/zenml)](https://pepy.tech/project/zenml)
1818
![GitHub](https://img.shields.io/github/license/maiot-io/zenml)
19-
20-
2119
</div>
2220

2321
---
2422

25-
<div align="center"><a href="https://www.producthunt.com/posts/zenml-1?utm_source=badge-featured&utm_medium=badge&utm_souce=badge-zenml-1" target="_blank"><img src="https://api.producthunt.com/widgets/embed-image/v1/featured.svg?post_id=279529&theme=light" alt="ZenML - Create reproducible machine learning pipelines | Product Hunt" style="width: 250px; height: 54px;" width="250" height="54" /></a>
23+
<div> Please join our
24+
<a href="https://zenml.io/slack-invite" target="_blank">
25+
<img width="25" src="https://cdn3.iconfinder.com/data/icons/logos-and-brands-adobe/512/306_Slack-512.png" alt="Slack"/>
26+
<b>Slack Community</b> </a> to be the first to get involved in the ZenML community
2627
</div>
2728

2829
---

‎docs/README.md‎

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
# ZenML Docs
2+
3+
ZenML is an extensible, open-source MLOps framework for using production-ready Machine Learning pipelines - in a simple way.
4+
5+
## Usage
6+
7+
### Building the docs
8+
9+
If you'd like to develop on and build the ZenML Docs, you should:
10+
11+
- Clone this repository and run
12+
- Run `pip install -r requirements.txt` (it is recommended you do this within a virtual environment)
13+
- `cd docs`
14+
- (Recommended) Remove the existing `book/_build/` directory
15+
- Run `jupyter-book build book/`
16+
17+
A fully-rendered HTML version of the docs will be built in `book/_build/html/`.
18+
19+
### Hosting the book
20+
21+
The html version of the docs is hosted on the `gh-pages` branch of this repo. A GitHub actions workflow has been created that automatically builds and pushes the book to this branch on a push or pull request to main.
22+
23+
If you wish to disable this automation, you may remove the GitHub actions workflow and build the book manually by:
24+
25+
- Navigating to your local build; and running,
26+
- `ghp-import -n -p -f book/_build/html`
27+
28+
This will automatically push your build to the `gh-pages` branch. More information on this hosting process can be found [here](https://book.org/publish/gh-pages.html#manually-host-your-book-with-github-pages).
29+
30+
## Contributors
31+
32+
We welcome and recognize all contributions. You can see a list of current contributors in the [contributors tab](https://github.com/maiot-io/zenml_docs/graphs/contributors).
33+
34+
## Credits
35+
36+
This project is created using the excellent open source [Jupyter Book project](https://book.org/) and the [executablebooks/cookiecutter-jupyter-book template](https://github.com/executablebooks/cookiecutter-jupyter-book).

‎docs/book/_config.yml‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
#######################################################################################
2+
# A default configuration that will be loaded for all jupyter books
3+
# See the documentation for help and more options:
4+
# https://jupyterbook.org/customize/config.html
5+
6+
#######################################################################################
7+
# Book settings
8+
title : ZenML Docs # The title of the book. Will be placed in the left navbar.
9+
author : maiot GmbH # The author of the book
10+
copyright : "2021" # Copyright year to be placed in the footer
11+
logo : logo.png # A path to the book logo
12+
repository:
13+
url: https://github.com/maiot-io/zenml
14+
path_to_book: docs/book
15+
branch: main
16+
execute:
17+
execute_notebooks : off # Whether to execute notebooks at build time. Must be one of ("auto", "force", "cache", "off")
18+
html:
19+
use_issues_button: true
20+
use_repository_button: true
21+
use_edit_page_button: true
22+
google_analytics_id: UA-103217419-2

‎docs/book/_toc.yml‎

Lines changed: 120 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,120 @@
1+
- file: intro
2+
title: Intro
3+
4+
- part: Getting Started
5+
chapters:
6+
- file: getting-started/core-concepts
7+
title: Core Concepts
8+
- file: getting-started/architectural-overview
9+
title: Architectural Overview
10+
- file: getting-started/quickstart
11+
title: Quickstart
12+
- file: getting-started/installation
13+
title: Installation
14+
15+
- part: Repository
16+
chapters:
17+
- file: repository/repository-singleton
18+
title: What is a ZenML Repository
19+
- file: repository/the-zenml-repository-instance
20+
title: The ZenML Repository Instance
21+
- file: repository/integration-with-git
22+
title: Integration with Git
23+
- file: repository/metadata-store
24+
title: Metadata Store
25+
- file: repository/artifact-store
26+
title: Artifact Store
27+
- file: repository/pipeline-directory
28+
title: Pipeline Directory
29+
30+
- part: Datasources
31+
chapters:
32+
- file: datasources/what-is-a-datasource
33+
title: What is a datasource
34+
- file: datasources/google-bigquery
35+
title: Google Bigquery
36+
- file: datasources/local-images
37+
title: Local Images
38+
- file: datasources/csv-files-locally
39+
title: CSV files [WIP]
40+
- file: datasources/create-your-own-datasource
41+
title: Create your own datasource
42+
43+
- part: Pipelines
44+
chapters:
45+
- file: pipelines/what-is-a-pipeline
46+
title: What is a pipeline?
47+
- file: pipelines/training-pipeline
48+
title: Training
49+
- file: pipelines/data
50+
title: Data [WIP]
51+
- file: pipelines/batch-inference
52+
title: Batch Inference [WIP]
53+
- file: pipelines/caching
54+
title: Caching
55+
56+
- part: Steps
57+
chapters:
58+
- file: steps/what-is-a-step
59+
title: What is a step?
60+
- file: steps/split
61+
title: Split
62+
- file: steps/preprocess
63+
title: Preprocess
64+
- file: steps/trainer
65+
title: Trainer
66+
- file: steps/evaluator
67+
title: Evaluator
68+
- file: steps/deployer
69+
title: Deployer
70+
- file: steps/custom_steps/custom-steps
71+
title: Custom Steps
72+
sections:
73+
- file: steps/custom_steps/custom-split
74+
title: Custom Split
75+
76+
- part: Backends
77+
chapters:
78+
- file: backends/what-is-a-backend
79+
title: What is a backend?
80+
- file: backends/orchestrator-backends
81+
title: Orchestrator Backends
82+
- file: backends/training-backends
83+
title: Training Backends
84+
- file: backends/processing-backends/processing-backends.md
85+
title: Processing Backends
86+
sections:
87+
- file: backends/processing-backends/google-dataflow-processing
88+
title: Google Dataflow
89+
90+
91+
- part: Tutorials
92+
chapters:
93+
- file: tutorials/quickstart.ipynb
94+
title: Quickstart
95+
- file: tutorials/running-a-pipeline-on-a-google-cloud-vm
96+
title: Running a training pipeline on a Google Cloud VM
97+
- file: tutorials/team-collaboration-with-zenml-and-google-cloud
98+
title: Team collaboration with ZenML and Google Cloud
99+
- file: tutorials/style-transfer-using-a-cyclegan-wip
100+
title: Style Transfer using a CycleGAN [WIP]
101+
- file: tutorials/building-a-classifier-on-33m-samples
102+
title: Classification with 59M samples [WIP]
103+
104+
- part: Misc
105+
chapters:
106+
- file: misc/roadmap
107+
title: Roadmap
108+
- file: misc/changelogs
109+
title: Changelogs
110+
- file: misc/usage-analytics
111+
title: Usage Analytics
112+
113+
- part: Support
114+
chapters:
115+
- file: support/contact
116+
title: Contact
117+
- file: support/faq-wip
118+
title: FAQ
119+
120+

‎docs/book/assets/arch-vert-lg.svg‎

Lines changed: 1 addition & 0 deletions
Loading

‎docs/book/assets/architectural-overview.png‎

721 KB
Loading

‎docs/book/assets/architecture-overview-zenml.png‎

91.3 KB
Loading

0 commit comments

Comments
 (0)