Skip to content

Commit ea5f1c0

Browse files
committed
Docstring update for slacker.py
Signed-off-by: Yvan Satyawan <[email protected]>
1 parent bc17479 commit ea5f1c0

File tree

2 files changed

+8
-2
lines changed

2 files changed

+8
-2
lines changed

INSTALL.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ We strongly recommend that you create a virtual environment using conda.
88
This project was built to run on CUDA 9.0. It should work though on any other CUDA version that is compatible with Pytorch.
99
Install the CUDA toolkit as you would normally.
1010

11-
#### Cuda without `sudo`
11+
#### CUDA toolkit without `sudo`
1212
Occasionally, you might want to install the CUDA toolkit without using `sudo`, such as when you don't have `sudo` access to the computer.
1313
This can get confusing. To help with that, here is a step-by-step guide on installing the CUDA toolkit without `sudo`.
1414

src/utils/slacker.py

+7-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,12 @@
11
"""Slacker.
22
3-
Creates messages to send to a slack bot when something is amiss.
3+
Creates messages to send to a slack bot when something is amiss. To make sure
4+
this runs, the following environment variable must be added: SLACK_API_TOKEN.
5+
6+
To add this, follow the instructions at api.slack.com to get a slack api token.
7+
A new app must be created and a bot added to the app. The API token can then
8+
be added to environment variables using whatever method works best for the host
9+
OS.
410
511
Author:
612
Yvan Satyawan <[email protected]>

0 commit comments

Comments
 (0)