Recommendations_with_IBM.ipynb

{
 "cells": [
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "# Recommendations with IBM\n",
    "\n",
    "In this notebook, you will be putting your recommendation skills to use on real data from the IBM Watson Studio platform. \n",
    "\n",
    "\n",
    "You may either submit your notebook through the workspace here, or you may work from your local machine and submit through the next page.  Either way assure that your code passes the project [RUBRIC](https://review.udacity.com/#!/rubrics/2322/view).  **Please save regularly.**\n",
    "\n",
    "By following the table of contents, you will build out a number of different methods for making recommendations that can be used for different situations. \n",
    "\n",
    "\n",
    "## Table of Contents\n",
    "\n",
    "I. [Exploratory Data Analysis](#Exploratory-Data-Analysis)<br>\n",
    "II. [Rank Based Recommendations](#Rank)<br>\n",
    "III. [User-User Based Collaborative Filtering](#User-User)<br>\n",
    "IV. [Content Based Recommendations (EXTRA - NOT REQUIRED)](#Content-Recs)<br>\n",
    "V. [Matrix Factorization](#Matrix-Fact)<br>\n",
    "VI. [Extras & Concluding](#conclusions)\n",
    "\n",
    "At the end of the notebook, you will find directions for how to submit your work.  Let's get started by importing the necessary libraries and reading in the data."
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "metadata": {},
   "outputs": [],
   "source": [
    "import pandas as pd\n",
    "import numpy as np\n",
    "import matplotlib.pyplot as plt\n",
    "import project_tests as t\n",
    "import pickle\n",
    "\n",
    "#%matplotlib inline"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "metadata": {},
   "outputs": [],
   "source": [
    "df = pd.read_csv('data/user-item-interactions.csv')\n",
    "df_content = pd.read_csv('data/articles_community.csv')\n",
    "del df['Unnamed: 0']\n",
    "del df_content['Unnamed: 0']"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "metadata": {},
   "outputs": [],
   "source": [
    "# Show df to get an idea of the data\n",
    "df.head()"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "metadata": {},
   "outputs": [],
   "source": [
    "# Show df_content to get an idea of the data\n",
    "df_content.head()"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "### <a class=\"anchor\" id=\"Exploratory-Data-Analysis\">Part I : Exploratory Data Analysis</a>\n",
    "\n",
    "Use the dictionary and cells below to provide some insight into the descriptive statistics of the data.\n",
    "\n",
    "`1.` What is the distribution of how many articles a user interacts with in the dataset?  Provide a visual and descriptive statistics to assist with giving a look at the number of times each user interacts with an article.  "
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "metadata": {},
   "outputs": [],
   "source": []
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "metadata": {},
   "outputs": [],
   "source": []
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "metadata": {},
   "outputs": [],
   "source": [
    "# Fill in the median and maximum number of user_article interactios below\n",
    "median_val = # 50% of individuals interact with ____ number of articles or fewer.\n",
    "max_view_by_user = # The maximum number of user-article interactions by any 1 user is ______."
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "`2.` Explore and remove duplicate articles from the **df_content** dataframe.  "
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "metadata": {},
   "outputs": [],
   "source": [
    "# Find and explore duplicate articles"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "metadata": {},
   "outputs": [],
   "source": [
    "# Remove any rows that have the same article_id - only keep the first"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "`3.` Use the cells below to find:\n",
    "\n",
    "**a.** The number of unique articles that have an interaction with a user.  \n",
    "**b.** The number of unique articles in the dataset (whether they have any interactions or not).<br>\n",
    "**c.** The number of unique users in the dataset. (excluding null values) <br>\n",
    "**d.** The number of user-article interactions in the dataset."
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "metadata": {},
   "outputs": [],
   "source": [
    "\n"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "metadata": {},
   "outputs": [],
   "source": [
    "unique_article = # The number of unique articles that have at least one interaction\n",
    "total_article = # The number of unique articles on the IBM platform\n",
    "unique_user = # The number of unique users\n",
    "user_article_interaction = # The number of user-article interactions"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "`4.` Use the cells below to find the most viewed **article_id**, as well as how often it was viewed.  After talking to the company leaders, the `email_mapper` function was deemed a reasonable way to map users to ids.  There were a small number of null values, and it was found that all of these null values likely belonged to a single user (which is how they are stored using the function below)."
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "metadata": {},
   "outputs": [],
   "source": []
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "metadata": {},
   "outputs": [],
   "source": [
    "most_viewed_article_id = # The most viewed article in the dataset as a string with one value following the decimal \n",
    "max_view = # The most viewed article in the dataset was viewed how many times?"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "metadata": {},
   "outputs": [],
   "source": [
    "## No need to change the code here - this will be helpful for later parts of the notebook\n",
    "# Run this cell to map the user email to a user_id column and remove the email column\n",
    "\n",
    "def email_mapper(verbose=False):\n",
    "    '''This function...\n",
    "    \n",
    "    Inputs:\n",
    "      - \n",
    "    Output:\n",
    "    '''\n",
    "    \n",
    "    coded_dict = dict()\n",
    "    cter = 1\n",
    "    email_encoded = []\n",
    "    \n",
    "    for val in df['email']:\n",
    "        if val not in coded_dict:\n",
    "            coded_dict[val] = cter\n",
    "            cter+=1\n",
    "        \n",
    "        email_encoded.append(coded_dict[val])\n",
    "    return email_encoded\n",
    "\n",
    "email_encoded = email_mapper()\n",
    "del df['email']\n",
    "df['user_id'] = email_encoded\n",
    "\n",
    "# show header\n",
    "df.head()"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "metadata": {},
   "outputs": [],
   "source": [
    "## If you stored all your results in the variable names above, \n",
    "## you shouldn't need to change anything in this cell\n",
    "\n",
    "sol_1_dict = {\n",
    "    '`50% of individuals have _____ or fewer interactions.`': median_val,\n",
    "    '`The total number of user-article interactions in the dataset is ______.`': user_article_interactions,\n",
    "    '`The maximum number of user-article interactions by any 1 user is ______.`': max_views_by_user,\n",
    "    '`The most viewed article in the dataset was viewed _____ times.`': max_views,\n",
    "    '`The article_id of the most viewed article is ______.`': most_viewed_article_id,\n",
    "    '`The number of unique articles that have at least 1 rating ______.`': unique_articles,\n",
    "    '`The number of unique users in the dataset is ______`': unique_users,\n",
    "    '`The number of unique articles on the IBM platform`': total_articles\n",
    "}\n",
    "\n",
    "# Test your dictionary against the solution\n",
    "t.sol_1_test(sol_1_dict)"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "### <a class=\"anchor\" id=\"Rank\">Part II: Rank-Based Recommendations</a>\n",
    "\n",
    "Unlike in the earlier lessons, we don't actually have ratings for whether a user liked an article or not.  We only know that a user has interacted with an article.  In these cases, the popularity of an article can really only be based on how often an article was interacted with.\n",
    "\n",
    "`1.` Fill in the function below to return the **n** top articles ordered with most interactions as the top. Test your function using the tests below."
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "metadata": {},
   "outputs": [],
   "source": [
    "#########1#########2#########3#########4#########5#########6#########7#########8\n",
    "def fn_get_top_articles(n, \n",
    "                        df=df, \n",
    "                        verbose=False):\n",
    "    '''This function...\n",
    "    \n",
    "    Inputs:\n",
    "      - n - (int) the number of top articles to return\n",
    "      - df - (pandas dataframe) df as defined at the top of the notebook\n",
    "      - verbose (optional) - if you want some verbosity in your function -\n",
    "        (Boolean, default=False)\n",
    "    Output:\n",
    "      - top_articles - (list) A list of the top 'n' article titles \n",
    "    '''\n",
    "    if verbose:\n",
    "        print('###function get top articles started')        \n",
    "    start = time()\n",
    "    \n",
    "    #code\n",
    "    \n",
    "    end = time()\n",
    "    if verbose:\n",
    "        print('elapsed time: {:.6f}s'.format(end-begin))\n",
    "    \n",
    "    return top_articles # Return the top article titles from df (not df_content)"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "metadata": {},
   "outputs": [],
   "source": [
    "#########1#########2#########3#########4#########5#########6#########7#########8\n",
    "def fn_get_top_article_ids(n, \n",
    "                           df=df,\n",
    "                           verbose=False):\n",
    "    '''This function...\n",
    "    \n",
    "    Inputs:\n",
    "      - n (mandatory) - (int) the number of top articles to return\n",
    "      - df (mandatory) - (pandas dataframe) df as defined at the top of the notebook\n",
    "      - verbose (optional) - if you want some verbosity in your function -\n",
    "        (Boolean, default=False)\n",
    "    Output:\n",
    "      - top_article - (list) A list of the top 'n' article titles\n",
    "    '''\n",
    "    if verbose:\n",
    "        print('###function get top articles started')        \n",
    "    start = time()\n",
    "\n",
    "    # Your code here\n",
    "    \n",
    "    end = time()\n",
    "    if verbose:\n",
    "        print('elapsed time: {:.6f}s'.format(end-begin))\n",
    " \n",
    "    return top_article # Return the top article ids"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "metadata": {},
   "outputs": [],
   "source": [
    "print(fn_get_top_article(10))\n",
    "print(fn_get_top_article_id(10))"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "metadata": {},
   "outputs": [],
   "source": [
    "# Test your function by returning the top 5, 10, and 20 articles\n",
    "top_5 = fn_get_top_article(5)\n",
    "top_10 = fn_get_top_article(10)\n",
    "top_20 = fn_get_top_article(20)\n",
    "\n",
    "# Test each of your three lists from above\n",
    "t.sol_2_test(fn_get_top_article)"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "### <a class=\"anchor\" id=\"User-User\">Part III: User-User Based Collaborative Filtering</a>\n",
    "\n",
    "\n",
    "`1.` Use the function below to reformat the **df** dataframe to be shaped with users as the rows and articles as the columns.  \n",
    "\n",
    "* Each **user** should only appear in each **row** once.\n",
    "\n",
    "\n",
    "* Each **article** should only show up in one **column**.  \n",
    "\n",
    "\n",
    "* **If a user has interacted with an article, then place a 1 where the user-row meets for that article-column**.  It does not matter how many times a user has interacted with the article, all entries where a user has interacted with an article should be a 1.  \n",
    "\n",
    "\n",
    "* **If a user has not interacted with an item, then place a zero where the user-row meets for that article-column**. \n",
    "\n",
    "Use the tests to make sure the basic structure of your matrix matches what is expected by the solution."
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "metadata": {},
   "outputs": [],
   "source": [
    "#########1#########2#########3#########4#########5#########6#########7#########8\n",
    "def fn_create_user_item_matrix(df,\n",
    "                               verbose=True):\n",
    "    '''This function returns a matrix with user ids as rows and article ids on \n",
    "    the columns with 1 values where a user interacted with \n",
    "    an article and a 0 otherwise # create the user-article matrix with 1's and 0's\n",
    "    \n",
    "    Inputs:\n",
    "      - df (mandatory) - pandas dataframe with article_id, title, user_id columns\n",
    "      - verbose (optional) - if you want some verbosity in your function -\n",
    "        (Boolean, default=False)\n",
    "    Output:\n",
    "      - user_item - user item matrix \n",
    "    '''\n",
    "    if verbose:\n",
    "        print('###function create user item matrix started')\n",
    "        \n",
    "    start = time()\n",
    "\n",
    "    # Fill in the function here\n",
    "    \n",
    "    end = time()\n",
    "    \n",
    "    if verbose:\n",
    "        print('elapsed time: {:.4f}s'.format(end-begin))\n",
    "\n",
    "    \n",
    "    return user_item # return the user_item matrix"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "metadata": {},
   "outputs": [],
   "source": [
    "user_item = create_user_item_matrix(df)"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "metadata": {},
   "outputs": [],
   "source": [
    "## Tests: You should just need to run this cell.  Don't change the code.\n",
    "assert user_item.shape[0] == 5149, \"Oops!  The number of users in the user-article matrix doesn't look right.\"\n",
    "assert user_item.shape[1] == 714, \"Oops!  The number of articles in the user-article matrix doesn't look right.\"\n",
    "assert user_item.sum(axis=1)[1] == 36, \"Oops!  The number of articles seen by user 1 doesn't look right.\"\n",
    "print(\"You have passed our quick tests!  Please proceed!\")"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "`2.` Complete the function below which should take a user_id and provide an ordered list of the most similar users to that user (from most similar to least similar).  The returned result should not contain the provided user_id, as we know that each user is similar to him/herself. Because the results for each user here are binary, it (perhaps) makes sense to compute similarity as the dot product of two users. \n",
    "\n",
    "Use the tests to test your function."
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "metadata": {},
   "outputs": [],
   "source": [
    "#########1#########2#########3#########4#########5#########6#########7#########8\n",
    "def fn_find_similar_user(user_id, \n",
    "                         user_item=user_item,\n",
    "                         verbose=False):\n",
    "    '''This function...Computes the similarity of every pair of users based on the dot product\n",
    "    Returns an ordered\n",
    "    \n",
    "    Inputs:\n",
    "      - user_id (mandatory) - (int) a user_id\n",
    "      - user_item (mandatory) - (pandas dataframe) matrix of users by articles: \n",
    "                1's when a user has interacted with an article, 0 otherwise\n",
    "    Output:\n",
    "      - similar_user - (list) an ordered list where the closest users (largest dot product users)\n",
    "        are listed first\n",
    "    '''\n",
    "    if verbose:\n",
    "        print('###function find similar users started')        \n",
    "    start = time()\n",
    "\n",
    "    # compute similarity of each user to the provided user\n",
    "\n",
    "    # sort by similarity\n",
    "\n",
    "    # create list of just the ids\n",
    "   \n",
    "    # remove the own user's id\n",
    "    \n",
    "    end = time()\n",
    "    if verbose:\n",
    "        print('elapsed time: {:.4f}s'.format(end-begin))\n",
    "\n",
    "    return most_similar_user # return a list of the users in order from most to least similar   "
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "metadata": {},
   "outputs": [],
   "source": [
    "# Do a spot check of your function\n",
    "print(\"The 10 most similar users to user 1 are: {}\".format(fn_find_similar_user(1)[:10]))\n",
    "print(\"The 5 most similar users to user 3933 are: {}\".format(fn_find_similar_user(3933)[:5]))\n",
    "print(\"The 3 most similar users to user 46 are: {}\".format(fn_find_similar_user(46)[:3]))"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "`3.` Now that you have a function that provides the most similar users to each user, you will want to use these users to find articles you can recommend.  Complete the functions below to return the articles you would recommend to each user. "
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "metadata": {},
   "outputs": [],
   "source": [
    "#########1#########2#########3#########4#########5#########6#########7#########8\n",
    "def get_article_name(article_id, \n",
    "                     df=df,\n",
    "                     verbose=False):\n",
    "    '''This function...\n",
    "    \n",
    "    Inputs:\n",
    "      - article_ids (mandatory) - (list) a list of article ids\n",
    "      - df (mandatory) - (pandas dataframe) df as defined at the top of the notebook\n",
    "      - verbose (optional) - if you want some verbosity in your function -\n",
    "        (Boolean, default=False)\n",
    "    Output:\n",
    "      - article_name - (list) a list of article names associated with the list of article ids \n",
    "        (this is identified by the title column)\n",
    "    '''\n",
    "    if verbose:\n",
    "        print('###function power started - works by Trial  & Error')        \n",
    "    start = time()\n",
    "\n",
    "    # Your code here\n",
    "    \n",
    "    end = time()\n",
    "    if verbose:\n",
    "        print('elapsed time: {:.6f}s'.format(end-begin))\n",
    "    \n",
    "    return article_name # Return the article names associated with list of article ids"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "metadata": {},
   "outputs": [],
   "source": [
    "#########1#########2#########3#########4#########5#########6#########7#########8\n",
    "def fn_get_user_article(user_id, \n",
    "                        user_item=user_item,\n",
    "                        verbose=False):\n",
    "    '''This function provides a list of the article_ids and article titles \n",
    "    that have been seen by a user\n",
    "    \n",
    "    Inputs:\n",
    "      - user_id (mandatory) - (int) a user id\n",
    "      - user_item (mandatory) - (pandas dataframe) matrix of users by articles: \n",
    "        1's when a user has interacted with an article, 0 otherwise\n",
    "      - verbose (optional) - if you want some verbosity in your function -\n",
    "        (Boolean, default=False)\n",
    "    Outputs:\n",
    "      - article_id - (list) a list of the article ids seen by the user\n",
    "      - article_name - (list) a list of article names associated with the list of article ids \n",
    "        (this is identified by the doc_full_name column in df_content)    \n",
    "    '''\n",
    "    if verbose:\n",
    "        print('###function power started - works by Trial  & Error')\n",
    "        \n",
    "    start = time()\n",
    "\n",
    "    # Your code here\n",
    "    \n",
    "    output = article_id, article_name # return the ids and names\n",
    "    \n",
    "    end = time()\n",
    "    \n",
    "    if verbose:\n",
    "        print('elapsed time: {:.4f}s'.format(end-begin))\n",
    "    \n",
    "    return output"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "metadata": {},
   "outputs": [],
   "source": [
    "#########1#########2#########3#########4#########5#########6#########7#########8\n",
    "def fn_user_user_rec(user_id, \n",
    "                     m=10,\n",
    "                     verbose=False):\n",
    "    '''This function...\n",
    "    \n",
    "    Inputs:\n",
    "      - user_id (mandatory) - (int) a user id\n",
    "      - m (optional) - (int) the number of recommendations you want for the user\n",
    "      - verbose (optional) - if you want some verbosity in your function -\n",
    "        (Boolean, default=False)\n",
    "      - verbose (optional) - if you want some verbosity in your function -\n",
    "        (Boolean, default=False)\n",
    "    Output:\n",
    "      - rec - (list) a list of recommendations for the user\n",
    "      \n",
    "    Description:\n",
    "      Loops through the users based on closeness to the input user_id\n",
    "      For each user - finds articles the user hasn't seen before and provides them as recs\n",
    "      Does this until m recommendations are found\n",
    "    Notes:\n",
    "      Users who are the same closeness are chosen arbitrarily as the 'next' user\n",
    "      For the user where the number of recommended articles starts below m \n",
    "      and ends exceeding m, the last items are chosen arbitrarily\n",
    "    '''\n",
    "    if verbose:\n",
    "        print('###function power started - works by Trial  & Error')        \n",
    "    start = time()\n",
    "\n",
    "    # Your code here\n",
    "    \n",
    "    if verbose:\n",
    "        print('elapsed time: {:.6f}s'.format(end-begin))\n",
    "    \n",
    "    return rec # return your recommendations for this user_id    "
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "metadata": {},
   "outputs": [],
   "source": [
    "# Check Results\n",
    "fn_get_article_name(user_user_rec(1, 10)) # Return 10 recommendations for user 1"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "metadata": {},
   "outputs": [],
   "source": [
    "# Test your functions here - No need to change this code - just run this cell\n",
    "assert set(fn_get_article_name(['1024.0', '1176.0', '1305.0', '1314.0', '1422.0', '1427.0'])) == set(\n",
    "    ['using deep learning to reconstruct high-resolution audio', \n",
    "     'build a python app on the streaming analytics service', \n",
    "     'gosales transactions for naive bayes model', \n",
    "     'healthcare python streaming application demo', \n",
    "     'use r dataframes & ibm watson natural language understanding', \n",
    "     'use xgboost, scikit-learn & ibm watson machine learning apis']),\\\n",
    "\"Oops! Your the get_article_names function doesn't work quite how we expect.\"\n",
    "assert set(fn_get_article_name(['1320.0', '232.0', '844.0'])) == set(\n",
    "    ['housing (2015): united states demographic measures',\n",
    "     'self-service data preparation with ibm data refinery',\n",
    "     'use the cloudant-spark connector in python notebook']),\\\n",
    "\"Oops! Your the get_article_names function doesn't work quite how we expect.\"\n",
    "assert set(fn_get_user_article(20)[0]) == set(\n",
    "    ['1320.0', '232.0', '844.0'])\n",
    "assert set(fn_get_user_article(20)[1]) == set(\n",
    "    ['housing (2015): united states demographic measures', \n",
    "     'self-service data preparation with ibm data refinery',\n",
    "     'use the cloudant-spark connector in python notebook'])\n",
    "assert set(fn_get_user_article(2)[0]) == set(\n",
    "    ['1024.0', '1176.0', '1305.0', '1314.0', '1422.0', '1427.0'])\n",
    "assert set(fn_get_user_article(2)[1]) == set(\n",
    "    ['using deep learning to reconstruct high-resolution audio',\n",
    "     'build a python app on the streaming analytics service',\n",
    "     'gosales transactions for naive bayes model',\n",
    "     'healthcare python streaming application demo',\n",
    "     'use r dataframes & ibm watson natural language understanding',\n",
    "     'use xgboost, scikit-learn & ibm watson machine learning apis'])\n",
    "print(\"If this is all you see, you passed all of our tests!  Nice job!\")"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "`4.` Now we are going to improve the consistency of the **user_user_recs** function from above.  \n",
    "\n",
    "* Instead of arbitrarily choosing when we obtain users who are all the same closeness to a given user - choose the users that have the most total article interactions before choosing those with fewer article interactions.\n",
    "\n",
    "\n",
    "* Instead of arbitrarily choosing articles from the user where the number of recommended articles starts below m and ends exceeding m, choose articles with the articles with the most total interactions before choosing those with fewer total interactions. This ranking should be  what would be obtained from the **top_articles** function you wrote earlier."
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "metadata": {},
   "outputs": [],
   "source": [
    "#########1#########2#########3#########4#########5#########6#########7#########8\n",
    "def fn_get_top_sorted_users(user_id, \n",
    "                            df=df, \n",
    "                            user_item=user_item,\n",
    "                            verbose=False):\n",
    "    '''This function...\n",
    "    Inputs:\n",
    "      - user_id (mandatory) - (int)\n",
    "      - df (mandatory ) - (pandas dataframe) df as defined at the top of \n",
    "        the notebook \n",
    "      - user_item (mandatory) - (pandas dataframe) matrix of users by articles: \n",
    "        1's when a user has interacted with an article, 0 otherwise  \n",
    "      - verbose (optional) - if you want some verbosity in your function -\n",
    "        (Boolean, default=False)\n",
    "    Output:\n",
    "      - neighbor_df - (pandas dataframe) a dataframe with:\n",
    "        neighbor_id - is a neighbor user_id\n",
    "        similarity - measure of the similarity of each user to the provided user_id\n",
    "        num_interactions - the number of articles viewed by the user - if a u            \n",
    "    Other Details:\n",
    "      - sort the neighbors_df by the similarity and then by number of interactions where \n",
    "        highest of each is higher in the dataframe\n",
    "    '''\n",
    "    if verbose:\n",
    "        print('###function get top sorted users started')\n",
    "        \n",
    "    start = time()\n",
    "\n",
    "    # Your code here\n",
    "    \n",
    "    end = time()\n",
    "    if verbose:\n",
    "        print('elapsed time: {:.4f}s'.format(end-begin))\n",
    "\n",
    "    return neighbor_df # Return the dataframe specified in the doc_string"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "metadata": {},
   "outputs": [],
   "source": [
    "#########1#########2#########3#########4#########5#########6#########7#########8\n",
    "def fn_user_user_rec_part2(user_id, \n",
    "                           m=10,\n",
    "                           verbose=True):\n",
    "    '''This function...\n",
    "    \n",
    "    Inputs:\n",
    "      - user_id (mandatory) - (int) a user id\n",
    "      - m (mandatory) - (int) the number of recommendations you want for the user\n",
    "      - verbose (optional) - if you want some verbosity in your function -\n",
    "        (Boolean, default=False)\n",
    "    Output:\n",
    "      - rec - (list) a list of recommendations for the user by article id\n",
    "      - rec_name - (list) a list of recommendations for the user by article title\n",
    "    Description:\n",
    "      Loops through the users based on closeness to the input user_id\n",
    "      For each user - finds articles the user hasn't seen before and provides them as recs\n",
    "      Does this until m recommendations are found\n",
    "    Notes:\n",
    "    * Choose the users that have the most total article interactions \n",
    "      before choosing those with fewer article interactions.\n",
    "    * Choose articles with the articles with the most total interactions \n",
    "      before choosing those with fewer total interactions. \n",
    "   \n",
    "    '''\n",
    "    if verbose:\n",
    "        print('###function user-user recs part2 started')\n",
    "        \n",
    "    start = time()\n",
    "\n",
    "    # Your code here\n",
    "    \n",
    "    output = rec, rec_name\n",
    "    \n",
    "    end = time()\n",
    "    \n",
    "    if verbose:\n",
    "        print('elapsed time: {:.6f}s'.format(end-begin))\n",
    "\n",
    "    return output"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "metadata": {},
   "outputs": [],
   "source": [
    "# Quick spot check - don't change this code - just use it to test your functions\n",
    "rec_id, rec_name = fn_user_user_rec_part2(20, 10)\n",
    "print(\"The top 10 recommendations for user 20 are the following article ids:\")\n",
    "print(rec_id)\n",
    "print()\n",
    "print(\"The top 10 recommendations for user 20 are the following article names:\")\n",
    "print(rec_name)"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "`5.` Use your functions from above to correctly fill in the solutions to the dictionary below.  Then test your dictionary against the solution.  Provide the code you need to answer each following the comments below."
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "metadata": {},
   "outputs": [],
   "source": [
    "### Tests with a dictionary of results\n",
    "user1_most_sim = # Find the user that is most similar to user 1 \n",
    "user131_10th_sim = # Find the 10th most similar user to user 131"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "metadata": {},
   "outputs": [],
   "source": [
    "## Dictionary Test Here\n",
    "sol_5_dict = {\n",
    "    'The user that is most similar to user 1.': user1_most_sim, \n",
    "    'The user that is the 10th most similar to user 131': user131_10th_sim,\n",
    "}\n",
    "\n",
    "t.sol_5_test(sol_5_dict)"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "`6.` If we were given a new user, which of the above functions would you be able to use to make recommendations?  Explain.  Can you think of a better way we might make recommendations?  Use the cell below to explain a better method for new users."
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "**Provide your response here.**"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "`7.` Using your existing functions, provide the top 10 recommended articles you would provide for the a new user below.  You can test your function against our thoughts to make sure we are all on the same page with how we might make a recommendation."
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "metadata": {},
   "outputs": [],
   "source": [
    "new_user = '0.0'\n",
    "\n",
    "# What would your recommendations be for this new user '0.0'?  As a new user, they have no observed articles.\n",
    "# Provide a list of the top 10 article ids you would give to \n",
    "new_user_rec = # Your recommendations here"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "metadata": {},
   "outputs": [],
   "source": [
    "assert set(new_user_rec) == set(['1314.0','1429.0','1293.0','1427.0','1162.0','1364.0','1304.0','1170.0','1431.0',\n",
    "                                 '1330.0']),\\\n",
    "\"Oops!  It makes sense that in this case we would want to recommend the most popular articles, because we don't know anything about these users.\"\n",
    "\n",
    "print(\"That's right!  Nice job!\")"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "### <a class=\"anchor\" id=\"Content-Recs\">Part IV: Content Based Recommendations (EXTRA - NOT REQUIRED)</a>\n",
    "\n",
    "Another method we might use to make recommendations is to perform a ranking of the highest ranked articles associated with some term.  You might consider content to be the **doc_body**, **doc_description**, or **doc_full_name**.  There isn't one way to create a content based recommendation, especially considering that each of these columns hold content related information.  \n",
    "\n",
    "`1.` Use the function body below to create a content based recommender.  Since there isn't one right answer for this recommendation tactic, no test functions are provided.  Feel free to change the function inputs if you decide you want to try a method that requires more input values.  The input values are currently set with one idea in mind that you may use to make content based recommendations.  One additional idea is that you might want to choose the most popular recommendations that meet your 'content criteria', but again, there is a lot of flexibility in how you might make these recommendations.\n",
    "\n",
    "### This part is NOT REQUIRED to pass this project.  However, you may choose to take this on as an extra way to show off your skills."
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "metadata": {},
   "outputs": [],
   "source": [
    "#########1#########2#########3#########4#########5#########6#########7#########8\n",
    "def make_content_rec(verbose=False):\n",
    "    '''This function...\n",
    "    \n",
    "    Input:\n",
    "      - verbose (optional) - if you want some verbosity in your function -\n",
    "        (Boolean, default=False)\n",
    "    Output:\n",
    "      - \n",
    "    '''\n",
    "    if verbose:\n",
    "        print('###function power started - works by Trial  & Error')        \n",
    "    start = time()\n",
    "    \n",
    "    #code\n",
    "\n",
    "    end = time()\n",
    "    \n",
    "    if verbose:\n",
    "        print('elapsed time: {:.4f}s'.format(end-begin))\n",
    "    \n",
    "    return True"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "`2.` Now that you have put together your content-based recommendation system, use the cell below to write a summary explaining how your content based recommender works.  Do you see any possible improvements that could be made to your function?  Is there anything novel about your content based recommender?\n",
    "\n",
    "### This part is NOT REQUIRED to pass this project.  However, you may choose to take this on as an extra way to show off your skills."
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "**Write an explanation of your content based recommendation system here.**"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "`3.` Use your content-recommendation system to make recommendations for the below scenarios based on the comments.  Again no tests are provided here, because there isn't one right answer that could be used to find these content based recommendations.\n",
    "\n",
    "### This part is NOT REQUIRED to pass this project.  However, you may choose to take this on as an extra way to show off your skills."
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "metadata": {},
   "outputs": [],
   "source": [
    "# make recommendations for a brand new user\n",
    "\n",
    "\n",
    "# make a recommendations for a user who only has interacted with article id '1427.0'\n",
    "\n"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "### <a class=\"anchor\" id=\"Matrix-Fact\">Part V: Matrix Factorization</a>\n",
    "\n",
    "In this part of the notebook, you will build use matrix factorization to make article recommendations to the users on the IBM Watson Studio platform.\n",
    "\n",
    "`1.` You should have already created a **user_item** matrix above in **question 1** of **Part III** above.  This first question here will just require that you run the cells to get things set up for the rest of **Part V** of the notebook. "
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "metadata": {},
   "outputs": [],
   "source": [
    "# Load the matrix here\n",
    "user_item_matrix = pd.read_pickle('user_item_matrix.p')"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "metadata": {},
   "outputs": [],
   "source": [
    "# quick look at the matrix\n",
    "user_item_matrix.head()"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "`2.` In this situation, you can use Singular Value Decomposition from [numpy](https://docs.scipy.org/doc/numpy-1.14.0/reference/generated/numpy.linalg.svd.html) on the user-item matrix.  Use the cell to perform SVD, and explain why this is different than in the lesson."
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "metadata": {},
   "outputs": [],
   "source": [
    "# Perform SVD on the User-Item Matrix Here\n",
    "\n",
    "u, s, vt = # use the built in to get the three matrices"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "**Provide your response here.**"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "`3.` Now for the tricky part, how do we choose the number of latent features to use?  Running the below cell, you can see that as the number of latent features increases, we obtain a lower error rate on making predictions for the 1 and 0 values in the user-item matrix.  Run the cell below to get an idea of how the accuracy improves as we increase the number of latent features."
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "metadata": {},
   "outputs": [],
   "source": [
    "num_latent_feat = np.arange(10,700+10,20)\n",
    "sum_errs = []\n",
    "\n",
    "for k in num_latent_feat:\n",
    "    # restructure with k latent features\n",
    "    s_new, u_new, vt_new = np.diag(s[:k]), u[:, :k], vt[:k, :]\n",
    "    \n",
    "    # take dot product\n",
    "    user_item_est = np.around(np.dot(np.dot(u_new, s_new), vt_new))\n",
    "    \n",
    "    # compute error for each prediction to actual value\n",
    "    diffs = np.subtract(user_item_matrix, user_item_est)\n",
    "    \n",
    "    # total errors and keep track of them\n",
    "    err = np.sum(np.sum(np.abs(diffs)))\n",
    "    sum_errs.append(err)\n",
    "      \n",
    "plt.plot(num_latent_feats, 1 - np.array(sum_errs)/df.shape[0]);\n",
    "plt.xlabel('Number of Latent Features');\n",
    "plt.ylabel('Accuracy');\n",
    "plt.title('Accuracy vs. Number of Latent Features');"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "`4.` From the above, we can't really be sure how many features to use, because simply having a better way to predict the 1's and 0's of the matrix doesn't exactly give us an indication of if we are able to make good recommendations.  Instead, we might split our dataset into a training and test set of data, as shown in the cell below.  \n",
    "\n",
    "Use the code from question 3 to understand the impact on accuracy of the training and test sets of data with different numbers of latent features. Using the split below: \n",
    "\n",
    "* How many users can we make predictions for in the test set?  \n",
    "* How many users are we not able to make predictions for because of the cold start problem?\n",
    "* How many articles can we make predictions for in the test set?  \n",
    "* How many articles are we not able to make predictions for because of the cold start problem?"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "metadata": {},
   "outputs": [],
   "source": [
    "df_train = df.head(40000)\n",
    "df_test = df.tail(5993)"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "metadata": {},
   "outputs": [],
   "source": [
    "#########1#########2#########3#########4#########5#########6#########7#########8\n",
    "def fn_create_test_and_train_user_item(df_train, \n",
    "                                       df_test,\n",
    "                                       verbose=False):\n",
    "    '''This function...\n",
    "    Inputs:\n",
    "      - df_train - training dataframe\n",
    "      - df_test - test dataframe\n",
    "    Outputs:\n",
    "      - user_item_train - a user-item matrix of the training dataframe \n",
    "        (unique users for each row and unique articles for each column)\n",
    "      - user_item_test - a user-item matrix of the testing dataframe \n",
    "        (unique users for each row and unique articles for each column)\n",
    "      - test_idx - all of the test user ids\n",
    "      - test_arts - all of the test article ids\n",
    "      - verbose (optional) - if you want some verbosity in your function -\n",
    "        (Boolean, default=False)\n",
    "    '''\n",
    "    if verbose:\n",
    "        print('###function power started - works by Trial  & Error')        \n",
    "    start = time()\n",
    "\n",
    "    # Your code here\n",
    "    \n",
    "    end = time()\n",
    "    if verbose:\n",
    "        print('elapsed time: {:.6f}s'.format(end-begin))\n",
    "\n",
    "    return user_item_train, user_item_test, test_idx, test_arts"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "metadata": {},
   "outputs": [],
   "source": [
    "user_item_train, user_item_test, test_idx, test_arts = create_test_and_train_user_item(df_train, df_test)"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "metadata": {},
   "outputs": [],
   "source": [
    "# Replace the values in the dictionary below\n",
    "a = 662 \n",
    "b = 574 \n",
    "c = 20 \n",
    "d = 0 \n",
    "\n",
    "sol_4_dict = {\n",
    "    'How many users can we make predictions for in the test set?': # letter here, \n",
    "    'How many users in the test set are we not able to make predictions for because of the cold start problem?': # letter here, \n",
    "    'How many articles can we make predictions for in the test set?': # letter here,\n",
    "    'How many articles in the test set are we not able to make predictions for because of the cold start problem?': # letter here\n",
    "}\n",
    "\n",
    "t.sol_4_test(sol_4_dict)"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "`5.` Now use the **user_item_train** dataset from above to find U, S, and V transpose using SVD. Then find the subset of rows in the **user_item_test** dataset that you can predict using this matrix decomposition with different numbers of latent features to see how many features makes sense to keep based on the accuracy on the test data. This will require combining what was done in questions `2` - `4`.\n",
    "\n",
    "Use the cells below to explore how well SVD works towards making predictions for recommendations on the test data.  "
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "metadata": {},
   "outputs": [],
   "source": [
    "# fit SVD on the user_item_train matrix\n",
    "u_train, s_train, vt_train = # fit svd similar to above then use the cells below"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "metadata": {},
   "outputs": [],
   "source": [
    "# Use these cells to see how well you can use the training \n",
    "# decomposition to predict on test data"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {
    "collapsed": true
   },
   "source": [
    "`6.` Use the cell below to comment on the results you found in the previous question. Given the circumstances of your results, discuss what you might do to determine if the recommendations you make with any of the above recommendation systems are an improvement to how users currently find articles? "
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "**Your response here.**"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {
    "collapsed": true
   },
   "source": [
    "<a id='conclusions'></a>\n",
    "### Extras\n",
    "Using your workbook, you could now save your recommendations for each user, develop a class to make new predictions and update your results, and make a flask app to deploy your results.  These tasks are beyond what is required for this project.  However, from what you learned in the lessons, you certainly capable of taking these tasks on to improve upon your work here!\n",
    "\n",
    "\n",
    "## Conclusion\n",
    "\n",
    "> Congratulations!  You have reached the end of the Recommendations with IBM project! \n",
    "\n",
    "> **Tip**: Once you are satisfied with your work here, check over your report to make sure that it is satisfies all the areas of the [rubric](https://review.udacity.com/#!/rubrics/2322/view). You should also probably remove all of the \"Tips\" like this one so that the presentation is as polished as possible.\n",
    "\n",
    "\n",
    "## Directions to Submit\n",
    "\n",
    "> Before you submit your project, you need to create a .html or .pdf version of this notebook in the workspace here. To do that, run the code cell below. If it worked correctly, you should get a return code of 0, and you should see the generated .html file in the workspace directory (click on the orange Jupyter icon in the upper left).\n",
    "\n",
    "> Alternatively, you can download this report as .html via the **File** > **Download as** submenu, and then manually upload it into the workspace directory by clicking on the orange Jupyter icon in the upper left, then using the Upload button.\n",
    "\n",
    "> Once you've done this, you can submit your project by clicking on the \"Submit Project\" button in the lower right here. This will create and submit a zip file with this .ipynb doc and the .html or .pdf version you created. Congratulations! "
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "metadata": {},
   "outputs": [],
   "source": [
    "from subprocess import call\n",
    "call(['python', '-m', 'nbconvert', 'Recommendations_with_IBM.ipynb'])"
   ]
  }
 ],
 "metadata": {
  "kernelspec": {
   "display_name": "Python 3 (ipykernel)",
   "language": "python",
   "name": "python3"
  },
  "language_info": {
   "codemirror_mode": {
    "name": "ipython",
    "version": 3
   },
   "file_extension": ".py",
   "mimetype": "text/x-python",
   "name": "python",
   "nbconvert_exporter": "python",
   "pygments_lexer": "ipython3",
   "version": "3.8.11"
  }
 },
 "nbformat": 4,
 "nbformat_minor": 2
}