Skip to content

Commit 278a064

Browse files
committed
added docs
1 parent ee0a419 commit 278a064

File tree

3 files changed

+35
-2
lines changed

3 files changed

+35
-2
lines changed
Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
Data Versioning
2+
****************
3+
4+
Data versioning is a practice aimed at recording the various data commits integrated into a particular feature group and dataset. This involves tracking changes in data over time while maintaining consistent schema structures and feature definitions within a shared schema version. In the context of feature store, it's important to note that data versioning features are exclusively available for offline feature groups.
5+
6+
.. image:: figures/dataset_versioning.png
7+
8+
9+
As Of
10+
======
11+
12+
You can call the ``as_of()`` method of the ``FeatureGroup`` or ``Dataset`` instance to get specified point in time and time traveled data.
13+
14+
The ``.as_of()`` method takes the following optional parameter:
15+
16+
- ``commit_timestamp: date-time``. Commit timestamp for feature group
17+
- ``version_number: int``. Version number for feature group
18+
19+
.. code-block:: python3
20+
21+
# as_of feature group
22+
df = feature_group.as_of(version_number=1)
23+
24+
25+
History
26+
=======
27+
28+
You can call the ``history()`` method of the ``FeatureGroup`` or ``Dataset`` instance to show history of the feature group.
29+
30+
.. code-block:: python3
31+
32+
# Show history of feature group
33+
df = feature_group.history()

ads/feature_store/docs/source/feature_group.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -317,10 +317,10 @@ The ``.preview()`` method takes the following optional parameter:
317317
# Preview feature group
318318
df = feature_group.preview(row_count=50)
319319
320-
as_of
320+
As Of
321321
=======
322322

323-
You can call the ``as_of()`` method of the FeatureGroup instance to get specified point in time and time traveled data.
323+
You can call the ``as_of()`` method of the ``FeatureGroup`` instance to get specified point in time and time traveled data.
324324

325325
The ``.as_of()`` method takes the following optional parameter:
326326

Loading

0 commit comments

Comments
 (0)