added documentation and test data

Author: prasankh

docs/source/user_guide/operators/recommender/index.rst

@@ -0,0 +1,50 @@
+===
+Recommender
+===
+
+The Recommender Operator utilizes advanced algorithms to provide personalized recommendations based on user behavior and preferences. This operator streamlines the data science workflow by automating the process of selecting the best recommendation algorithms, tuning hyperparameters, and extracting relevant features, ensuring that users receive the most relevant and effective suggestions for their needs.
+
+Overview
+--------
+
+The Recommender Operator is a powerful tool designed to facilitate the creation and deployment of recommendation systems. This operator utilizes three essential input files: `items`, `users`, and `interaction`, along with specific configuration parameters to generate personalized recommendations.
+
+**Input Files**
+
+1. **Items File**: Contains information about the items that can be recommended. Each entry in this file represents an individual item and includes attributes that describe the item.
+
+2. **Users File**: Contains information about the users for whom recommendations will be generated. Each entry in this file represents an individual user and includes attributes that describe the user.
+
+3. **Interaction File**: Contains historical interaction data between users and items. Each entry in this file represents an interaction (e.g., a user viewing, purchasing, or rating an item) and includes relevant details about the interaction.
+
+**Configuration Parameters**
+
+The Recommender Operator requires the following parameters to trigger the recommendation job:
+
+- **top_k**: Specifies the number of top recommendations to be generated for each user.
+- **user_column**: Identifies the column in the users file that uniquely represents each user.
+- **item_column**: Identifies the column in the items file that uniquely represents each item.
+- **interaction_column**: Identifies the column in the interaction file that details the interactions between users and items.
+
+**Functionality**
+
+Upon execution, the Recommender Operator processes the provided input files and configuration parameters to generate a list of top-k recommended items for each user. It leverages sophisticated algorithms that analyze the historical interaction data to understand user preferences and predict the items they are most likely to engage with in the future.
+
+**Use Cases**
+
+This operator is ideal for a variety of applications, including:
+
+- **E-commerce**: Recommending products to users based on their browsing and purchase history.
+- **Streaming Services**: Suggesting movies, TV shows, or music based on user viewing or listening habits.
+- **Content Platforms**: Proposing articles, blogs, or news stories tailored to user interests.
+
+**Recommender Documentation**
+
+This documentation will delve into these concepts comprehensively, showcasing how to utilize the versatility and adaptability of the recommender operator within the Python library module to build recommendation systems.
+
+.. versionadded:: 2.11.14
+
+.. toctree::
+  :maxdepth: 1
+
+  ./quickstart

docs/source/user_guide/operators/recommender/quickstart.rst

@@ -0,0 +1,69 @@
+===========
+Quick Start
+===========
+
+Install
+--------
+
+Install ads using pip (shown below) or OCI Conda Packs
+
+.. code-block:: bash
+
+    python3 -m pip install "oracle_ads"
+
+Initialize
+----------
+
+Initialize your recommender job through the ads cli command:
+
+.. code-block:: bash
+
+   ads operator init -t recommender
+
+
+Input Data
+-----------
+
+Within the ``recommender`` folder created above there will be a ``recommender.yaml`` file. This file should be updated to contain the details about your data and recommender.
+
+.. code-block:: bash
+
+   cd recommender
+   vi recommender.yaml
+
+.. code-block:: yaml
+
+    kind: operator
+    type: recommendation
+    version: v1
+    spec:
+      user_data:
+        url: users.csv
+      item_data:
+        url: items.csv
+      interactions_data:
+        url: interactions.csv
+      top_k: 4
+      user_column: user_id
+      item_column: movie_id
+      interaction_column: rating
+
+
+Run
+---
+
+Now run the recommender job locally:
+
+.. code-block:: bash
+
+    ads operator run -f recommender.yaml
+
+
+Results
+-------
+
+If not specified in the YAML, all results will be placed in a new folder called ``results``. Performance is summarized in the ``report.html`` file.
+
+.. code-block:: bash
+
+    open results/report.html