Skip to content

Commit 66ca1b9

Browse files
committed
Reflect Deepchecks integration with ZenML and SDK updates
1 parent e5c4312 commit 66ca1b9

File tree

6 files changed

+8
-8
lines changed

6 files changed

+8
-8
lines changed

docs/book/component-guide/data-validators/deepchecks.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ The ZenML integration restructures the way Deepchecks validation checks are orga
5050
* **model validation checks** require a single dataset and a mandatory model as input. This list includes a subset of the model evaluation checks provided by Deepchecks [for tabular data](https://docs.deepchecks.com/stable/tabular/auto_checks/model_evaluation/index.html) and [for computer vision](https://docs.deepchecks.com/stable/vision/auto_checks/model_evaluation/index.html) that expect a single dataset as input.
5151
* **model drift checks** require two datasets and a mandatory model as input. This list includes a subset of the model evaluation checks provided by Deepchecks [for tabular data](https://docs.deepchecks.com/stable/tabular/auto_checks/model_evaluation/index.html) and [for computer vision](https://docs.deepchecks.com/stable/vision/auto_checks/model_evaluation/index.html) that expect two datasets as input: target and reference.
5252

53-
This structure is directly reflected in how Deepchecks can be used with ZenML: there are four different Deepchecks standard steps and four different [ZenML enums for Deepchecks checks](https://sdkdocs.zenml.io/latest/integration_code_docs/integrations-deepchecks.html#zenml.integrations.deepchecks) . [The Deepchecks Data Validator API](deepchecks.md#the-deepchecks-data-validator) is also modeled to reflect this same structure.
53+
This structure is directly reflected in how Deepchecks can be used with ZenML: there are four different Deepchecks standard steps and four different [ZenML enums for Deepchecks checks](https://sdkdocs.zenml.io/latest/integration_code_docs/integrations-deepchecks.html) . [The Deepchecks Data Validator API](deepchecks.md#the-deepchecks-data-validator) is also modeled to reflect this same structure.
5454

5555
A notable characteristic of Deepchecks is that you don't need to customize the set of Deepchecks tests that are part of a test suite. Both ZenML and Deepchecks provide sane defaults that will run all available Deepchecks tests in a given category with their default conditions if a custom list of tests and conditions are not provided.
5656

@@ -119,7 +119,7 @@ The integration doesn't yet include standard steps for computer vision, but you
119119
All four standard steps behave similarly regarding the configuration parameters and returned artifacts, with the following differences:
120120

121121
* the type and number of input artifacts are different, as mentioned above
122-
* each step expects a different enum data type to be used when explicitly listing the checks to be performed via the `check_list` configuration attribute. See the [`zenml.integrations.deepchecks.validation_checks`](https://sdkdocs.zenml.io/latest/integration_code_docs/integrations-deepchecks/#zenml.integrations.deepchecks.validation_checks) module for more details about these enums (e.g. the data integrity step expects a list of `DeepchecksDataIntegrityCheck` values).
122+
* each step expects a different enum data type to be used when explicitly listing the checks to be performed via the `check_list` configuration attribute. See the [`zenml.integrations.deepchecks.validation_checks`](https://sdkdocs.zenml.io/latest/integration_code_docs/integrations-deepchecks.html) module for more details about these enums (e.g. the data integrity step expects a list of `DeepchecksDataIntegrityCheck` values).
123123

124124
This section will only cover how you can use the data integrity step, with a similar usage to be easily inferred for the other three steps.
125125

@@ -151,7 +151,7 @@ def data_validation_pipeline():
151151
data_validation_pipeline()
152152
```
153153

154-
As can be seen from the [step definition](https://sdkdocs.zenml.io/latest/integration_code_docs/integrations-deepchecks/#zenml.integrations.deepchecks.steps.deepchecks_data_integrity) , the step takes in a dataset and it returns a Deepchecks `SuiteResult` object that contains the test results:
154+
As can be seen from the step definition, the step takes in a dataset and it returns a Deepchecks `SuiteResult` object that contains the test results:
155155

156156
```python
157157
@step

docs/book/component-guide/step-operators/spark-kubernetes.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -211,7 +211,7 @@ When you want to run your steps on a Kubernetes cluster, Spark will require you
211211
When using Spark in EKS, you need to use the latter and utilize the `docker-image-tool`. However, before the build process, you also need to download the following packages
212212

213213
* [`hadoop-aws` = 3.3.1](https://hadoop.apache.org/docs/r3.4.1/hadoop-aws/tools/hadoop-aws/index.html)
214-
* [`aws-java-sdk-bundle` = 1.12.150](https://mvnrepository.com/artifact/com.amazonaws/aws-java-sdk-bundle)
214+
* [`aws-java-sdk-bundle` = 1.12.150](https://javadoc.io/doc/com.amazonaws/aws-java-sdk-bundle/latest/index.html)
215215

216216
and put them in the `jars` folder within your Spark installation. Once that is set up, you can build the image as follows:
217217

docs/book/how-to/debug-and-solve-issues.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -115,7 +115,7 @@ Read more about how to set environment variables for:
115115

116116
* For [Linux](https://www3.ntu.edu.sg/home/ehchua/programming/howto/Environment_Variables.html#zz-3./).
117117
* For [macOS](https://youngstone89.medium.com/setting-up-environment-variables-in-mac-os-28e5941c771c).
118-
* For [Windows](https://www.computerhope.com/issues/ch000549.htm).
118+
* For [Windows](https://www3.ntu.edu.sg/home/ehchua/programming/howto/Environment_Variables.html).
119119

120120
### Client and server logs
121121

docs/book/how-to/infrastructure-deployment/stack-deployment/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ Here's an approach you can take that is a good balance between convenience and s
5656
If you follow this approach, you can keep your data scientists free from the hassle of figuring out the best authentication mechanisms for the different cloud services, having to manage credentials locally, and keep your cloud accounts safe, while still giving them the freedom to run their experiments in the cloud.
5757

5858
{% hint style="info" %}
59-
Please note that restricting permissions for users through roles is a ZenML Pro feature. You can read more about it [here](https://docs.zenml.io/pro/heirarchy/roles). Sign up for a free trial here: https://cloud.zenml.io/.
59+
Please note that restricting permissions for users through roles is a ZenML Pro feature. You can read more about it [here](https://docs.zenml.io/pro/core-concepts/roles). Sign up for a free trial here: https://cloud.zenml.io/.
6060
{% endhint %}
6161

6262
## How to deploy and manage stacks

docs/book/how-to/model-management-metrics/track-metrics-metadata/fetch-metadata-within-pipeline.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ def my_pipeline():
4545
```
4646

4747
{% hint style="info" %}
48-
See the [SDK Docs](https://sdkdocs.zenml.io/latest/core_code_docs/core-new/#zenml.pipelines.pipeline_context.PipelineContext) for more information on which attributes and methods the `PipelineContext` provides.
48+
See the [SDK Docs](https://sdkdocs.zenml.io/latest/index.html#zenml.pipelines.PipelineContext) for more information on which attributes and methods the `PipelineContext` provides.
4949
{% endhint %}
5050

5151
<!-- For scarf -->

docs/book/how-to/model-management-metrics/track-metrics-metadata/fetch-metadata-within-steps.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ def my_step():
3737
```
3838

3939
{% hint style="info" %}
40-
See the [SDK Docs](https://sdkdocs.zenml.io/latest/core\_code\_docs/core-new/#zenml.steps.step\_context.StepContext) for more information on which attributes and methods the `StepContext` provides.
40+
See the [SDK Docs](https://sdkdocs.zenml.io/latest/index.html#zenml.steps.StepContext) for more information on which attributes and methods the `StepContext` provides.
4141
{% endhint %}
4242

4343
<figure><img src="https://static.scarf.sh/a.png?x-pxid=f0b4f458-0a54-4fcd-aa95-d5ee424815bc" alt="ZenML Scarf"><figcaption></figcaption></figure>

0 commit comments

Comments
 (0)