updated README

Author: miramar-labs

Makefile

@@ -60,7 +60,6 @@ CXXFLAGS += -pthread -fPIC -fwrapv -std=c++14 $(COMMON_FLAGS) $(WARNINGS)
 NVCCFLAGS += -std=c++14 -ccbin=$(CXX) -Xcompiler -fPIC $(COMMON_FLAGS)
 
 all: $(STATIC_LIB)
-	#python setup.py install --force
 
 debug:
 	@ echo $(INCLUDE_DIRS)

README.md

@@ -1 +1,25 @@
-# cuda-torch-custom-kernel
+# Custom CUDA Kernel for PyTorch
+
+This codebase demonstrates how to:
+- implement a simple CUDA kernel function
+- interface it to PyTorch using pybind11 / ATen
+
+Shortly I will add more code to this extension module that:
+- demonstrates some common CUDA/GPU optimization techniques
+- implements a custom layer of a PyTorch neural network
+
+To Build:
+
+- Create a Python virtualenv based on Python 3.8 and activate it.
+
+- Install requirements:
+
+        pip3 install -r requirements.txt
+
+- Build extension module:
+
+        python3 setup.py install --force
+
+From a terminal window, launch JupyterLAB and load up test.ipynb - run that...
+
+        jupyter lab

test.ipynb

@@ -2,8 +2,8 @@
  "cells": [
   {
    "cell_type": "code",
-   "execution_count": 4,
-   "id": "dedicated-billion",
+   "execution_count": 1,
+   "id": "pretty-advocate",
    "metadata": {},
    "outputs": [],
    "source": [
@@ -12,8 +12,8 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 5,
-   "id": "utility-elimination",
+   "execution_count": 2,
+   "id": "certified-james",
    "metadata": {},
    "outputs": [],
    "source": [
@@ -22,15 +22,15 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 6,
-   "id": "indoor-british",
+   "execution_count": 3,
+   "id": "southern-journalism",
    "metadata": {},
    "outputs": [
     {
      "name": "stdout",
      "output_type": "stream",
      "text": [
-      "tensor([-0.5502,  0.4615, -0.6627, -1.2349], device='cuda:0') tensor([0.1335, 0.1309, 0.6156, 0.5665], device='cuda:0') tensor([-0.4167,  0.5923, -0.0471, -0.6684], device='cuda:0')\n"
+      "tensor([-0.9224, -0.0188, -0.7667,  1.1617], device='cuda:0') tensor([ 0.3536, -0.1907,  0.4413, -0.8640], device='cuda:0') tensor([-0.5688, -0.2094, -0.3254,  0.2977], device='cuda:0')\n"
      ]
     }
    ],
@@ -47,7 +47,7 @@
   {
    "cell_type": "code",
    "execution_count": null,
-   "id": "hidden-supplement",
+   "id": "substantial-treasury",
    "metadata": {},
    "outputs": [],
    "source": []