{ "cells": [ { "cell_type": "markdown", "metadata": {}, "source": [ "# Optional Lab: Python, NumPy and Vectorization\n", "A brief introduction to some of the scientific computing used in this course. In particular the NumPy scientific computing package and its use with python.\n", "\n", "# Outline\n", "- [  1.1 Goals](#toc_40015_1.1)\n", "- [  1.2 Useful References](#toc_40015_1.2)\n", "- [2 Python and NumPy ](#toc_40015_2)\n", "- [3 Vectors](#toc_40015_3)\n", "- [  3.1 Abstract](#toc_40015_3.1)\n", "- [  3.2 NumPy Arrays](#toc_40015_3.2)\n", "- [  3.3 Vector Creation](#toc_40015_3.3)\n", "- [  3.4 Operations on Vectors](#toc_40015_3.4)\n", "- [4 Matrices](#toc_40015_4)\n", "- [  4.1 Abstract](#toc_40015_4.1)\n", "- [  4.2 NumPy Arrays](#toc_40015_4.2)\n", "- [  4.3 Matrix Creation](#toc_40015_4.3)\n", "- [  4.4 Operations on Matrices](#toc_40015_4.4)\n" ] }, { "cell_type": "code", "execution_count": null, "metadata": {}, "outputs": [], "source": [ "import numpy as np # it is an unofficial standard to use np for numpy\n", "import time" ] }, { "cell_type": "markdown", "metadata": {}, "source": [ "\n", "## 1.1 Goals\n", "In this lab, you will:\n", "- Review the features of NumPy and Python that are used in Course 1" ] }, { "cell_type": "markdown", "metadata": {}, "source": [ "\n", "## 1.2 Useful References\n", "- NumPy Documentation including a basic introduction: [NumPy.org](https://NumPy.org/doc/stable/)\n", "- A challenging feature topic: [NumPy Broadcasting](https://NumPy.org/doc/stable/user/basics.broadcasting.html)\n" ] }, { "cell_type": "markdown", "metadata": {}, "source": [ "\n", "# 2 Python and NumPy \n", "Python is the programming language we will be using in this course. It has a set of numeric data types and arithmetic operations. NumPy is a library that extends the base capabilities of python to add a richer data set including more numeric types, vectors, matrices, and many matrix functions. NumPy and python work together fairly seamlessly. Python arithmetic operators work on NumPy data types and many NumPy functions will accept python data types.\n" ] }, { "cell_type": "markdown", "metadata": {}, "source": [ "\n", "# 3 Vectors\n", "\n", "## 3.1 Abstract\n", "Vectors, as you will use them in this course, are ordered arrays of numbers. In notation, vectors are denoted with lower case bold letters such as $\\mathbf{x}$. The elements of a vector are all the same type. A vector does not, for example, contain both characters and numbers. The number of elements in the array is often referred to as the *dimension* though mathematicians may prefer *rank*. The vector shown has a dimension of $n$. The elements of a vector can be referenced with an index. In math settings, indexes typically run from 1 to n. In computer science and these labs, indexing will typically run from 0 to n-1. In notation, elements of a vector, when referenced individually will indicate the index in a subscript, for example, the $0^{th}$ element, of the vector $\\mathbf{x}$ is $x_0$. Note, the x is not bold in this case. \n" ] }, { "cell_type": "markdown", "metadata": {}, "source": [ "\n", "## 3.2 NumPy Arrays\n", "\n", "NumPy's basic data structure is an indexable, n-dimensional *array* containing elements of the same type (`dtype`). Right away, you may notice we have overloaded the term 'dimension'. Above, it was the number of elements in the vector, here, dimension refers to the number of indexes of an array. A one-dimensional or 1-D array has one index. In Course 1, we will represent vectors as NumPy 1-D arrays. \n", "\n", " - 1-D array, shape (n,): n elements indexed [0] through [n-1]\n", " " ] }, { "cell_type": "markdown", "metadata": {}, "source": [ "\n", "## 3.3 Vector Creation\n" ] }, { "cell_type": "markdown", "metadata": {}, "source": [ "Data creation routines in NumPy will generally have a first parameter which is the shape of the object. This can either be a single value for a 1-D result or a tuple (n,m,...) specifying the shape of the result. Below are examples of creating vectors using these routines." ] }, { "cell_type": "code", "execution_count": null, "metadata": {}, "outputs": [], "source": [ "# NumPy routines which allocate memory and fill arrays with value\n", "a = np.zeros(4); print(f\"np.zeros(4) : a = {a}, a shape = {a.shape}, a data type = {a.dtype}\")\n", "a = np.zeros((4,)); print(f\"np.zeros(4,) : a = {a}, a shape = {a.shape}, a data type = {a.dtype}\")\n", "a = np.random.random_sample(4); print(f\"np.random.random_sample(4): a = {a}, a shape = {a.shape}, a data type = {a.dtype}\")" ] }, { "cell_type": "markdown", "metadata": {}, "source": [ "Some data creation routines do not take a shape tuple:" ] }, { "cell_type": "code", "execution_count": null, "metadata": {}, "outputs": [], "source": [ "# NumPy routines which allocate memory and fill arrays with value but do not accept shape as input argument\n", "a = np.arange(4.); print(f\"np.arange(4.): a = {a}, a shape = {a.shape}, a data type = {a.dtype}\")\n", "a = np.random.rand(4); print(f\"np.random.rand(4): a = {a}, a shape = {a.shape}, a data type = {a.dtype}\")" ] }, { "cell_type": "markdown", "metadata": {}, "source": [ "values can be specified manually as well. " ] }, { "cell_type": "code", "execution_count": null, "metadata": {}, "outputs": [], "source": [ "# NumPy routines which allocate memory and fill with user specified values\n", "a = np.array([5,4,3,2]); print(f\"np.array([5,4,3,2]): a = {a}, a shape = {a.shape}, a data type = {a.dtype}\")\n", "a = np.array([5.,4,3,2]); print(f\"np.array([5.,4,3,2]): a = {a}, a shape = {a.shape}, a data type = {a.dtype}\")" ] }, { "cell_type": "markdown", "metadata": {}, "source": [ "These have all created a one-dimensional vector `a` with four elements. `a.shape` returns the dimensions. Here we see a.shape = `(4,)` indicating a 1-d array with 4 elements. " ] }, { "cell_type": "markdown", "metadata": {}, "source": [ "\n", "## 3.4 Operations on Vectors\n", "Let's explore some operations using vectors.\n", "\n", "### 3.4.1 Indexing\n", "Elements of vectors can be accessed via indexing and slicing. NumPy provides a very complete set of indexing and slicing capabilities. We will explore only the basics needed for the course here. Reference [Slicing and Indexing](https://NumPy.org/doc/stable/reference/arrays.indexing.html) for more details. \n", "**Indexing** means referring to *an element* of an array by its position within the array. \n", "**Slicing** means getting a *subset* of elements from an array based on their indices. \n", "NumPy starts indexing at zero so the 3rd element of an vector $\\mathbf{a}$ is `a[2]`." ] }, { "cell_type": "code", "execution_count": null, "metadata": {}, "outputs": [], "source": [ "#vector indexing operations on 1-D vectors\n", "a = np.arange(10)\n", "print(a)\n", "\n", "#access an element\n", "print(f\"a[2].shape: {a[2].shape} a[2] = {a[2]}, Accessing an element returns a scalar\")\n", "\n", "# access the last element, negative indexes count from the end\n", "print(f\"a[-1] = {a[-1]}\")\n", "\n", "#indexs must be within the range of the vector or they will produce and error\n", "try:\n", " c = a[10]\n", "except Exception as e:\n", " print(\"The error message you'll see is:\")\n", " print(e)" ] }, { "cell_type": "markdown", "metadata": {}, "source": [ "\n", "### 3.4.2 Slicing\n", "Slicing creates an array of indices using a set of three values (`start:stop:step`). A subset of values is also valid. Its use is best explained by example:" ] }, { "cell_type": "code", "execution_count": null, "metadata": {}, "outputs": [], "source": [ "#vector slicing operations\n", "a = np.arange(10)\n", "print(f\"a = {a}\")\n", "\n", "#access 5 consecutive elements (start:stop:step)\n", "c = a[2:7:1]; print(\"a[2:7:1] = \", c)\n", "\n", "# access 3 elements separated by two \n", "c = a[2:7:2]; print(\"a[2:7:2] = \", c)\n", "\n", "# access all elements index 3 and above\n", "c = a[3:]; print(\"a[3:] = \", c)\n", "\n", "# access all elements below index 3\n", "c = a[:3]; print(\"a[:3] = \", c)\n", "\n", "# access all elements\n", "c = a[:]; print(\"a[:] = \", c)" ] }, { "cell_type": "markdown", "metadata": {}, "source": [ "\n", "### 3.4.3 Single vector operations\n", "There are a number of useful operations that involve operations on a single vector." ] }, { "cell_type": "code", "execution_count": null, "metadata": {}, "outputs": [], "source": [ "a = np.array([1,2,3,4])\n", "print(f\"a : {a}\")\n", "# negate elements of a\n", "b = -a \n", "print(f\"b = -a : {b}\")\n", "\n", "# sum all elements of a, returns a scalar\n", "b = np.sum(a) \n", "print(f\"b = np.sum(a) : {b}\")\n", "\n", "b = np.mean(a)\n", "print(f\"b = np.mean(a): {b}\")\n", "\n", "b = a**2\n", "print(f\"b = a**2 : {b}\")" ] }, { "cell_type": "markdown", "metadata": {}, "source": [ "\n", "### 3.4.4 Vector Vector element-wise operations\n", "Most of the NumPy arithmetic, logical and comparison operations apply to vectors as well. These operators work on an element-by-element basis. For example \n", "$$ c_i = a_i + b_i $$" ] }, { "cell_type": "code", "execution_count": null, "metadata": {}, "outputs": [], "source": [ "a = np.array([ 1, 2, 3, 4])\n", "b = np.array([-1,-2, 3, 4])\n", "print(f\"Binary operators work element wise: {a + b}\")" ] }, { "cell_type": "markdown", "metadata": {}, "source": [ "Of course, for this to work correctly, the vectors must be of the same size:" ] }, { "cell_type": "code", "execution_count": null, "metadata": {}, "outputs": [], "source": [ "#try a mismatched vector operation\n", "c = np.array([1, 2])\n", "try:\n", " d = a + c\n", "except Exception as e:\n", " print(\"The error message you'll see is:\")\n", " print(e)" ] }, { "cell_type": "markdown", "metadata": {}, "source": [ "\n", "### 3.4.5 Scalar Vector operations\n", "Vectors can be 'scaled' by scalar values. A scalar value is just a number. The scalar multiplies all the elements of the vector." ] }, { "cell_type": "code", "execution_count": null, "metadata": {}, "outputs": [], "source": [ "a = np.array([1, 2, 3, 4])\n", "\n", "# multiply a by a scalar\n", "b = 5 * a \n", "print(f\"b = 5 * a : {b}\")" ] }, { "cell_type": "markdown", "metadata": {}, "source": [ "\n", "### 3.4.6 Vector Vector dot product\n", "The dot product is a mainstay of Linear Algebra and NumPy. This is an operation used extensively in this course and should be well understood. The dot product is shown below." ] }, { "cell_type": "markdown", "metadata": {}, "source": [ " " ] }, { "cell_type": "markdown", "metadata": {}, "source": [ "The dot product multiplies the values in two vectors element-wise and then sums the result.\n", "Vector dot product requires the dimensions of the two vectors to be the same. " ] }, { "cell_type": "markdown", "metadata": {}, "source": [ "Let's implement our own version of the dot product below:\n", "\n", "**Using a for loop**, implement a function which returns the dot product of two vectors. The function to return given inputs $a$ and $b$:\n", "$$ x = \\sum_{i=0}^{n-1} a_i b_i $$\n", "Assume both `a` and `b` are the same shape." ] }, { "cell_type": "code", "execution_count": null, "metadata": {}, "outputs": [], "source": [ "def my_dot(a, b): \n", " \"\"\"\n", " Compute the dot product of two vectors\n", " \n", " Args:\n", " a (ndarray (n,)): input vector \n", " b (ndarray (n,)): input vector with same dimension as a\n", " \n", " Returns:\n", " x (scalar): \n", " \"\"\"\n", " x=0\n", " for i in range(a.shape[0]):\n", " x = x + a[i] * b[i]\n", " return x" ] }, { "cell_type": "code", "execution_count": null, "metadata": {}, "outputs": [], "source": [ "# test 1-D\n", "a = np.array([1, 2, 3, 4])\n", "b = np.array([-1, 4, 3, 2])\n", "print(f\"my_dot(a, b) = {my_dot(a, b)}\")" ] }, { "cell_type": "markdown", "metadata": {}, "source": [ "Note, the dot product is expected to return a scalar value. \n", "\n", "Let's try the same operations using `np.dot`. " ] }, { "cell_type": "code", "execution_count": null, "metadata": {}, "outputs": [], "source": [ "# test 1-D\n", "a = np.array([1, 2, 3, 4])\n", "b = np.array([-1, 4, 3, 2])\n", "c = np.dot(a, b)\n", "print(f\"NumPy 1-D np.dot(a, b) = {c}, np.dot(a, b).shape = {c.shape} \") \n", "c = np.dot(b, a)\n", "print(f\"NumPy 1-D np.dot(b, a) = {c}, np.dot(a, b).shape = {c.shape} \")\n" ] }, { "cell_type": "markdown", "metadata": {}, "source": [ "Above, you will note that the results for 1-D matched our implementation." ] }, { "cell_type": "markdown", "metadata": {}, "source": [ "\n", "### 3.4.7 The Need for Speed: vector vs for loop\n", "We utilized the NumPy library because it improves speed memory efficiency. Let's demonstrate:" ] }, { "cell_type": "code", "execution_count": null, "metadata": {}, "outputs": [], "source": [ "np.random.seed(1)\n", "a = np.random.rand(10000000) # very large arrays\n", "b = np.random.rand(10000000)\n", "\n", "tic = time.time() # capture start time\n", "c = np.dot(a, b)\n", "toc = time.time() # capture end time\n", "\n", "print(f\"np.dot(a, b) = {c:.4f}\")\n", "print(f\"Vectorized version duration: {1000*(toc-tic):.4f} ms \")\n", "\n", "tic = time.time() # capture start time\n", "c = my_dot(a,b)\n", "toc = time.time() # capture end time\n", "\n", "print(f\"my_dot(a, b) = {c:.4f}\")\n", "print(f\"loop version duration: {1000*(toc-tic):.4f} ms \")\n", "\n", "del(a);del(b) #remove these big arrays from memory" ] }, { "cell_type": "markdown", "metadata": {}, "source": [ "So, vectorization provides a large speed up in this example. This is because NumPy makes better use of available data parallelism in the underlying hardware. GPU's and modern CPU's implement Single Instruction, Multiple Data (SIMD) pipelines allowing multiple operations to be issued in parallel. This is critical in Machine Learning where the data sets are often very large." ] }, { "cell_type": "markdown", "metadata": {}, "source": [ "\n", "### 3.4.8 Vector Vector operations in Course 1\n", "Vector Vector operations will appear frequently in course 1. Here is why:\n", "- Going forward, our examples will be stored in an array, `X_train` of dimension (m,n). This will be explained more in context, but here it is important to note it is a 2 Dimensional array or matrix (see next section on matrices).\n", "- `w` will be a 1-dimensional vector of shape (n,).\n", "- we will perform operations by looping through the examples, extracting each example to work on individually by indexing X. For example:`X[i]`\n", "- `X[i]` returns a value of shape (n,), a 1-dimensional vector. Consequently, operations involving `X[i]` are often vector-vector. \n", "\n", "That is a somewhat lengthy explanation, but aligning and understanding the shapes of your operands is important when performing vector operations." ] }, { "cell_type": "code", "execution_count": null, "metadata": {}, "outputs": [], "source": [ "# show common Course 1 example\n", "X = np.array([[1],[2],[3],[4]])\n", "w = np.array([2])\n", "c = np.dot(X[1], w)\n", "\n", "print(f\"X[1] has shape {X[1].shape}\")\n", "print(f\"w has shape {w.shape}\")\n", "print(f\"c has shape {c.shape}\")" ] }, { "cell_type": "markdown", "metadata": {}, "source": [ "\n", "# 4 Matrices\n" ] }, { "cell_type": "markdown", "metadata": {}, "source": [ "\n", "## 4.1 Abstract\n", "Matrices, are two dimensional arrays. The elements of a matrix are all of the same type. In notation, matrices are denoted with capitol, bold letter such as $\\mathbf{X}$. In this and other labs, `m` is often the number of rows and `n` the number of columns. The elements of a matrix can be referenced with a two dimensional index. In math settings, numbers in the index typically run from 1 to n. In computer science and these labs, indexing will run from 0 to n-1. \n", "
\n", "
missing
\n", "
Generic Matrix Notation, 1st index is row, 2nd is column
\n", "
" ] }, { "cell_type": "markdown", "metadata": {}, "source": [ "\n", "## 4.2 NumPy Arrays\n", "\n", "NumPy's basic data structure is an indexable, n-dimensional *array* containing elements of the same type (`dtype`). These were described earlier. Matrices have a two-dimensional (2-D) index [m,n].\n", "\n", "In Course 1, 2-D matrices are used to hold training data. Training data is $m$ examples by $n$ features creating an (m,n) array. Course 1 does not do operations directly on matrices but typically extracts an example as a vector and operates on that. Below you will review: \n", "- data creation\n", "- slicing and indexing" ] }, { "cell_type": "markdown", "metadata": {}, "source": [ "\n", "## 4.3 Matrix Creation\n", "The same functions that created 1-D vectors will create 2-D or n-D arrays. Here are some examples\n" ] }, { "cell_type": "markdown", "metadata": {}, "source": [ "Below, the shape tuple is provided to achieve a 2-D result. Notice how NumPy uses brackets to denote each dimension. Notice further than NumPy, when printing, will print one row per line.\n" ] }, { "cell_type": "code", "execution_count": null, "metadata": {}, "outputs": [], "source": [ "a = np.zeros((1, 5)) \n", "print(f\"a shape = {a.shape}, a = {a}\") \n", "\n", "a = np.zeros((2, 1)) \n", "print(f\"a shape = {a.shape}, a = {a}\") \n", "\n", "a = np.random.random_sample((1, 1)) \n", "print(f\"a shape = {a.shape}, a = {a}\") " ] }, { "cell_type": "markdown", "metadata": {}, "source": [ "One can also manually specify data. Dimensions are specified with additional brackets matching the format in the printing above." ] }, { "cell_type": "code", "execution_count": null, "metadata": {}, "outputs": [], "source": [ "# NumPy routines which allocate memory and fill with user specified values\n", "a = np.array([[5], [4], [3]]); print(f\" a shape = {a.shape}, np.array: a = {a}\")\n", "a = np.array([[5], # One can also\n", " [4], # separate values\n", " [3]]); #into separate rows\n", "print(f\" a shape = {a.shape}, np.array: a = {a}\")" ] }, { "cell_type": "markdown", "metadata": {}, "source": [ "\n", "## 4.4 Operations on Matrices\n", "Let's explore some operations using matrices." ] }, { "cell_type": "markdown", "metadata": {}, "source": [ "\n", "### 4.4.1 Indexing\n" ] }, { "cell_type": "markdown", "metadata": {}, "source": [ "Matrices include a second index. The two indexes describe [row, column]. Access can either return an element or a row/column. See below:" ] }, { "cell_type": "code", "execution_count": null, "metadata": {}, "outputs": [], "source": [ "#vector indexing operations on matrices\n", "a = np.arange(6).reshape(-1, 2) #reshape is a convenient way to create matrices\n", "print(f\"a.shape: {a.shape}, \\na= {a}\")\n", "\n", "#access an element\n", "print(f\"\\na[2,0].shape: {a[2, 0].shape}, a[2,0] = {a[2, 0]}, type(a[2,0]) = {type(a[2, 0])} Accessing an element returns a scalar\\n\")\n", "\n", "#access a row\n", "print(f\"a[2].shape: {a[2].shape}, a[2] = {a[2]}, type(a[2]) = {type(a[2])}\")" ] }, { "cell_type": "markdown", "metadata": {}, "source": [ "It is worth drawing attention to the last example. Accessing a matrix by just specifying the row will return a *1-D vector*." ] }, { "cell_type": "markdown", "metadata": {}, "source": [ "**Reshape** \n", "The previous example used [reshape](https://numpy.org/doc/stable/reference/generated/numpy.reshape.html) to shape the array. \n", "`a = np.arange(6).reshape(-1, 2) ` \n", "This line of code first created a *1-D Vector* of six elements. It then reshaped that vector into a *2-D* array using the reshape command. This could have been written: \n", "`a = np.arange(6).reshape(3, 2) ` \n", "To arrive at the same 3 row, 2 column array.\n", "The -1 argument tells the routine to compute the number of rows given the size of the array and the number of columns.\n" ] }, { "cell_type": "markdown", "metadata": {}, "source": [ "\n", "### 4.4.2 Slicing\n", "Slicing creates an array of indices using a set of three values (`start:stop:step`). A subset of values is also valid. Its use is best explained by example:" ] }, { "cell_type": "code", "execution_count": null, "metadata": {}, "outputs": [], "source": [ "#vector 2-D slicing operations\n", "a = np.arange(20).reshape(-1, 10)\n", "print(f\"a = \\n{a}\")\n", "\n", "#access 5 consecutive elements (start:stop:step)\n", "print(\"a[0, 2:7:1] = \", a[0, 2:7:1], \", a[0, 2:7:1].shape =\", a[0, 2:7:1].shape, \"a 1-D array\")\n", "\n", "#access 5 consecutive elements (start:stop:step) in two rows\n", "print(\"a[:, 2:7:1] = \\n\", a[:, 2:7:1], \", a[:, 2:7:1].shape =\", a[:, 2:7:1].shape, \"a 2-D array\")\n", "\n", "# access all elements\n", "print(\"a[:,:] = \\n\", a[:,:], \", a[:,:].shape =\", a[:,:].shape)\n", "\n", "# access all elements in one row (very common usage)\n", "print(\"a[1,:] = \", a[1,:], \", a[1,:].shape =\", a[1,:].shape, \"a 1-D array\")\n", "# same as\n", "print(\"a[1] = \", a[1], \", a[1].shape =\", a[1].shape, \"a 1-D array\")\n" ] }, { "cell_type": "markdown", "metadata": {}, "source": [ "\n", "## Congratulations!\n", "In this lab you mastered the features of Python and NumPy that are needed for Course 1." ] }, { "cell_type": "code", "execution_count": null, "metadata": {}, "outputs": [], "source": [] } ], "metadata": { "dl_toc_settings": { "rndtag": "40015" }, "kernelspec": { "display_name": "Python 3", "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.9.10" }, "toc-autonumbering": false }, "nbformat": 4, "nbformat_minor": 4 }