Skip to content

Commit ac04a9d

Browse files
committed
Address comments
1 parent 5a4091a commit ac04a9d

File tree

4 files changed

+8
-8
lines changed

4 files changed

+8
-8
lines changed

docs/user_guides/fs/feature_group/data_validation.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,7 @@ In order to define and validate an expectation when writing to a Feature Group,
6464

6565
- A Hopsworks project. If you don't have a project yet you can go to [managed.hopsworks.ai](https://managed.hopsworks.ai), signup with your email and create your first project.
6666
- An API key, you can get one by following the instructions [here](../../../setup_installation/common/api_key.md)
67-
- The [hopsworks python library](../../client_installation/index.md) installed in your client
67+
- The [Hopsworks Python library](https://pypi.org/project/hopsworks) installed in your client. See the [installation guide](../../client_installation/index.md).
6868

6969
#### Connect your notebook to Hopsworks
7070

docs/user_guides/fs/feature_group/data_validation_best_practices.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -109,4 +109,4 @@ First you will need to configure your preferred communication endpoint: slack, e
109109

110110
## Conclusion
111111

112-
Hopsworks completes Great Expectation by automatically running the validation, persisting the reports along your data and allowing you to monitor data quality in its UI. How you decide to make use of these tools depends on your application and requirements. Whether in development or in production, real-time or batch, we think there is configuration that will work for your team. Check out our [quick hands-on tutorial](https://colab.research.google.com/github/logicalclocks/hopsworks-tutorials/blob/master/integrations/great_expectations/fraud_batch_data_validation.ipynb) to start applying what you learned so far.
112+
Hopsworks extends Great Expectations by automatically running the validation, persisting the reports along your data and allowing you to monitor data quality in its UI. How you decide to make use of these tools depends on your application and requirements. Whether in development or in production, real-time or batch, we think there is configuration that will work for your team. Check out our [quick hands-on tutorial](https://colab.research.google.com/github/logicalclocks/hopsworks-tutorials/blob/master/integrations/great_expectations/fraud_batch_data_validation.ipynb) to start applying what you learned so far.

docs/user_guides/fs/feature_group/feature_monitoring.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -5,13 +5,13 @@ Feature Monitoring complements the Hopsworks data validation capabilities for Fe
55
Before continuing with this guide, see the [Feature monitoring guide](../feature_monitoring/index.md) to learn more about how feature monitoring works, and get familiar with the different use cases of feature monitoring for Feature Groups described in the **Use cases** sections of the [Scheduled statistics guide](../feature_monitoring/scheduled_statistics.md#use-cases) and [Statistics comparison guide](../feature_monitoring/statistics_comparison.md#use-cases).
66

77
!!! warning "Limited UI support"
8-
Currently, feature monitoring can only be configured using the **Hopsworks Python library**. However, you can enable/disable a feature monitoring configuration or trigger the statistics comparison manually from the UI, as shown in the [Advanced guide](../feature_monitoring/feature_monitoring_advanced.md).
8+
Currently, feature monitoring can only be configured using the [Hopsworks Python library](https://pypi.org/project/hopsworks). However, you can enable/disable a feature monitoring configuration or trigger the statistics comparison manually from the UI, as shown in the [Advanced guide](../feature_monitoring/feature_monitoring_advanced.md).
99

1010
## Code
1111

1212
In this section, we show you how to setup feature monitoring in a Feature Group using the ==Hopsworks Python library==. Alternatively, you can get started quickly by running our [tutorial for feature monitoring](https://github.com/logicalclocks/hopsworks-tutorials/blob/master/integrations/feature-monitoring/feature-monitoring.ipynb).
1313

14-
First, checkout the pre-requisite and Hopsworks setup to follow the guide below. Create a project, install the Hopsworks Python library in your environment, connect via the generated API key. The second step is to start a new configuration for feature monitoring.
14+
First, checkout the pre-requisite and Hopsworks setup to follow the guide below. Create a project, install the [Hopsworks Python library](https://pypi.org/project/hopsworks) in your environment, connect via the generated API key. The second step is to start a new configuration for feature monitoring.
1515

1616
After that, you can optionally define a detection window of data to compute statistics on, or use the default detection window (i.e., whole feature data). If you want to setup scheduled statistics alone, you can jump to the last step to save your configuration. Otherwise, the third and fourth steps are also optional and show you how to setup the comparison of statistics on a schedule by defining a reference window and specifying the statistics metric to monitor.
1717

@@ -21,7 +21,7 @@ In order to setup feature monitoring for a Feature Group, you will need:
2121

2222
- A Hopsworks project. If you don't have a project yet you can go to [managed.hopsworks.ai](https://managed.hopsworks.ai), signup with your email and create your first project.
2323
- An API key, you can get one by following the instructions [here](../../../setup_installation/common/api_key.md)
24-
- The [hopsworks python library](../../client_installation/index.md) installed in your client
24+
- The Hopsworks Python library installed in your client. See the [installation guide](../../client_installation/index.md).
2525
- A Feature Group
2626

2727
#### Connect your notebook to Hopsworks

docs/user_guides/fs/feature_view/feature_monitoring.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -5,13 +5,13 @@ Feature Monitoring complements the Hopsworks data validation capabilities for Fe
55
Before continuing with this guide, see the [Feature monitoring guide](../feature_monitoring/index.md) to learn more about how feature monitoring works, and get familiar with the different use cases of feature monitoring for Feature Views described in the **Use cases** sections of the [Scheduled statistics guide](../feature_monitoring/scheduled_statistics.md#use-cases) and [Statistics comparison guide](../feature_monitoring/statistics_comparison.md#use-cases).
66

77
!!! warning "Limited UI support"
8-
Currently, feature monitoring can only be configured using the **Hopsworks Python library**. However, you can enable/disable a feature monitoring configuration or trigger the statistics comparison manually from the UI, as shown in the [Advanced guide](../feature_monitoring/feature_monitoring_advanced.md).
8+
Currently, feature monitoring can only be configured using the [Hopsworks Python library](https://pypi.org/project/hopsworks). However, you can enable/disable a feature monitoring configuration or trigger the statistics comparison manually from the UI, as shown in the [Advanced guide](../feature_monitoring/feature_monitoring_advanced.md).
99

1010
## Code
1111

1212
In this section, we show you how to setup feature monitoring in a Feature View using the ==Hopsworks Python library==. Alternatively, you can get started quickly by running our [tutorial for feature monitoring](https://github.com/logicalclocks/hopsworks-tutorials/blob/master/integrations/feature-monitoring/feature-monitoring.ipynb).
1313

14-
First, checkout the pre-requisite and Hopsworks setup to follow the guide below. Create a project, install the Hopsworks Python library in your environment and connect via the generated API key. The second step is to start a new configuration for feature monitoring.
14+
First, checkout the pre-requisite and Hopsworks setup to follow the guide below. Create a project, install the [Hopsworks Python library](https://pypi.org/project/hopsworks) in your environment and connect via the generated API key. The second step is to start a new configuration for feature monitoring.
1515

1616
After that, you can optionally define a detection window of data to compute statistics on, or use the default detection window (i.e., whole feature data). If you want to setup scheduled statistics alone, you can jump to the last step to save your configuration. Otherwise, the third and fourth steps are also optional and show you how to setup the comparison of statistics on a schedule by defining a reference window and specifying the statistics metric to be compared.
1717

@@ -21,7 +21,7 @@ In order to setup feature monitoring for a Feature View, you will need:
2121

2222
- A Hopsworks project. If you don't have a project yet you can go to [managed.hopsworks.ai](https://managed.hopsworks.ai), signup with your email and create your first project.
2323
- An API key, you can get one by following the instructions [here](../../../setup_installation/common/api_key.md)
24-
- The [hopsworks python library](../../client_installation/index.md) installed in your client
24+
- The [Hopsworks Python library](https://pypi.org/project/hopsworks) installed in your client. See the [installation guide](../../client_installation/index.md).
2525
- A Feature View
2626
- A Training Dataset
2727

0 commit comments

Comments
 (0)