docs added

docs/Makefile

@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS    =
+SPHINXBUILD   = sphinx-build
+SPHINXPROJ    = Snark
+SOURCEDIR     = source
+BUILDDIR      = build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

docs/build/html/.buildinfo

@@ -0,0 +1,4 @@
+# Sphinx build info version 1
+# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
+config: 25df2e1ed7f3946d73667b63e01b7805
+tags: 645f666f9bcd5a90fca523b33c5a78b7

docs/build/html/_sources/_static/index.md.txt

@@ -0,0 +1,45 @@
+
+# <img src="https://avatars3.githubusercontent.com/u/34816118?s=200&v=4" data-canonical-src="hhttps://avatars3.githubusercontent.com/u/34816118?s=200&v=4" width="40" height="40" /> Snark AI
+
+## Basic Usage
+**Step 1**. Install snark through pip3
+```
+pip3 install snark --user
+```
+If you're having difficulties with installation, take a look at the [troubleshooting](#troubleshooting) section. 
+
+**Step 2**. Go to [hub.snark.ai](https://hub.snark.ai) to sign up. Then run:
+```
+snark login
+```
+
+
+**Step 3** open Python and write
+``` python
+import numpy as np
+from snark.infer import model
+
+alexnet = model(model_name='snarkai/AlexNet:latest')
+output = alexnet.infer(np.zeros([1, 3, 224, 224]))
+```
+
+<a name="troubleshooting"></a>
+### Troubleshooting
+
+#### If you get a `Permission denied` message:
+```
+sudo pip3 install snark
+```
+#### If you don't have `sudo` access:
+```
+pip3 install snark --user
+```
+**AND** add the following to your `~/.bashrc` file:
+```
+export PY_USER_BIN=$(python3 -c 'import site; print(site.USER_BASE + "/bin")')
+export PATH=$PY_USER_BIN:$PATH
+```
+**AND** reload your `~/.bashrc`:
+```
+source ~/.bashrc
+```

docs/build/html/_sources/_static/infer.md.txt

@@ -0,0 +1,45 @@
+
+# <img src="https://avatars3.githubusercontent.com/u/34816118?s=200&v=4" data-canonical-src="hhttps://avatars3.githubusercontent.com/u/34816118?s=200&v=4" width="40" height="40" /> Snark AI
+
+## Basic Usage
+**Step 1**. Install snark through pip3
+```
+pip3 install snark --user
+```
+If you're having difficulties with installation, take a look at the [troubleshooting](#troubleshooting) section. 
+
+**Step 2**. Go to [hub.snark.ai](https://hub.snark.ai) to sign up. Then run:
+```
+snark login
+```
+
+
+**Step 3** open Python and write
+``` python
+import numpy as np
+from snark.infer import model
+
+alexnet = model(model_name='snarkai/AlexNet:latest')
+output = alexnet.infer(np.zeros([1, 3, 224, 224]))
+```
+
+<a name="troubleshooting"></a>
+### Troubleshooting
+
+#### If you get a `Permission denied` message:
+```
+sudo pip3 install snark
+```
+#### If you don't have `sudo` access:
+```
+pip3 install snark --user
+```
+**AND** add the following to your `~/.bashrc` file:
+```
+export PY_USER_BIN=$(python3 -c 'import site; print(site.USER_BASE + "/bin")')
+export PATH=$PY_USER_BIN:$PATH
+```
+**AND** reload your `~/.bashrc`:
+```
+source ~/.bashrc
+```

docs/build/html/_sources/index.md.txt

@@ -0,0 +1,213 @@
+
+<img src="https://avatars3.githubusercontent.com/u/34816118?s=200&v=4" data-canonical-src="hhttps://avatars3.githubusercontent.com/u/34816118?s=200&v=4" width="40" height="40" />  Snark AI
+
+## Basic Usage
+**Step 1**. Install snark through pip3
+```
+pip3 install snark
+```
+If you're having difficulties with installation, take a look at the [troubleshooting](#troubleshooting) section.
+
+**Step 2**. Go to [lab.snark.ai](https://lab.snark.ai) to sign up. Sign in through the CLI
+```
+snark login
+```
+It will ask you for username and password that you registered on the website.
+
+**Step 3**. You can start your pod by
+```
+snark start
+```
+This will create a pod with default configuration. By default, your pod will have a randomized id, one P106 GPU and pytorch preinstalled. You can create a custom pod by specifying the following parameters:
+```
+  -t, --pod_type [pytorch|tensorflow|theano|mxnet|caffe]
+                                  Pody type (['pytorch', 'tensorflow',
+                                  'theano', 'mxnet', 'caffe'])
+  -g, --gpu_count INTEGER         Number of GPUs
+  -s, --gpu_spec [P106|1080]  GPU type. Choose one of: ['P106',
+                                  '1080']
+```
+For example, the following command creates a Tensorflow pod with 2 P106 GPUs.
+```
+snark start --pod_type tensorflow  -g 2
+```
+
+You will have sudo access with password `admin`. We use key-based authentication and block password login to your pod so no need to worry about the weak password.
+
+Our available pod types:  
+ - **tensorflow/keras**: tensorflow version 1.8.0 with cuda 9, cudnn 7 in python3. Keras is installed in the pod.
+ - **pytorch/caffe2**: pytorch version 0.4.0 with cuda 9, cudnn 7 in python 3. Caffe2 is also installed in the pod
+ - **mxnet**: mxnet version 1.0.0 with cuda 9, cudnn 7 in python 3.
+ - **theano**: theano version 0.8.2 with cuda 8, cudnn 5 in python 3
+ - **caffe** : caffe version 1.0 with cuda 8, cudnn 6 in python 3
+
+**Step 4**. Stop the pod by
+Use `snark ls` to list your active pods.
+```
+snark ls
+````
+Use `snark stop` to stop the target pod:
+```
+snark stop {pod_id}
+```
+
+
+**List active pods**
+
+
+
+**Reconnect to an active pod**
+
+To reconnect to an active pod, execute an `attach` command and specify the id of the pod that you want to resume.
+```
+snark attach my_pod
+```
+
+**Change pod hardware characteristics**
+Currently, each pod is tied to the GPU time it was first run on. If you want to try to try different GPU types, change the pod_id:
+```
+snark start tf_pod2 --pod_type tensorflow  --gpu_spec 1080
+```
+
+<a name="troubleshooting"></a>
+### Troubleshooting
+
+#### If you get a `Permission denied` message:
+```
+sudo pip3 install snark
+```
+#### If you don't have `sudo` access:
+```
+pip3 install snark --user
+```
+**AND** add the following to your `~/.bashrc` file:
+```
+export PY_USER_BIN=$(python3 -c 'import site; print(site.USER_BASE + "/bin")')
+export PATH=$PY_USER_BIN:$PATH
+```
+**AND** reload your `~/.bashrc`:
+```
+source ~/.bashrc
+```
+#### Snark Not Found
+If you tried all above and still get `snark not found` error message, try:
+1) Updating your pip3 through `pip3 install --upgrade pip3`
+2) Try installing specific version through tarball:
+```
+pip3 uninstall snark
+pip3 install https://files.pythonhosted.org/packages/e2/25/17f773c1a8c713fcc57f45a05554a4ac9ee5f0ff88418548e397eac06bb9/snark-0.2.3.1.tar.gz
+```
+## File Transfer
+You can push/pull data to the pod by snark pull and snark push. Use it as a convenient replacement for `scp`.
+
+#### Couldn't successfully schedule pod execution
+If you get a `Couldn't successfully schedule pod execution` error when trying to start your pod, it is likely that the given pod is already bound to another GPU type. Try changing the pod ID or the GPU type.  
+
+### Download Files
+```bash
+snark pull my_pod -r /path/to/remote/file.tar.gx -l /path/to/local/file.tar.gx
+```
+```bash
+$ snark pull --help
+Usage: snark pull [OPTIONS]
+
+  Transfer file from the pod to the localhost
+
+Options:
+  -r, --remote_path TEXT  Path to file on the Pod.
+  -l, --local_path TEXT   Path to file on local machine.
+  --help                  Show this message and exit.
+```
+
+### Upload Files
+```bash
+snark push my_pod -r /path/to/remote/file.tar.gx -l /path/to/local/file.tar.gx
+```
+```bash
+$ snark push --help
+Usage: snark push [OPTIONS]
+
+  Transfer file to the pod
+
+Options:
+  -l, --local_path TEXT   Path to file on local machine.
+  -r, --remote_path TEXT  Path to file on the Pod.
+  --help                  Show this message and exit.
+```
+Note: if you want use `~'` or `\*` when specifying remote file path, please take them in quotes. Eg:
+```
+snark push kaggle_pod -r "~/test.txt" -l test.txt
+```
+
+## Persistent Storage
+Each pod comes with 10GB of persistant storage. This storage will be destroyed only when you use `snark terminate` to destroy your pod.
+
+If you would like a pod with more persistant storage, shoot us an email at *support@snark.ai*.
+
+Common datasets from Kaggle competitions and more are accessible (read only) at `/datasets`. If there's a dataset you would like to add/request, reach out to us at *support@snark.ai*.
+
+## Jupyter
+To run jupyter notebook automatically
+```
+snark start --jupyter
+```
+You will need to copy the token from the CLI for security reasons.
+
+## Ports
+To forward a custom port e.g. Tensorboard you can run as you would do in SSH
+```
+snark start -L 6006:localhost:6006
+```
+
+## Docker (beta)
+To execute custom docker you need to run.
+```
+start -t custom --docker_image username/image:tag
+```
+Docker container must have Ubuntu base. Please contact us if you need other system configurations.
+
+## Usage Monitor
+Login to [lab.snark.ai](https://lab.snark.ai) to check the GPU hour used and credit left.
+
+## Inference
+### Basic Usage
+**Step 1**. Install snark through pip3
+```
+pip3 install snark --user
+```
+If you're having difficulties with installation, take a look at the [troubleshooting](#troubleshooting) section.
+
+**Step 2**. Go to [hub.snark.ai](https://hub.snark.ai) to sign up. Then run:
+```
+snark login
+```
+
+**Step 3** open Python and write
+``` python
+import numpy as np
+from snark.infer import model
+
+alexnet = model(model_name='snarkai/AlexNet:latest')
+output = alexnet.infer(np.zeros([1, 3, 224, 224]))
+```
+
+<a name="troubleshooting"></a>
+### Troubleshooting
+
+If you get a `Permission denied` message:
+```
+sudo pip3 install snark
+```
+If you don't have `sudo` access:
+```
+pip3 install snark --user
+```
+**AND** add the following to your `~/.bashrc` file:
+```
+export PY_USER_BIN=$(python3 -c 'import site; print(site.USER_BASE + "/bin")')
+export PATH=$PY_USER_BIN:$PATH
+```
+**AND** reload your `~/.bashrc`:
+```
+source ~/.bashrc
+```

docs/build/html/_sources/index.rst.txt

@@ -0,0 +1,20 @@
+.. Snark documentation master file, created by
+   sphinx-quickstart on Sun Aug  5 21:28:49 2018.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+Welcome to Snark's documentation!
+=================================
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+
+
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`

docs/build/html/_sources/index2.rst.txt

@@ -0,0 +1,20 @@
+.. Snark documentation master file, created by
+   sphinx-quickstart on Sun Aug  5 21:28:49 2018.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+Welcome to Snark's documentation!
+=================================
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+
+
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`