Skip to content

Commit 370425a

Browse files
committed
Ajust docstrings, following review remarks
1 parent 5287bdd commit 370425a

File tree

3 files changed

+13
-6
lines changed

3 files changed

+13
-6
lines changed

dataikuapi/dss/dataset.py

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -741,15 +741,14 @@ def add_raw_schema_column(self, column):
741741
def is_feature_group(self):
742742
"""
743743
Indicates whether the Dataset is defined as a Feature Group, available in the Feature Store.
744-
Changes of this property will be applied when calling :meth:`save` and require the "Manage Feature Store" permission.
745744
746745
:rtype: bool
747746
"""
748747
return self.settings["featureGroup"]
749748

750749
def set_feature_group(self, status):
751750
"""
752-
Indicates whether the Dataset is defined as a Feature Group, available in the Feature Store.
751+
(Un)sets the dataset as a Feature Group, available in the Feature Store.
753752
Changes of this property will be applied when calling :meth:`save` and require the "Manage Feature Store" permission.
754753
755754
:param status: whether the dataset should be defined as a feature group

dataikuapi/dss/feature_store.py

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,17 @@
11
class DSSFeatureStore(object):
22
def __init__(self, client):
33
"""
4-
A handle on the Feature Store. Do not call this methid directly, call """
4+
A handle on the Feature Store.
5+
Do not create this class directly, use :meth:`DSSClient.get_feature_store`
6+
"""
57
self.client = client
68

79
def list_feature_groups(self):
810
"""
9-
Get a list of names of datasets defined as feature groups on the DSS instance.
11+
Get a list of names of datasets on which the user has right permissions
12+
and that are defined as feature groups in the DSS instance
1013
11-
:return: list of names of datasets defined as feature groups
14+
:return: list of dataset names
1215
:rtype: list of str
1316
"""
1417
return self.client._perform_json("GET", "/feature-store/feature-groups/list")

dataikuapi/dssclient.py

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1123,8 +1123,13 @@ def get_object_discussions(self, project_key, object_type, object_id):
11231123
# Feature Store
11241124
########################################################
11251125
def get_feature_store(self):
1126-
return DSSFeatureStore(self)
1126+
"""
1127+
Get a handle to interact with the Feature Store.
11271128
1129+
:return: a handle on the feature store
1130+
:rtype: :class:`dataikuapi.feature_store.DSSFeatureStore`
1131+
"""
1132+
return DSSFeatureStore(self)
11281133

11291134

11301135
class TemporaryImportHandle(object):

0 commit comments

Comments
 (0)