You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardexpand all lines: docs/user_guides/fs/provenance/provenance.md
+73-4
Original file line number
Diff line number
Diff line change
@@ -2,11 +2,80 @@
2
2
3
3
## Introduction
4
4
5
-
Hopsworks feature store allows users to track provenance (lineage) between feature groups, feature views and training dataset. Tracking lineage allows users to determine where/if a feature group is being used. You can track if feature groups are being used to create additional (derived) feature groups or feature views.
5
+
Hopsworks feature store allows users to track provenance (lineage) between storage connectors, feature groups, feature views, training datasets and models. Tracking lineage allows users to determine where/if a feature group is being used. You can track if feature groups are being used to create additional (derived) feature groups or feature views.
6
6
7
7
You can interact with the provenance graph using the UI and the APIs.
8
8
9
-
## Step 1: Feature group lineage
9
+
## Step 1: Storage connector lineage
10
+
11
+
The relationship between storage connectors and feature groups is captured automatically when you create an external feature group. You can inspect the relationship between storage connectors and feature groups using the APIs.
Starting from a feature group metadata object, you can traverse upstream the provenance graph to retrieve the metadata objects of the storage connectors that are part of the feature group. To do so, you can use the [get_storage_connector_provenance](https://docs.hopsworks.ai/feature-store-api/{{{ hopsworks_version }}}/generated/api/feature_group_api/#get_storage_connector_provenance) method.
32
+
33
+
=== "Python"
34
+
35
+
```python
36
+
# Returns all storage connectors linked to the provided feature group
# List all the inaccessible parent storage connectors
46
+
lineage.inaccessible
47
+
```
48
+
49
+
=== "Python"
50
+
51
+
```python
52
+
# Returns an accessible storage connector linked to the feature group (if it exists)
53
+
user_profiles_fg.get_storage_connector()
54
+
```
55
+
56
+
To traverse the provenance graph in the opposite direction (i.e. from the storage connector to the feature group), you can use the [get_feature_groups_provenance](https://docs.hopsworks.ai/feature-store-api/{{{ hopsworks_version }}}/generated/api/storage_connector_api/#get_feature_groups_provenance) method. When navigating the provenance graph downstream, the `deleted` feature groups are not tracked by provenance, as such, the `deleted` property will always return an empty list.
57
+
58
+
=== "Python"
59
+
60
+
```python
61
+
# Returns all feature groups linked to the provided storage connector
# List all the inaccessible downstream feature groups
68
+
lineage.inaccessible
69
+
```
70
+
71
+
=== "Python"
72
+
73
+
```python
74
+
# Returns all accessible feature groups linked to the storage connector (if any exists)
75
+
snowflake_sc.get_feature_groups()
76
+
```
77
+
78
+
## Step 2: Feature group lineage
10
79
11
80
### Assign parents to a feature group
12
81
@@ -96,7 +165,7 @@ To traverse the provenance graph in the opposite direction (i.e. from the parent
96
165
lineage.inaccessible
97
166
```
98
167
99
-
You can also visualize the relationship between the parent and child feature groups in the UI. In each feature group overview page you can find a provenance section with the graph of parent feature groups and child feature groups/feature views.
168
+
You can also visualize the relationship between the parent and child feature groups in the UI. In each feature group overview page you can find a provenance section with the graph of parent storage connectors/feature groups and child feature groups/feature views.
100
169
101
170
<palign="center">
102
171
<figure>
@@ -105,7 +174,7 @@ You can also visualize the relationship between the parent and child feature gro
105
174
</figure>
106
175
</p>
107
176
108
-
## Step 2: Feature view lineage
177
+
## Step 3: Feature view lineage
109
178
110
179
The relationship between feature groups and feature views is captured automatically when you create a feature view. You can inspect the relationship between feature groups and feature views using the APIs or the UI.
0 commit comments