Skip to content

Commit 935ab5c

Browse files
KshitizLohiaKshitizLohia
committed
added docs by lorna
1 parent 1ec5922 commit 935ab5c

17 files changed

+2321
-2329
lines changed

‎ads/feature_store/docs/source/dataset.rst

Lines changed: 343 additions & 349 deletions
Large diffs are not rendered by default.

‎ads/feature_store/docs/source/dataset_job.rst

Lines changed: 78 additions & 81 deletions
Original file line numberDiff line numberDiff line change
@@ -1,81 +1,78 @@
1-
.. _Dataset Job:
2-
3-
Dataset Job
4-
***********
5-
6-
Dataset job is the execution instance of a dataset. Each dataset job will include validation results and statistics results.
7-
8-
Define
9-
======
10-
11-
In an ADS feature store module, you can either use the Python API or YAML to define a dataset job.
12-
13-
14-
With the specified way below, you can define a dataset_job and give it a name.
15-
A ``DatasetJob`` instance will be created.
16-
17-
.. tabs::
18-
19-
.. code-tab:: Python3
20-
:caption: Python
21-
22-
from ads.feature_store.dataset_job import DatasetJob
23-
24-
dataset_job = (
25-
DatasetJob
26-
.with_name("<dataset_job_name>")
27-
.with_feature_store_id("<feature_store_id>")
28-
.with_description("<dataset_job_description>")
29-
.with_compartment_id("<compartment_id>")
30-
)
31-
32-
.. code-tab:: Python3
33-
:caption: YAML
34-
35-
from ads.feature_store.dataset_job import DatasetJob
36-
37-
yaml_string = """
38-
kind: dataset_job
39-
spec:
40-
compartmentId: ocid1.compartment..<unique_id>
41-
description: <dataset_job_description>
42-
name: <dataset_job_name>
43-
featureStoreId: <feature_store_id>
44-
type: dataset_job
45-
"""
46-
47-
dataset_job = DatasetJob.from_yaml(yaml_string)
48-
49-
50-
Create
51-
======
52-
53-
You can call the ``create()`` method of the ``DatasetJob`` instance to create an dataset job.
54-
55-
.. code-block:: python3
56-
57-
# Create an dataset_job
58-
dataset_job.create()
59-
60-
61-
Load
62-
====
63-
64-
Use the ``from_id()`` method from the ``DatasetJob`` class to load an existing dataset job with its OCID provided. It returns a ``DatasetJob`` instance.
65-
66-
.. code-block:: python3
67-
68-
from ads.feature_store.dataset_job import DatasetJob
69-
70-
dataset_job = DatasetJob.from_id("ocid1.dataset_job..<unique_id>")
71-
72-
Delete
73-
======
74-
75-
Use the ``.delete()`` method on the ``DatasetJob`` instance to delete a dataset job.
76-
77-
A dataset_job can only be deleted when its associated entities are all deleted,
78-
79-
.. code-block:: python3
80-
81-
dataset_job.delete()
1+
.. _Dataset Job:
2+
3+
Dataset Job
4+
***********
5+
6+
A dDataset job is the processing instance of a dataset. Each dataset job includes validation and statistics results.
7+
8+
Define
9+
======
10+
11+
In an ADS feature store module, you can use the Python API or a yaml file to define a dataset job.
12+
13+
14+
The following example defines a dataset job and gives it a name. A ``DatasetJob`` instance is created.
15+
16+
.. tabs::
17+
18+
.. code-tab:: Python3
19+
:caption: Python
20+
21+
from ads.feature_store.dataset_job import DatasetJob
22+
23+
dataset_job = (
24+
DatasetJob
25+
.with_name("<dataset_job_name>")
26+
.with_feature_store_id("<feature_store_id>")
27+
.with_description("<dataset_job_description>")
28+
.with_compartment_id("<compartment_id>")
29+
)
30+
31+
.. code-tab:: Python3
32+
:caption: YAML
33+
34+
from ads.feature_store.dataset_job import DatasetJob
35+
36+
yaml_string = """
37+
kind: dataset_job
38+
spec:
39+
compartmentId: ocid1.compartment..<unique_id>
40+
description: <dataset_job_description>
41+
name: <dataset_job_name>
42+
featureStoreId: <feature_store_id>
43+
type: dataset_job
44+
"""
45+
46+
dataset_job = DatasetJob.from_yaml(yaml_string)
47+
48+
49+
Create
50+
======
51+
52+
Use the ``create()`` method of the ``DatasetJob`` instance to create a dataset job.
53+
54+
.. code-block:: python3
55+
56+
# Create an dataset_job
57+
dataset_job.create()
58+
59+
60+
Load
61+
====
62+
63+
Use the ``from_id()`` method from the ``DatasetJob`` class to load an existing dataset job by specifying its OCID. A``DatasetJob`` instance is returned.
64+
65+
.. code-block:: python3
66+
67+
from ads.feature_store.dataset_job import DatasetJob
68+
69+
dataset_job = DatasetJob.from_id("<unique_id>")
70+
71+
Delete
72+
======
73+
74+
Use the ``.delete()`` method on the ``DatasetJob`` instance to delete a dataset job. A dataset_job can only be deleted when its associated entities are all deleted,
75+
76+
.. code-block:: python3
77+
78+
dataset_job.delete()

‎ads/feature_store/docs/source/demo.rst

Lines changed: 41 additions & 41 deletions
Original file line numberDiff line numberDiff line change
@@ -1,41 +1,41 @@
1-
======
2-
Demos
3-
======
4-
5-
.. admonition:: Examples
6-
:class: note
7-
8-
.. list-table::
9-
:widths: 50 50
10-
:header-rows: 1
11-
12-
* - Demo
13-
- Description
14-
15-
* - `Feature store overview <https://objectstorage.us-ashburn-1.oraclecloud.com/p/hh2NOgFJbVSg4amcLM3G3hkTuHyBD-8aE_iCsuZKEvIav1Wlld-3zfCawG4ycQGN/n/ociodscdev/b/oci-feature-store/o/beta/demos/feature-store-overview.mp4>`__
16-
- | 1. More about `conda environment <https://docs.oracle.com/en-us/iaas/data-science/using/conda_understand_environments.htm">`__
17-
| 2. Feature store overview using flights data
18-
| 3. UI exploration of feature store
19-
20-
* - `Querying feature store using pandas like interface <https://objectstorage.us-ashburn-1.oraclecloud.com/p/hh2NOgFJbVSg4amcLM3G3hkTuHyBD-8aE_iCsuZKEvIav1Wlld-3zfCawG4ycQGN/n/ociodscdev/b/oci-feature-store/o/beta/demos/feature-store-query-interface.mp4>`__
21-
- | 1. More about `conda environment <https://docs.oracle.com/en-us/iaas/data-science/using/conda_understand_environments.htm">`__
22-
| 2. Pandas like interface for feature store
23-
| 3. Querying for complex SQL queries
24-
| 4. Validation of query syntax
25-
26-
* - `UI exploration for feature store <https://objectstorage.us-ashburn-1.oraclecloud.com/p/hh2NOgFJbVSg4amcLM3G3hkTuHyBD-8aE_iCsuZKEvIav1Wlld-3zfCawG4ycQGN/n/ociodscdev/b/oci-feature-store/o/beta/demos/ui-interface.mp4>`__
27-
- | 1. More about `conda environment <https://docs.oracle.com/en-us/iaas/data-science/using/conda_understand_environments.htm">`__
28-
| 2. UI exploration of feature store, feature groups and dataset
29-
30-
* - `Feature Store Stats and Validation <https://objectstorage.us-ashburn-1.oraclecloud.com/p/hh2NOgFJbVSg4amcLM3G3hkTuHyBD-8aE_iCsuZKEvIav1Wlld-3zfCawG4ycQGN/n/ociodscdev/b/oci-feature-store/o/beta/demos/feature-store-stats-validation.mp4>`__
31-
- | 1. More about `conda environment <https://docs.oracle.com/en-us/iaas/data-science/using/conda_understand_environments.htm">`__
32-
| 2. Feature Store Statistics and Validation
33-
34-
* - | 1. `Deploy feature store stack using terraform for admin users <https://objectstorage.us-ashburn-1.oraclecloud.com/p/hh2NOgFJbVSg4amcLM3G3hkTuHyBD-8aE_iCsuZKEvIav1Wlld-3zfCawG4ycQGN/n/ociodscdev/b/oci-feature-store/o/beta/demos/feature-store-admin-deployment.mp4>`__
35-
| 2. `Deploy feature store stack using terraform for non admin users <https://objectstorage.us-ashburn-1.oraclecloud.com/p/hh2NOgFJbVSg4amcLM3G3hkTuHyBD-8aE_iCsuZKEvIav1Wlld-3zfCawG4ycQGN/n/ociodscdev/b/oci-feature-store/o/beta/demos/feature-store-non-admin-deployment.mp4>`__
36-
| 3. `Deploy feature store stack using terraform BYODB ATP instance <https://objectstorage.us-ashburn-1.oraclecloud.com/p/hh2NOgFJbVSg4amcLM3G3hkTuHyBD-8aE_iCsuZKEvIav1Wlld-3zfCawG4ycQGN/n/ociodscdev/b/oci-feature-store/o/beta/demos/feature-store-byodb-atp.mp4>`__
37-
| 4. `Deploy feature store stack using terraform BYODB MySQL instance <https://objectstorage.us-ashburn-1.oraclecloud.com/p/hh2NOgFJbVSg4amcLM3G3hkTuHyBD-8aE_iCsuZKEvIav1Wlld-3zfCawG4ycQGN/n/ociodscdev/b/oci-feature-store/o/beta/demos/feature-store-byodb-mysql.mp4>`__
38-
- | 1. Setting up feature store using terraform stack for admin user
39-
| 2. Setting up feature store using terraform stack for non admin user
40-
| 3. Setting up feature store using terraform stack using customer ATP instance
41-
| 4. Setting up feature store using terraform stack MySQL instance
1+
======
2+
Demos
3+
======
4+
5+
.. admonition:: Examples
6+
:class: note
7+
8+
.. list-table::
9+
:widths: 50 50
10+
:header-rows: 1
11+
12+
* - Demo
13+
- Description
14+
15+
* - `Feature Store Overview <https://objectstorage.us-ashburn-1.oraclecloud.com/p/hh2NOgFJbVSg4amcLM3G3hkTuHyBD-8aE_iCsuZKEvIav1Wlld-3zfCawG4ycQGN/n/ociodscdev/b/oci-feature-store/o/beta/demos/feature-store-overview.mp4>`__.
16+
- | 1. More about `conda environments <https://docs.oracle.com/en-us/iaas/data-science/using/conda_understand_environments.htm">`__
17+
| 2. Feature store overview using flights data.
18+
| 3. UI exploration of feature store.
19+
20+
* - `Querying Feature Store Using Pandas Like Interface <https://objectstorage.us-ashburn-1.oraclecloud.com/p/hh2NOgFJbVSg4amcLM3G3hkTuHyBD-8aE_iCsuZKEvIav1Wlld-3zfCawG4ycQGN/n/ociodscdev/b/oci-feature-store/o/beta/demos/feature-store-query-interface.mp4>`__.
21+
- | 1. More about `conda environments <https://docs.oracle.com/en-us/iaas/data-science/using/conda_understand_environments.htm">`__.
22+
| 2. Pandas like interface for feature store.
23+
| 3. Querying for complex SQL queries.
24+
| 4. Validation of query syntax.
25+
26+
* - `UI Exploration for Feature Store <https://objectstorage.us-ashburn-1.oraclecloud.com/p/hh2NOgFJbVSg4amcLM3G3hkTuHyBD-8aE_iCsuZKEvIav1Wlld-3zfCawG4ycQGN/n/ociodscdev/b/oci-feature-store/o/beta/demos/ui-interface.mp4>`__.
27+
- | 1. More about `conda environments <https://docs.oracle.com/en-us/iaas/data-science/using/conda_understand_environments.htm">`__.
28+
| 2. UI exploration of feature store, feature groups, and datasets.
29+
30+
* - `Feature Store Statistics and Validation <https://objectstorage.us-ashburn-1.oraclecloud.com/p/hh2NOgFJbVSg4amcLM3G3hkTuHyBD-8aE_iCsuZKEvIav1Wlld-3zfCawG4ycQGN/n/ociodscdev/b/oci-feature-store/o/beta/demos/feature-store-stats-validation.mp4>`__.
31+
- | 1. More about `conda environmenst <https://docs.oracle.com/en-us/iaas/data-science/using/conda_understand_environments.htm">`__.
32+
| 2. Feature store statistics and validation.
33+
34+
* - | 1. `Deploy feature store stack using terraform for admin users <https://objectstorage.us-ashburn-1.oraclecloud.com/p/hh2NOgFJbVSg4amcLM3G3hkTuHyBD-8aE_iCsuZKEvIav1Wlld-3zfCawG4ycQGN/n/ociodscdev/b/oci-feature-store/o/beta/demos/feature-store-admin-deployment.mp4>`__
35+
| 2. `Deploy feature store stack using terraform for non admin users <https://objectstorage.us-ashburn-1.oraclecloud.com/p/hh2NOgFJbVSg4amcLM3G3hkTuHyBD-8aE_iCsuZKEvIav1Wlld-3zfCawG4ycQGN/n/ociodscdev/b/oci-feature-store/o/beta/demos/feature-store-non-admin-deployment.mp4>`__
36+
| 3. `Deploy feature store stack using terraform BYODB ATP instance <https://objectstorage.us-ashburn-1.oraclecloud.com/p/hh2NOgFJbVSg4amcLM3G3hkTuHyBD-8aE_iCsuZKEvIav1Wlld-3zfCawG4ycQGN/n/ociodscdev/b/oci-feature-store/o/beta/demos/feature-store-byodb-atp.mp4>`__
37+
| 4. `Deploy feature store stack using terraform BYODB MySQL instance <https://objectstorage.us-ashburn-1.oraclecloud.com/p/hh2NOgFJbVSg4amcLM3G3hkTuHyBD-8aE_iCsuZKEvIav1Wlld-3zfCawG4ycQGN/n/ociodscdev/b/oci-feature-store/o/beta/demos/feature-store-byodb-mysql.mp4>`__
38+
- | 1. Setting up feature store using terraform stack for administration user.
39+
| 2. Setting up feature store using terraform stack for non-administration user.
40+
| 3. Setting up feature store using terraform stack using an ATP instance.
41+
| 4. Setting up feature store using terraform stack using a MySQL instance.

0 commit comments

Comments
 (0)