Skip to content

Commit b091b27

Browse files
htahir1gitbook-bot
htahir1
authored and
gitbook-bot
committed
GitBook: [#528] For 0.5.0
1 parent 92a316e commit b091b27

24 files changed

+70
-251
lines changed

‎docs/book/.gitbook/assets/architecture_diagram (1) (2) (2) (3) (1).png‎

119 KB
Loading

‎docs/book/.gitbook/assets/architecture_diagram (1) (2) (2) (3) (2).png‎

119 KB
Loading

‎docs/book/.gitbook/assets/architecture_diagram (1) (2) (2) (3) (3).png‎

119 KB
Loading

‎docs/book/.gitbook/assets/architecture_diagram (1) (2) (2) (3) (4).png‎

119 KB
Loading

‎docs/book/api-reference/zenml/README.md‎

Lines changed: 0 additions & 221 deletions
Original file line numberDiff line numberDiff line change
@@ -1,223 +1,2 @@
11
# Zenml
22

3-
<!DOCTYPE html>
4-
5-
zenml package — ZenML documentation [ZenML](https://github.com/zenml-io/zenml/tree/154f041af2db9874b351cccd305478a173a7e939/docs/sphinx_docs/_build/html/index.html)
6-
7-
* [Site](https://github.com/zenml-io/zenml/tree/154f041af2db9874b351cccd305478a173a7e939/docs/sphinx_docs/_build/html/index.html)
8-
* Contents:
9-
* [zenml](https://github.com/zenml-io/zenml/tree/154f041af2db9874b351cccd305478a173a7e939/docs/sphinx_docs/_build/html/modules.html)
10-
* [Page](./)
11-
* * [zenml package](./)
12-
* [Subpackages](./#subpackages)
13-
* [Submodules](./#submodules)
14-
* [zenml.constants module](./#module-zenml.constants)
15-
* [zenml.enums module](./#module-zenml.enums)
16-
* [zenml.exceptions module](./#module-zenml.exceptions)
17-
* [zenml.logger module](./#module-zenml.logger)
18-
* [Module contents](./#module-zenml)
19-
* [ « zenml](https://github.com/zenml-io/zenml/tree/154f041af2db9874b351cccd305478a173a7e939/docs/sphinx_docs/_build/html/modules.html)
20-
* [ zenml.annotat... »](zenml.annotations.md)
21-
* [Source](https://github.com/zenml-io/zenml/tree/154f041af2db9874b351cccd305478a173a7e939/docs/sphinx_docs/_build/html/_sources/zenml.rst.txt)
22-
23-
## zenml package[](./#zenml-package)
24-
25-
### Subpackages[](./#subpackages)
26-
27-
* [zenml.annotations package](zenml.annotations.md)
28-
* [Submodules](zenml.annotations.md#submodules)
29-
* [zenml.annotations.artifact\_annotations module](zenml.annotations.md#module-zenml.annotations.artifact_annotations)
30-
* [zenml.annotations.base\_annotations module](zenml.annotations.md#module-zenml.annotations.base_annotations)
31-
* [zenml.annotations.step\_annotations module](zenml.annotations.md#module-zenml.annotations.step_annotations)
32-
* [Module contents](zenml.annotations.md#module-zenml.annotations)
33-
* [zenml.artifact\_stores package](zenml.artifact_stores.md)
34-
* [Submodules](zenml.artifact_stores.md#submodules)
35-
* [zenml.artifact\_stores.base\_artifact\_store module](zenml.artifact_stores.md#module-zenml.artifact_stores.base_artifact_store)
36-
* [zenml.artifact\_stores.gcp\_artifact\_store module](zenml.artifact_stores.md#module-zenml.artifact_stores.gcp_artifact_store)
37-
* [zenml.artifact\_stores.local\_artifact\_store module](zenml.artifact_stores.md#module-zenml.artifact_stores.local_artifact_store)
38-
* [Module contents](zenml.artifact_stores.md#module-zenml.artifact_stores)
39-
* [zenml.artifacts package](zenml.artifacts.md)
40-
* [Submodules](zenml.artifacts.md#submodules)
41-
* [zenml.artifacts.base\_artifact module](zenml.artifacts.md#module-zenml.artifacts.base_artifact)
42-
* [zenml.artifacts.data\_artifact module](zenml.artifacts.md#module-zenml.artifacts.data_artifact)
43-
* [zenml.artifacts.model\_artifact module](zenml.artifacts.md#module-zenml.artifacts.model_artifact)
44-
* [Module contents](zenml.artifacts.md#module-zenml.artifacts)
45-
* [zenml.cli package](zenml.cli.md)
46-
* [Submodules](zenml.cli.md#submodules)
47-
* [zenml.cli.base module](zenml.cli.md#module-zenml.cli.base)
48-
* [zenml.cli.cli module](zenml.cli.md#module-zenml.cli.cli)
49-
* [zenml.cli.config module](zenml.cli.md#module-zenml.cli.config)
50-
* [zenml.cli.example module](zenml.cli.md#module-zenml.cli.example)
51-
* [zenml.cli.pipeline module](zenml.cli.md#module-zenml.cli.pipeline)
52-
* [zenml.cli.stack module](zenml.cli.md#module-zenml.cli.stack)
53-
* [zenml.cli.step module](zenml.cli.md#module-zenml.cli.step)
54-
* [zenml.cli.utils module](zenml.cli.md#module-zenml.cli.utils)
55-
* [zenml.cli.version module](zenml.cli.md#module-zenml.cli.version)
56-
* [Module contents](zenml.cli.md#module-zenml.cli)
57-
* [zenml.config package](zenml.config.md)
58-
* [Submodules](zenml.config.md#submodules)
59-
* [zenml.config.constants module](zenml.config.md#module-zenml.config.constants)
60-
* [zenml.config.global\_config module](zenml.config.md#module-zenml.config.global_config)
61-
* [Module contents](zenml.config.md#module-zenml.config)
62-
* [zenml.core package](zenml.core.md)
63-
* [Submodules](zenml.core.md#submodules)
64-
* [zenml.core.base\_component module](zenml.core.md#module-zenml.core.base_component)
65-
* [zenml.core.component\_factory module](zenml.core.md#module-zenml.core.component_factory)
66-
* [zenml.core.constants module](zenml.core.md#module-zenml.core.constants)
67-
* [zenml.core.git\_wrapper module](zenml.core.md#module-zenml.core.git_wrapper)
68-
* [zenml.core.local\_service module](zenml.core.md#module-zenml.core.local_service)
69-
* [zenml.core.local\_service\_test module](zenml.core.md#module-zenml.core.local_service_test)
70-
* [zenml.core.mapping\_utils module](zenml.core.md#module-zenml.core.mapping_utils)
71-
* [zenml.core.repo module](zenml.core.md#module-zenml.core.repo)
72-
* [zenml.core.repo\_test module](zenml.core.md#module-zenml.core.repo_test)
73-
* [zenml.core.utils module](zenml.core.md#module-zenml.core.utils)
74-
* [Module contents](zenml.core.md#module-zenml.core)
75-
* [zenml.io package](zenml.io.md)
76-
* [Submodules](zenml.io.md#submodules)
77-
* [zenml.io.gcs\_plugin module](zenml.io.md#zenml-io-gcs-plugin-module)
78-
* [Module contents](zenml.io.md#module-zenml.io)
79-
* [zenml.materializers package](zenml.materializers.md)
80-
* [Submodules](zenml.materializers.md#submodules)
81-
* [zenml.materializers.base\_materializer module](zenml.materializers.md#module-zenml.materializers.base_materializer)
82-
* [zenml.materializers.beam\_materializer module](zenml.materializers.md#module-zenml.materializers.beam_materializer)
83-
* [zenml.materializers.json\_materializer module](zenml.materializers.md#module-zenml.materializers.json_materializer)
84-
* [zenml.materializers.keras\_meterializer module](zenml.materializers.md#module-zenml.materializers.keras_meterializer)
85-
* [zenml.materializers.materializer\_factory module](zenml.materializers.md#module-zenml.materializers.materializer_factory)
86-
* [zenml.materializers.pandas\_materializer module](zenml.materializers.md#module-zenml.materializers.pandas_materializer)
87-
* [Module contents](zenml.materializers.md#module-zenml.materializers)
88-
* [zenml.metadata package](zenml.metadata.md)
89-
* [Submodules](zenml.metadata.md#submodules)
90-
* [zenml.metadata.base\_metadata\_store module](zenml.metadata.md#module-zenml.metadata.base_metadata_store)
91-
* [zenml.metadata.base\_metadata\_wrapper\_test module](zenml.metadata.md#zenml-metadata-base-metadata-wrapper-test-module)
92-
* [zenml.metadata.mock\_metadata\_wrapper module](zenml.metadata.md#module-zenml.metadata.mock_metadata_wrapper)
93-
* [zenml.metadata.mysql\_metadata\_wrapper module](zenml.metadata.md#module-zenml.metadata.mysql_metadata_wrapper)
94-
* [zenml.metadata.sqlite\_metadata\_wrapper module](zenml.metadata.md#module-zenml.metadata.sqlite_metadata_wrapper)
95-
* [Module contents](zenml.metadata.md#module-zenml.metadata)
96-
* [zenml.orchestrators package](zenml.orchestrators/)
97-
* [Subpackages](zenml.orchestrators/#subpackages)
98-
* [zenml.orchestrators.airflow package](https://github.com/zenml-io/zenml/tree/154f041af2db9874b351cccd305478a173a7e939/docs/sphinx_docs/_build/html/zenml.orchestrators.airflow.html)
99-
* [Submodules](https://github.com/zenml-io/zenml/tree/154f041af2db9874b351cccd305478a173a7e939/docs/sphinx_docs/_build/html/zenml.orchestrators.airflow.html#submodules)
100-
* [zenml.orchestrators.airflow.airflow\_component module](https://github.com/zenml-io/zenml/tree/154f041af2db9874b351cccd305478a173a7e939/docs/sphinx_docs/_build/html/zenml.orchestrators.airflow.html#zenml-orchestrators-airflow-airflow-component-module)
101-
* [zenml.orchestrators.airflow.airflow\_dag\_runner module](https://github.com/zenml-io/zenml/tree/154f041af2db9874b351cccd305478a173a7e939/docs/sphinx_docs/_build/html/zenml.orchestrators.airflow.html#zenml-orchestrators-airflow-airflow-dag-runner-module)
102-
* [zenml.orchestrators.airflow.airflow\_orchestrator module](https://github.com/zenml-io/zenml/tree/154f041af2db9874b351cccd305478a173a7e939/docs/sphinx_docs/_build/html/zenml.orchestrators.airflow.html#zenml-orchestrators-airflow-airflow-orchestrator-module)
103-
* [Module contents](https://github.com/zenml-io/zenml/tree/154f041af2db9874b351cccd305478a173a7e939/docs/sphinx_docs/_build/html/zenml.orchestrators.airflow.html#module-zenml.orchestrators.airflow)
104-
* [zenml.orchestrators.local package](zenml.orchestrators/zenml.orchestrators.local.md)
105-
* [Submodules](zenml.orchestrators/zenml.orchestrators.local.md#submodules)
106-
* [zenml.orchestrators.local.local\_orchestrator module](zenml.orchestrators/zenml.orchestrators.local.md#module-zenml.orchestrators.local.local_orchestrator)
107-
* [Module contents](zenml.orchestrators/zenml.orchestrators.local.md#module-zenml.orchestrators.local)
108-
* [Submodules](zenml.orchestrators/#submodules)
109-
* [zenml.orchestrators.base\_orchestrator module](zenml.orchestrators/#module-zenml.orchestrators.base_orchestrator)
110-
* [Module contents](zenml.orchestrators/#module-zenml.orchestrators)
111-
* [zenml.pipelines package](zenml.pipelines.md)
112-
* [Submodules](zenml.pipelines.md#submodules)
113-
* [zenml.pipelines.base\_pipeline module](zenml.pipelines.md#module-zenml.pipelines.base_pipeline)
114-
* [zenml.pipelines.pipeline\_decorator module](zenml.pipelines.md#module-zenml.pipelines.pipeline_decorator)
115-
* [Module contents](zenml.pipelines.md#module-zenml.pipelines)
116-
* [zenml.stacks package](zenml.stacks.md)
117-
* [Submodules](zenml.stacks.md#submodules)
118-
* [zenml.stacks.base\_stack module](zenml.stacks.md#module-zenml.stacks.base_stack)
119-
* [zenml.stacks.constants module](zenml.stacks.md#module-zenml.stacks.constants)
120-
* [Module contents](zenml.stacks.md#module-zenml.stacks)
121-
* [zenml.steps package](zenml.steps.md)
122-
* [Submodules](zenml.steps.md#submodules)
123-
* [zenml.steps.base\_step module](zenml.steps.md#module-zenml.steps.base_step)
124-
* [zenml.steps.step\_decorator module](zenml.steps.md#module-zenml.steps.step_decorator)
125-
* [zenml.steps.utils module](zenml.steps.md#module-zenml.steps.utils)
126-
* [Module contents](zenml.steps.md#module-zenml.steps)
127-
* [zenml.utils package](zenml.utils.md)
128-
* [Submodules](zenml.utils.md#submodules)
129-
* [zenml.utils.analytics\_utils module](zenml.utils.md#module-zenml.utils.analytics_utils)
130-
* [zenml.utils.exceptions module](zenml.utils.md#module-zenml.utils.exceptions)
131-
* [zenml.utils.path\_utils module](zenml.utils.md#module-zenml.utils.path_utils)
132-
* [zenml.utils.source\_utils module](zenml.utils.md#module-zenml.utils.source_utils)
133-
* [zenml.utils.yaml\_utils module](zenml.utils.md#module-zenml.utils.yaml_utils)
134-
* [Module contents](zenml.utils.md#module-zenml.utils)
135-
136-
### Submodules[](./#submodules)
137-
138-
### zenml.constants module[](./#module-zenml.constants)
139-
140-
zenml.constants.handle\_bool\_env\_var\(_var_, _default=False_\)[](./#zenml.constants.handle_bool_env_var)
141-
142-
Converts normal env var to boolean
143-
144-
### zenml.enums module[](./#module-zenml.enums)
145-
146-
_class_ zenml.enums.ArtifactStoreTypes\(_value_\)[](./#zenml.enums.ArtifactStoreTypes)
147-
148-
Bases: `str`, `enum.Enum`
149-
150-
All supported Artifact Store types. base _= 'base'_[](./#zenml.enums.ArtifactStoreTypes.base) gcp _= 'gcp'_[](./#zenml.enums.ArtifactStoreTypes.gcp) local _= 'local'_[](./#zenml.enums.ArtifactStoreTypes.local) _class_ zenml.enums.MLMetadataTypes\(_value_\)[](./#zenml.enums.MLMetadataTypes)
151-
152-
Bases: `str`, `enum.Enum`
153-
154-
All supported ML Metadata types. base _= 'base'_[](./#zenml.enums.MLMetadataTypes.base) mock _= 'mock'_[](./#zenml.enums.MLMetadataTypes.mock) mysql _= 'mysql'_[](./#zenml.enums.MLMetadataTypes.mysql) sqlite _= 'sqlite'_[](./#zenml.enums.MLMetadataTypes.sqlite) _class_ zenml.enums.OrchestratorTypes\(_value_\)[](./#zenml.enums.OrchestratorTypes)
155-
156-
Bases: `str`, `enum.Enum`
157-
158-
All supported Orchestrator types airflow _= 'airflow'_[](./#zenml.enums.OrchestratorTypes.airflow) base _= 'base'_[](./#zenml.enums.OrchestratorTypes.base) local _= 'local'_[](./#zenml.enums.OrchestratorTypes.local) _class_ zenml.enums.PipelineStatusTypes\(_value_\)[](./#zenml.enums.PipelineStatusTypes)
159-
160-
Bases: `str`, `enum.Enum`
161-
162-
All supported Pipeline status types. Failed _= 'Failed'_[](./#zenml.enums.PipelineStatusTypes.Failed) NotStarted _= 'NotStarted'_[](./#zenml.enums.PipelineStatusTypes.NotStarted) Running _= 'Running'_[](./#zenml.enums.PipelineStatusTypes.Running) Succeeded _= 'Succeeded'_[](./#zenml.enums.PipelineStatusTypes.Succeeded) _class_ zenml.enums.StackTypes\(_value_\)[](./#zenml.enums.StackTypes)
163-
164-
Bases: `str`, `enum.Enum`
165-
166-
All supported Stack types. base _= 'base'_[](./#zenml.enums.StackTypes.base)
167-
168-
### zenml.exceptions module[](./#module-zenml.exceptions)
169-
170-
ZenML specific exception definitions _exception_ zenml.exceptions.AlreadyExistsException\(_message: Optional\[str\] = None_, _name: str = ''_, _resource\_type: str = ''_\)[](./#zenml.exceptions.AlreadyExistsException)
171-
172-
Bases: `Exception`
173-
174-
Raises exception when the name already exist in the system but an action is trying to create a resource with the same name. _exception_ zenml.exceptions.DoesNotExistException\(_name: str = ''_, _reason: str = ''_, _message='{} does not exist! This might be due to: {}'_\)[](./#zenml.exceptions.DoesNotExistException)
175-
176-
Bases: `Exception`
177-
178-
Raises exception when the name does not exist in the system but an action is being done that requires it to be present. _exception_ zenml.exceptions.EmptyDatasourceException\(_message='This datasource has not been used in any pipelines, therefore the associated data has no versions. Please use this datasouce in any ZenML pipeline with \`pipeline.add\_datasource\(datasource\)\`'_\)[](./#zenml.exceptions.EmptyDatasourceException)
179-
180-
Bases: `Exception`
181-
182-
Raises exception when a datasource data is accessed without running an associated pipeline. _exception_ zenml.exceptions.GitException\(_message: str = 'There is a problem with git resolution. Please make sure that all relevant files are committed.'_\)[](./#zenml.exceptions.GitException)
183-
184-
Bases: `Exception`
185-
186-
Raises exception when a problem occurs in git resolution. _exception_ zenml.exceptions.InitializationException\(_message='ZenML config is none. Did you do \`zenml init\`?'_\)[](./#zenml.exceptions.InitializationException)
187-
188-
Bases: `Exception`
189-
190-
Raises exception when a function is run before zenml initialization. _exception_ zenml.exceptions.PipelineNotSucceededException\(_name: str = ''_, _message: str = '{} is not yet completed successfully.'_\)[](./#zenml.exceptions.PipelineNotSucceededException)
191-
192-
Bases: `Exception`
193-
194-
Raises exception when trying to fetch artifacts from a not succeeded pipeline.
195-
196-
### zenml.logger module[](./#module-zenml.logger)
197-
198-
zenml.logger.get\_console\_handler\(\) → Any[](./#zenml.logger.get_console_handler)
199-
200-
Get console handler for logging. zenml.logger.get\_file\_handler\(\) → Any[](./#zenml.logger.get_file_handler)
201-
202-
Return a file handler for logging. zenml.logger.get\_logger\(_logger\_name_\) → Any[](./#zenml.logger.get_logger)
203-
204-
Main function to get logger name,.Parameters
205-
206-
**logger\_name** – Name of logger to initialize.Returns
207-
208-
A logger object. zenml.logger.init\_logging\(\)[](./#zenml.logger.init_logging)
209-
210-
Initialize logging with default levels. zenml.logger.resolve\_logging\_level\(\)[](./#zenml.logger.resolve_logging_level)
211-
212-
Resolve the logging level from the env variable. zenml.logger.set\_root\_verbosity\(\)[](./#zenml.logger.set_root_verbosity)
213-
214-
Set the root verbosity.
215-
216-
### Module contents[](./#module-zenml)
217-
218-
[Back to top](./)
219-
220-
© Copyright 2021, ZenML GmbH.
221-
Created using [Sphinx](http://sphinx-doc.org/) 4.2.0.
222-
223-

‎docs/book/api-reference/zenml/annotations.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
# Annotations
2+

‎docs/book/api-reference/zenml/artifact-stores.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
# Artifact stores
2+

‎docs/book/api-reference/zenml/artifacts.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
# Artifacts
2+

‎docs/book/api-reference/zenml/cli.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
# Cli
2+

‎docs/book/api-reference/zenml/config.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
# Config
2+

0 commit comments

Comments
 (0)