Skip to content

Commit 2cd7485

Browse files
committed
updated the doc for the as_of
1 parent f2f6ee2 commit 2cd7485

File tree

2 files changed

+15
-17
lines changed

2 files changed

+15
-17
lines changed

ads/feature_store/docs/source/dataset.rst

Lines changed: 9 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -245,21 +245,20 @@ You can call the ``get_input_schema_dataframe()`` method of the Dataset instance
245245
df = dataset.get_input_schema_dataframe()
246246
df.show()
247247
248-
Preview
249-
========
248+
as_of
249+
=======
250250

251-
You can call the ``preview()`` method of the Dataset instance to preview the dataset.
251+
You can call the ``as_of()`` method of the Dataset instance to get specified point in time and time traveled data.
252252

253-
The ``.preview()`` method takes the following optional parameter:
254-
- ``timestamp: date-time``. Commit timestamp for dataset
255-
- ``version_number: int``. Version number for dataset
256-
- ``row_count: int``. Defaults to 10. Total number of row to return
253+
The ``.as_of()`` method takes the following optional parameter:
254+
255+
- ``commit_timestamp: date-time``. Commit timestamp for feature group
256+
- ``version_number: int``. Version number for feature group
257257

258258
.. code-block:: python3
259259
260-
# Preview dataset
261-
df = dataset.preview(row_count=50)
262-
df.show()
260+
# as_of feature group
261+
df = dataset.as_of(version_number=1)
263262
264263
265264
Restore

ads/feature_store/docs/source/feature_group.rst

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -283,21 +283,20 @@ Feature store provides an API similar to Pandas to join feature groups together
283283
# Filter feature group
284284
feature_group.filter(feature_group.col1 > 10).show()
285285
286-
Preview
286+
as_of
287287
=======
288288

289-
You can call the ``preview()`` method of the FeatureGroup instance to preview the feature group.
289+
You can call the ``as_of()`` method of the FeatureGroup instance to get specified point in time and time traveled data.
290290

291-
The ``.preview()`` method takes the following optional parameter:
291+
The ``.as_of()`` method takes the following optional parameter:
292292

293-
- ``timestamp: date-time``. Commit timestamp for feature group
293+
- ``commit_timestamp: date-time``. Commit timestamp for feature group
294294
- ``version_number: int``. Version number for feature group
295-
- ``row_count: int``. Defaults to 10. Total number of row to return
296295

297296
.. code-block:: python3
298297
299-
# Preview feature group
300-
df = feature_group.preview(row_count=50)
298+
# as_of feature group
299+
df = feature_group.as_of(version_number=1)
301300
302301
Restore
303302
=======

0 commit comments

Comments
 (0)