Merge pull request #43 from rapidsai/develop

Merge develop to master for Release v0.2.

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,28 @@
+---
+name: Bug report
+about: Create a bug report to help us improve gQuant
+title: "[BUG]"
+labels: "? - Needs Triage, bug"
+assignees: ''
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**Steps/Code to reproduce bug**
+Follow this guide http://matthewrocklin.com/blog/work/2018/02/28/minimal-bug-reports to craft a minimal bug report. This helps us reproduce the issue you're having and resolve the issue more quickly.
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Environment overview (please complete the following information)**
+ - Environment location: [Bare-metal, Docker, Cloud(specify cloud provider)]
+ - Method of gQuant install: [Docker build, or from source]
+
+
+**Environment details**
+Please run and paste the output of the `/print_env.sh` script here, to gather any other relevant environment details
+
+**Additional context**
+Add any other context about the problem here.

.github/ISSUE_TEMPLATE/documentation-request.md

@@ -0,0 +1,35 @@
+---
+name: Documentation request
+about: Report incorrect or needed documentation
+title: "[DOC]"
+labels: "? - Needs Triage, doc"
+assignees: ''
+
+---
+
+## Report incorrect documentation
+
+**Location of incorrect documentation**
+Provide links and line numbers if applicable.
+
+**Describe the problems or issues found in the documentation**
+A clear and concise description of what you found to be incorrect.
+
+**Steps taken to verify documentation is incorrect**
+List any steps you have taken:
+
+**Suggested fix for documentation**
+Detail proposed changes to fix the documentation if you have any.
+
+---
+
+## Report needed documentation
+
+**Report needed documentation**
+A clear and concise description of what documentation you believe it is needed and why.
+
+**Describe the documentation you'd like**
+A clear and concise description of what you want to happen.
+
+**Steps taken to search for needed documentation**
+List any steps you have taken:

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,20 @@
+---
+name: Feature request
+about: Suggest an idea for gQuant
+title: "[FEA]"
+labels: "? - Needs Triage, feature request"
+assignees: ''
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I wish I could use gQuant to do [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context, code examples, or references to existing implementations about the feature request here.

.github/ISSUE_TEMPLATE/submit-question.md

@@ -0,0 +1,10 @@
+---
+name: Submit question
+about: Ask a general question about gQuant
+title: "[QST]"
+labels: "? - Needs Triage, question"
+assignees: ''
+
+---
+
+**What is your question?**

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,49 @@
+<!--
+
+Thank you for contributing to gQuant :)
+
+Here are some guidelines to help the review process go smoothly.
+
+1. Please write a description in this text box of the changes that are being
+   made.
+
+2. Please ensure that you have written units tests for the changes made/features
+   added.
+
+3. There are CI checks in place to enforce that committed code follows our style
+   and syntax standards. Please see our contribution guide in `CONTRIBUTING.MD`
+   in the project root for more information about the checks we perform and how
+   you can run them locally.
+
+4. If you are closing an issue please use one of the automatic closing words as
+   noted here: https://help.github.com/articles/closing-issues-using-keywords/
+
+5. If your pull request is not ready for review but you want to make use of the
+   continuous integration testing facilities please label it with `[WIP]`.
+
+6. If your pull request is ready to be reviewed without requiring additional
+   work on top of it, then remove the `[WIP]` label (if present) and replace
+   it with `[REVIEW]`. If assistance is required to complete the functionality,
+   for example when the C/C++ code of a feature is complete but Python bindings
+   are still required, then add the label `[HELP-REQ]` so that others can triage
+   and assist. The additional changes then can be implemented on top of the
+   same PR. If the assistance is done by members of the rapidsAI team, then no
+   additional actions are required by the creator of the original PR for this,
+   otherwise the original author of the PR needs to give permission to the
+   person(s) assisting to commit to their personal fork of the project. If that
+   doesn't happen then a new PR based on the code of the original PR can be
+   opened by the person assisting, which then will be the PR that will be
+   merged.
+
+7. Once all work has been done and review has taken place please do not add
+   features or make changes out of the scope of those requested by the reviewer
+   (doing this just add delays as already reviewed code ends up having to be
+   re-reviewed/it is hard to tell what is new etc!). Further, please do not
+   rebase your branch on master/force push/rewrite history, doing any of these
+   causes the context of any comments made by reviewers to be lost. If
+   conflicts occur against master they should be resolved by merging master
+   into the branch used for making the pull request.
+
+Many thanks in advance for your cooperation!
+
+-->

README.md

@@ -44,9 +44,8 @@ $ git clone https://github.com/rapidsai/gQuant.git
 
 - Build and run the container:
 ```bash
-$ cd gQuant && . build.sh
+$ cd gQuant/docker && . build.sh
 $ docker run --runtime=nvidia --rm -it -p 8888:8888 -p 8787:8787 -p 8786:8786 gquant/gquant:latest
-$ source activate rapids
 $ bash rapids/notebooks/utils/start-jupyter.sh 
 ```
 

docker/build.sh

@@ -0,0 +1,95 @@
+#!/bin/bash
+
+echo "Building gQuant container..."
+
+echo -e "Please, select the option which better fits your system configuration:\n" \
+        " - '1' for Ubuntu 16.04 + cuda 9.2\n" \
+        " - '2' for Ubuntu 16.04 + cuda 10.0\n" \
+        " - '3' for Ubuntu 18.04 + cuda 9.2\n" \
+        " - '4' for Ubuntu 18.04 + cuda 10.0"
+
+read -p "Enter your option and hit return [1]-4: " SYSTEM_CONFIGURATION
+
+SYSTEM_CONFIGURATION=${SYSTEM_CONFIGURATION:-1}
+case $SYSTEM_CONFIGURATION in
+    2)
+        echo "Ubuntu 16.04 + cuda 10.0 selected."
+        OS_STR='16.04'
+        CONTAINER_VER='10.0'
+        CUPY='cupy-cuda100'
+        ;;
+    3)
+        echo "Ubuntu 18.04 + cuda 9.2 selected."
+        OS_STR='18.04'
+        CONTAINER_VER='9.2'
+        CUPY='cupy-cuda92'
+        ;;
+    4)
+        echo "Ubuntu 18.04 + cuda 10.0 selected."
+        OS_STR='18.04'
+	CONTAINER_VER='10.0'
+	CUPY='cupy-cuda100'
+        ;;
+    *)
+        echo "Ubuntu 16.04 + cuda 9.2 selected."
+        OS_STR='16.04'
+        CONTAINER_VER='9.2'
+        CUPY='cupy-cuda92'
+        ;;
+esac
+
+CONTAINER="nvcr.io/nvidia/rapidsai/rapidsai:cuda${CONTAINER_VER}-runtime-ubuntu${OS_STR}"
+
+read -p "Would you like to install Vim JupyterLab Extension (optional) [N]/y: " VIM_INSTALL
+
+VIM_INSTALL=${VIM_INSTALL:-N}
+if [ "$VIM_INSTALL" = "Y" ] || [ "$VIM_INSTALL" = "y" ]; then
+    echo "Vim JupyterLab Extension will be installed."
+else
+    echo "Vim JupyterLab Extension will not be installed."
+fi
+
+D_FILE=${D_FILE:='Dockerfile.Rapids'}
+D_CONT=${D_CONT:='gquant/gquant:latest'}
+
+echo "Fetching latest version of gQuant project"
+git clone --recursive https://github.com/rapidsai/gQuant
+
+
+cat > $D_FILE <<EOF
+FROM $CONTAINER
+USER root
+
+ADD gQuant /rapids/gQuant
+
+RUN apt-get update && apt-get install -y libfontconfig1 libxrender1
+
+SHELL ["bash","-c"]
+
+#
+# Additional python libs
+#
+RUN pip install nxpd $CUPY
+RUN conda install -y -c conda-forge dask-labextension recommonmark numpydoc sphinx_rtd_theme pudb \
+    python-graphviz bqplot=0.11.5 nodejs=11.11.0 jupyterlab=0.35.4 ipywidgets=7.4.2 pytables mkl numexpr
+
+#
+# required set up
+#
+RUN jupyter labextension install @jupyter-widgets/[email protected] --no-build \
+    && jupyter labextension install [email protected] --no-build \
+    && mkdir /.local /.jupyter /.config /.cupy  \
+    && chmod 777 /.local /.jupyter /.config /.cupy
+
+RUN if [ "$VIM_INSTALL" = "Y" ] || [ "$VIM_INSTALL" = "y" ]; then /conda/envs/rapids/bin/jupyter labextension install [email protected] --no-build ; fi
+
+RUN jupyter lab build && jupyter lab clean
+
+EXPOSE 8888
+EXPOSE 8787
+EXPOSE 8786
+
+WORKDIR /
+EOF
+
+docker build -f $D_FILE -t $D_CONT .