oracle-ads 2.11.14__py3-none-any.whl → 2.11.16__py3-none-any.whl

ads/opctl/operator/lowcode/recommender/model/svd.py

@@ -0,0 +1,88 @@
+#!/usr/bin/env python
+# -*- coding: utf-8 -*--
+from typing import Tuple, Dict, Any
+
+# Copyright (c) 2023, 2024 Oracle and/or its affiliates.
+# Licensed under the Universal Permissive License v 1.0 as shown at https://oss.oracle.com/licenses/upl/
+
+import pandas as pd
+from pandas import DataFrame
+
+from .recommender_dataset import RecommenderDatasets
+from ..operator_config import RecommenderOperatorConfig
+from .factory import RecommenderOperatorBaseModel
+from surprise import Dataset, Reader
+from surprise.model_selection import train_test_split
+from surprise import SVD
+from surprise.accuracy import rmse, mae
+import report_creator as rc
+from ..constant import SupportedMetrics
+
+
+class SVDOperatorModel(RecommenderOperatorBaseModel):
+    """Class representing scikit surprise SVD operator model."""
+
+    def __init__(self, config: RecommenderOperatorConfig, datasets: RecommenderDatasets):
+        super().__init__(config, datasets)
+        self.interactions = datasets.interactions
+        self.users = datasets.users
+        self.items = datasets.items
+        self.user_id = config.spec.user_column
+        self.item_id = config.spec.item_column
+        self.interaction_column = config.spec.interaction_column
+        self.test_size = 0.2
+        self.algo = SVD()
+
+    def _get_recommendations(self, user_id, n):
+        all_item_ids = self.items[self.item_id].unique()
+        rated_items = self.interactions[self.interactions[self.user_id] == user_id][self.item_id]
+        unrated_items = [item_id for item_id in all_item_ids if item_id not in rated_items.values]
+        predictions = [self.algo.predict(user_id, item_id) for item_id in unrated_items]
+        predictions.sort(key=lambda x: x.est, reverse=True)
+        top_n_recommendations = predictions[:n]
+        return [(pred.iid, pred.est) for pred in top_n_recommendations]
+
+    def _build_model(self) -> Tuple[DataFrame, Dict]:
+        min_rating = self.interactions[self.interaction_column].min()
+        max_rating = self.interactions[self.interaction_column].max()
+        reader = Reader(rating_scale=(min_rating, max_rating))
+        data = Dataset.load_from_df(self.interactions[[self.user_id, self.item_id, self.interaction_column]], reader)
+        trainset, testset = train_test_split(data, test_size=self.test_size)
+        self.algo.fit(trainset)
+        predictions = self.algo.test(testset)
+
+        metric = {}
+        metric[SupportedMetrics.RMSE] = rmse(predictions, verbose=True)
+        metric[SupportedMetrics.MAE] = mae(predictions, verbose=True)
+        all_recommendations = []
+        for user_id in self.users[self.user_id]:
+            recommendations = self._get_recommendations(user_id, n=self.spec.top_k)
+            for item_id, est_rating in recommendations:
+                all_recommendations.append({
+                    self.user_id: user_id,
+                    self.item_id: item_id,
+                    self.interaction_column: est_rating
+                })
+        recommendations_df = pd.DataFrame(all_recommendations)
+        return recommendations_df, metric
+
+    def _generate_report(self):
+        model_description = """
+            Singular Value Decomposition (SVD) is a matrix factorization technique used in recommendation systems to
+            decompose a user-item interaction matrix into three constituent matrices. These matrices capture the
+            latent factors that explain the observed interactions.
+            """
+        new_user_recommendations = self._get_recommendations("__new_user__", self.spec.top_k)
+        new_recommendations = []
+        for item_id, est_rating in new_user_recommendations:
+            new_recommendations.append({
+                self.user_id: "__new_user__",
+                self.item_id: item_id,
+                self.interaction_column: est_rating
+            })
+        title = rc.Heading("Recommendations for new users", level=2)
+        other_sections = [title, rc.DataTable(new_recommendations)]
+        return (
+            model_description,
+            other_sections
+        )

ads/opctl/operator/lowcode/recommender/operator_config.py

@@ -0,0 +1,81 @@
+#!/usr/bin/env python
+# -*- coding: utf-8 -*--
+
+# Copyright (c) 2023 Oracle and/or its affiliates.
+# Licensed under the Universal Permissive License v 1.0 as shown at https://oss.oracle.com/licenses/upl/
+
+import os
+from dataclasses import dataclass, field
+
+from ads.common.serializer import DataClassSerializable
+from ads.opctl.operator.common.operator_config import OperatorConfig, InputData
+from ads.opctl.operator.common.utils import _load_yaml_from_uri
+from ads.opctl.operator.lowcode.common.utils import find_output_dirname
+from .constant import SupportedModels
+
+
+@dataclass(repr=True)
+class OutputDirectory(DataClassSerializable):
+    """Class representing operator specification output directory details."""
+
+    url: str = None
+    name: str = None
+
+
+@dataclass(repr=True)
+class RecommenderOperatorSpec(DataClassSerializable):
+    """Class representing Recommender operator specification."""
+
+    user_data: InputData = field(default_factory=InputData)
+    item_data: InputData = field(default_factory=InputData)
+    interactions_data: InputData = field(default_factory=InputData)
+    output_directory: OutputDirectory = field(default_factory=OutputDirectory)
+    top_k: int = None
+    model_name: str = None
+    user_column: str = None
+    item_column: str = None
+    interaction_column: str = None
+    recommendations_filename: str = None
+    generate_report: bool = None
+    report_filename: str = None
+
+
+    def __post_init__(self):
+        """Adjusts the specification details."""
+        self.output_directory = self.output_directory or OutputDirectory(url=find_output_dirname(self.output_directory))
+        self.model_name = self.model_name or SupportedModels.SVD
+        self.recommendations_filename = self.recommendations_filename or "recommendations.csv"
+        # For Report Generation. When user doesn't specify defaults to True
+        self.generate_report = (
+            self.generate_report if self.generate_report is not None else True
+        )
+        self.report_filename = self.report_filename or "report.html"
+
+
+@dataclass(repr=True)
+class RecommenderOperatorConfig(OperatorConfig):
+    """Class representing Recommender operator config.
+
+    Attributes
+    ----------
+    kind: str
+        The kind of the resource. For operators it is always - `operator`.
+    type: str
+        The type of the operator. For Recommender operator it is always - `Recommender`
+    version: str
+        The version of the operator.
+    spec: RecommenderOperatorSpec
+        The Recommender operator specification.
+    """
+
+    kind: str = "operator"
+    type: str = "Recommender"
+    version: str = "v1"
+    spec: RecommenderOperatorSpec = field(default_factory=RecommenderOperatorSpec)
+
+    @classmethod
+    def _load_schema(cls) -> str:
+        """Loads operator schema."""
+        return _load_yaml_from_uri(
+            os.path.join(os.path.dirname(os.path.abspath(__file__)), "schema.yaml")
+        )

ads/opctl/operator/lowcode/recommender/schema.yaml

@@ -0,0 +1,265 @@
+kind:
+  allowed:
+    - operator
+  required: true
+  type: string
+  default: operator
+  meta:
+    description: "Which service are you trying to use? Common kinds: `operator`, `job`"
+
+version:
+  allowed:
+    - "v1"
+  required: true
+  type: string
+  default: v1
+  meta:
+    description: "Operators may change yaml file schemas from version to version, as well as implementation details. Double check the version to ensure compatibility."
+
+type:
+  required: true
+  type: string
+  default: recommender
+  meta:
+    description: "Type should always be `recommender` when using a recommender operator"
+
+
+spec:
+  required: true
+  type: dict
+  schema:
+    user_data:
+      required: true
+      type: dict
+      default: {"url": "user_data.csv"}
+      meta:
+        description: "This should contain user related attribute."
+      schema:
+        connect_args:
+          nullable: true
+          required: false
+          type: dict
+        format:
+          allowed:
+            - csv
+            - json
+            - clipboard
+            - excel
+            - feather
+            - sql_table
+            - sql_query
+            - hdf
+            - tsv
+          required: false
+          type: string
+        columns:
+          required: false
+          type: list
+          schema:
+            type: string
+        filters:
+          required: false
+          type: list
+          schema:
+            type: string
+        options:
+          nullable: true
+          required: false
+          type: dict
+        sql:
+          required: false
+          type: string
+        table_name:
+          required: false
+          type: string
+        url:
+          required: false
+          type: string
+          meta:
+            description: "The url can be local, or remote. For example: `oci://<bucket>@<namespace>/data.csv`"
+        limit:
+          required: false
+          type: integer
+
+    item_data:
+      required: true
+      type: dict
+      default: {"url": "item_data.csv"}
+      meta:
+        description: "This should contain item related attribute"
+      schema:
+        connect_args:
+          nullable: true
+          required: false
+          type: dict
+        format:
+          allowed:
+            - csv
+            - json
+            - clipboard
+            - excel
+            - feather
+            - sql_table
+            - sql_query
+            - hdf
+            - tsv
+          required: false
+          type: string
+        columns:
+          required: false
+          type: list
+          schema:
+            type: string
+        filters:
+          required: false
+          type: list
+          schema:
+            type: string
+        options:
+          nullable: true
+          required: false
+          type: dict
+        sql:
+          required: false
+          type: string
+        table_name:
+          required: false
+          type: string
+        url:
+          required: false
+          type: string
+          meta:
+            description: "The url can be local, or remote. For example: `oci://<bucket>@<namespace>/data.csv`"
+        limit:
+          required: false
+          type: integer
+
+    interactions_data:
+      required: true
+      default: {"url": "interactions_data.csv"}
+      meta:
+        description: "This should include interactions between items and users"
+      schema:
+        connect_args:
+          nullable: true
+          required: false
+          type: dict
+        format:
+          allowed:
+            - csv
+            - json
+            - clipboard
+            - excel
+            - feather
+            - sql_table
+            - sql_query
+            - hdf
+            - tsv
+          required: false
+          type: string
+        columns:
+          required: false
+          type: list
+          schema:
+            type: string
+        filters:
+          required: false
+          type: list
+          schema:
+            type: string
+        options:
+          nullable: true
+          required: false
+          type: dict
+        sql:
+          required: false
+          type: string
+        table_name:
+          required: false
+          type: string
+        url:
+          required: false
+          type: string
+          meta:
+            description: "The url can be local, or remote. For example: `oci://<bucket>@<namespace>/data.csv`"
+        limit:
+          required: false
+          type: integer
+      type: dict
+
+    top_k:
+      required: true
+      type: integer
+      default: 1
+
+    output_directory:
+      required: false
+      schema:
+        connect_args:
+          nullable: true
+          required: false
+          type: dict
+        format:
+          allowed:
+            - csv
+            - json
+            - clipboard
+            - excel
+            - feather
+            - sql_table
+            - sql_query
+            - hdf
+            - tsv
+          required: false
+          type: string
+        columns:
+          required: false
+          type: list
+          schema:
+            type: string
+        filters:
+          required: false
+          type: list
+          schema:
+            type: string
+        options:
+          nullable: true
+          required: false
+          type: dict
+        sql:
+          required: false
+          type: string
+        table_name:
+          required: false
+          type: string
+        url:
+          required: false
+          type: string
+          meta:
+            description: "The url can be local, or remote. For example: `oci://<bucket>@<namespace>/data.csv`"
+        limit:
+          required: false
+          type: integer
+      type: dict
+
+    report_filename:
+      required: false
+      type: string
+      default: report.html
+      meta:
+        description: "Placed into output_directory location. Defaults to report.html"
+
+    user_column:
+      type: string
+      required: true
+      default: "user_id"
+
+    item_column:
+      type: string
+      required: true
+      default: "item_id"
+
+    interaction_column:
+      type: string
+      required: true
+      default: "rating"

ads/opctl/operator/lowcode/recommender/utils.py

@@ -0,0 +1,13 @@
+#!/usr/bin/env python
+# -*- coding: utf-8 -*--
+
+# Copyright (c) 2023, 2024 Oracle and/or its affiliates.
+# Licensed under the Universal Permissive License v 1.0 as shown at https://oss.oracle.com/licenses/upl/
+
+import os
+
+
+def default_signer(**kwargs):
+    os.environ["EXTRA_USER_AGENT_INFO"] = "Recommender-Operator"
+    from ads.common.auth import default_signer
+    return default_signer(**kwargs)

ads/pipeline/ads_pipeline_run.py

@@ -1,7 +1,7 @@
 #!/usr/bin/env python
 # -*- coding: utf-8; -*-
 
-# Copyright (c) 2022, 2023 Oracle and/or its affiliates.
+# Copyright (c) 2022, 2024 Oracle and/or its affiliates.
 # Licensed under the Universal Permissive License v 1.0 as shown at https://oss.oracle.com/licenses/upl/
 import copy
 import logging
@@ -689,6 +689,16 @@ class PipelineRun(
         sources = []
         subjects = []
         skipped_step_list = []
+
+        is_service_logging_enabled = False
+        try:
+            if self.service_logging:
+                is_service_logging_enabled = True
+        except LogNotConfiguredError:
+            logger.warning(
+                "Service log is not configured for pipeline. Streaming custom log."
+            )
+
         for step_run in self.step_runs:
             if not steps or (step_run.step_name in steps):
                 step_name = step_run.step_name
@@ -703,7 +713,8 @@ class PipelineRun(
                         subjects.append(f"subject = '{step_name}'")
                     else:
                         sources.append(f"source = '*{job_run_id}'")
-                        subjects.append(f"subject = '{step_name}'")
+                        if is_service_logging_enabled:
+                            subjects.append(f"subject = '{step_name}'")
                 else:
                     subjects.append(f"subject = '{step_name}'")
 

{oracle_ads-2.11.14.dist-info → oracle_ads-2.11.16.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: oracle_ads
-Version: 2.11.14
+Version: 2.11.16
 Summary: Oracle Accelerated Data Science SDK
 Keywords: Oracle Cloud Infrastructure,OCI,Machine Learning,ML,Artificial Intelligence,AI,Data Science,Cloud,Oracle
 Author: Oracle Data Science
@@ -114,6 +114,10 @@ Requires-Dist: scrubadub_spacy ; extra == "pii"
 Requires-Dist: spacy-transformers==1.2.5 ; extra == "pii"
 Requires-Dist: spacy==3.6.1 ; extra == "pii"
 Requires-Dist: report-creator==1.0.9 ; extra == "pii"
+Requires-Dist: oracle_ads[opctl] ; extra == "recommender"
+Requires-Dist: scikit-surprise ; extra == "recommender"
+Requires-Dist: plotly ; extra == "recommender"
+Requires-Dist: report-creator==1.0.9 ; extra == "recommender"
 Requires-Dist: pyspark>=3.0.0 ; extra == "spark"
 Requires-Dist: oracle_ads[viz] ; extra == "tensorflow"
 Requires-Dist: tensorflow<=2.15.1 ; extra == "tensorflow"
@@ -163,6 +167,7 @@ Provides-Extra: onnx
 Provides-Extra: opctl
 Provides-Extra: optuna
 Provides-Extra: pii
+Provides-Extra: recommender
 Provides-Extra: spark
 Provides-Extra: tensorflow
 Provides-Extra: testsuite