Skip to content

Commit

Permalink
Update docs of FeatureView.materialize_log (logicalclocks#287)
Browse files Browse the repository at this point in the history
  • Loading branch information
aversey authored Aug 20, 2024
1 parent 9413e6e commit 952d52d
Showing 1 changed file with 4 additions and 3 deletions.
7 changes: 4 additions & 3 deletions python/hsfs/feature_view.py
Original file line number Diff line number Diff line change
Expand Up @@ -3750,12 +3750,13 @@ def resume_logging(self) -> None:
self._feature_view_engine.resume_logging(self)

def materialize_log(
self, wait: Optional[bool] = False, transformed: Optional[bool] = None
) -> Tuple[Job, Job]:
self, wait: bool = False, transformed: Optional[bool] = None
) -> List[Job]:
"""Materialize the log for the current feature view.
# Arguments
wait: Whether to wait for the materialization to complete. Defaults to False.
transformed: Whether to materialize transformed or untrasformed logs. Defaults to None, in which case the returned list contains a job for materialization of transformed features and then a job for untransformed features. Otherwise the list contains only transformed jobs if transformed is True and untransformed jobs if it is False.
# Example
```python
Expand All @@ -3764,7 +3765,7 @@ def materialize_log(
```
# Returns
Tuple(`Job`, `Job`) Job information for the materialization jobs of transformed/untransformed features
List[`Job`] Job information for the materialization jobs of transformed and untransformed features.
# Raises
Expand Down

0 comments on commit 952d52d

Please sign in to comment.