documentation fix

Author: KshitizLohia

ads/feature_store/dataset.py

@@ -422,8 +422,8 @@ def with_expectation_suite(
 
         Returns
         -------
-        Pipeline
-            The Expectation instance (self).
+        Dataset
+            The Dataset instance (self).
         """
         return self.set_spec(
             self.CONST_EXPECTATION_DETAILS,

ads/feature_store/docs/source/feature_store_class.rst

@@ -1,19 +1,30 @@
 feature_store package
-=====================
+*********************
 
-Subpackages
------------
+Submodules
+==========
 
-.. toctree::
-   :maxdepth: 4
+ads.feature_store.query package
+###############################
 
-   ads.feature_store.query
+.. automodule:: ads.feature_store.query.filter
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+.. automodule:: ads.feature_store.query.join
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+.. automodule:: ads.feature_store.query.query
+   :members:
+   :undoc-members:
+   :show-inheritance:
 
-Submodules
-----------
 
 ads.feature_store package
--------------------------
+#########################
 .. automodule:: ads.feature_store.dataset
    :members:
    :undoc-members:
@@ -88,3 +99,25 @@ ads.feature_store package
    :members:
    :undoc-members:
    :show-inheritance:
+
+
+ads.feature_store.statistics package
+####################################
+
+.. automodule:: ads.feature_store.statistics.statistics
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+ads.feature_store.common package
+################################
+
+.. automodule:: ads.feature_store.common.enums
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+.. automodule:: ads.feature_store.common.spark_session_singleton
+   :members:
+   :undoc-members:
+   :show-inheritance:

ads/feature_store/docs/source/module.rst

@@ -3,65 +3,6 @@ Class Documentation
 ===================
 
 .. toctree::
-   :maxdepth: 2
+   :maxdepth: 3
 
    feature_store_class
-
-ads.feature_store package
-=========================
-
-.. automodule:: ads.feature_store.feature_group
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
-.. automodule:: ads.feature_store.feature_group_job
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
-.. automodule:: ads.feature_store.dataset
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
-.. automodule:: ads.feature_store.dataset_job
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
-.. automodule:: ads.feature_store.transformation
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
-.. automodule:: ads.feature_store.statistics_config
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
-.. automodule:: ads.feature_store.model_details
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
-.. automodule:: ads.feature_store.input_feature_detail
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
-.. automodule:: ads.feature_store.feature
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
-.. automodule:: ads.feature_store.entity
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
-
-.. automodule:: ads.feature_store.feature_group_expectation
-   :members:
-   :undoc-members:
-   :show-inheritance:

ads/feature_store/docs/source/user_guides.setup.feature_store_operator.rst

@@ -24,8 +24,10 @@ After having set up ads opctl on your desired machine using ads opctl configure,
 
 - The path to the OCIR repository where Feature Store container images are cloned.
 - The compartment ID where Feature Store is set up.
+
 .. seealso::
    :ref:`Database configuration`
+
 - The app name to use for Helm.
 - The namespace to use in the Kubernetes cluster.
 - The version of the Feature Store stack to install.

ads/feature_store/entity.py

@@ -194,7 +194,7 @@ def with_name(self, name: str) -> "Entity":
 
         Returns
         -------
-        FeatureStore
+        Entity
             The Entity instance (self)
         """
         return self.set_spec(self.CONST_NAME, name)
@@ -224,7 +224,7 @@ def with_description(self, description: str) -> "Entity":
 
         Returns
         -------
-        FeatureStore
+        Entity
             The Entity instance (self)
         """
         return self.set_spec(self.CONST_DESCRIPTION, description)
@@ -240,7 +240,7 @@ def from_id(cls, id: str) -> "Entity":
 
         Returns
         -------
-        FeatureStore
+        Entity
             An instance of Entity resource.
         """
         return cls()._update_from_oci_fs_entity_model(OCIEntity.from_id(id))
@@ -256,7 +256,7 @@ def create(self, **kwargs) -> "Entity":
 
         Returns
         -------
-        FeatureStore
+        Entity
             The Entity instance (self)
 
         Raises

ads/feature_store/feature_group.py

@@ -965,10 +965,7 @@ def materialise_stream(
             timeout: Only relevant in combination with `await_termination=True`.
                 Defaults to `None`.
             checkpoint_dir: Checkpoint directory location. This will be used to as a reference to
-                from where to resume the streaming job. If `None` then hsfs will construct as
-                "insert_stream_" + online_topic_name. Defaults to `None`.
-                write_options: Additional write options for Spark as key-value pairs.
-                Defaults to `{}`.
+                from where to resume the streaming job.
 
         # Returns
             `StreamingQuery`: Spark Structured Streaming Query object.