Skip to content

Commit fa56768

Browse files
committed
doc changes for feature group and dataset
1 parent d4d7b2b commit fa56768

File tree

2 files changed

+39
-0
lines changed

2 files changed

+39
-0
lines changed

ads/feature_store/docs/source/dataset.rst

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -245,6 +245,25 @@ 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+
========
250+
251+
.. deprecated:: 1.0.3
252+
Use :func:`as_of` instead.
253+
254+
You can call the ``preview()`` method of the Dataset instance to preview the dataset.
255+
256+
The ``.preview()`` method takes the following optional parameter:
257+
- ``timestamp: date-time``. Commit timestamp for dataset
258+
- ``version_number: int``. Version number for dataset
259+
- ``row_count: int``. Defaults to 10. Total number of row to return
260+
261+
.. code-block:: python3
262+
263+
# Preview dataset
264+
df = dataset.preview(row_count=50)
265+
df.show()
266+
248267
as_of
249268
=======
250269

ads/feature_store/docs/source/feature_group.rst

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -283,6 +283,26 @@ 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+
287+
Preview
288+
=======
289+
290+
.. deprecated:: 1.0.3
291+
Use :func:`as_of` instead.
292+
293+
You can call the ``preview()`` method of the FeatureGroup instance to preview the feature group.
294+
295+
The ``.preview()`` method takes the following optional parameter:
296+
297+
- ``timestamp: date-time``. Commit timestamp for feature group
298+
- ``version_number: int``. Version number for feature group
299+
- ``row_count: int``. Defaults to 10. Total number of row to return
300+
301+
.. code-block:: python3
302+
303+
# Preview feature group
304+
df = feature_group.preview(row_count=50)
305+
286306
as_of
287307
=======
288308

0 commit comments

Comments
 (0)