Skip to content

Commit

Permalink
minor readme.md updates (#1082)
Browse files Browse the repository at this point in the history
  • Loading branch information
karkir0003 authored Jan 2, 2024
1 parent 910a478 commit 1293c74
Showing 1 changed file with 6 additions and 6 deletions.
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ Web Application where people new to Machine Learning can input a dataset and exp
Have the following installed first:

1. [Node.js v20 via NVM](https://github.com/nvm-sh/nvm#installing-and-updating) (Install nvm first, and then install node & npm using nvm)
1. [Mamba](https://github.com/conda-forge/miniforge#miniforge) (Make sure to install using the Miniforge distribution. On windows, remember to check the box that says that it will add mamba to path)
1. [Mamba](https://github.com/conda-forge/miniforge#miniforge) (Make sure to install using the Miniforge distribution. On windows, remember to check the box that says that it will add mamba to PATH)
1. [pip](https://pip.pypa.io/en/stable/installation/) (Is also automatically installed with Python via Python's installer, make sure this version of pip is installed globally)
1. [dlp-cli](https://github.com/DSGT-DLP/dlp-cli#readme) (We have our own cli!)
1. [AWS CLI](https://docs.aws.amazon.com/cli/latest/userguide/getting-started-install.html)
Expand All @@ -25,7 +25,7 @@ Have the following installed first:
1. [Postman](https://www.postman.com/downloads/) - Extremely helpful for testing REST APIs
1. [Chrome](https://www.google.com/chrome/) - For Chrome developer tools
1. [Redux Devtools](https://chrome.google.com/webstore/detail/redux-devtools/lmhkpmbekcpmknklioeibfkpmmfibljd) - Helpful for debugging any Redux
1. [Docker](https://www.docker.com/) - For Docker images
1. [Docker](https://docs.docker.com/engine/install/) - For Docker images
1. [go](https://go.dev/doc/install) - In case if you ever need to contribute to the dlp-cli
1. VSCode Extensions:
1. [Github Copilot](https://marketplace.visualstudio.com/items?itemName=GitHub.copilot)
Expand Down Expand Up @@ -74,7 +74,7 @@ To protect our secrets, we use the GitGuardian ggshield pre-commit check to ensu
pre-commit install
```

You should get output like "pre-commit installed at .git/hooks/pre-commit". Login to GitGuardian to activate the pre-commit hook using
You should get output like `pre-commit installed at .git/hooks/pre-commit`. Login to GitGuardian to activate the pre-commit hook using

```sh
ggshield auth login
Expand Down Expand Up @@ -105,7 +105,7 @@ Make sure to run the above two commands in separate terminals. You should see th
## 5. AWS Setup
If you will be working on tasks that interface with AWS resources/services, please follow the below steps (please install AWS CLI using this [link](https://docs.aws.amazon.com/cli/latest/userguide/getting-started-install.html) first):

1. Request an AWS Account for Deep Learning Playground by messaging Faris, Karthik, or Daniel in the DLP Discord. Please include your Github username along with your personal email account
1. Request an AWS Account for Deep Learning Playground by messaging Faris, Karthik, Daniel, or a Project Lead (@Project Lead) in the DLP Discord. Please include your Github username along with your personal email account and full name
1. Once an AWS Account has been created, you will receive an email from AWS that will require you to setup a password
1. When you login, you should be seeing that the account you're added under is `Data Science Initiative Inc`
1. Click on the dropdown to expand the `Data Science Initiative Inc` entry and select the `Command Line or programmatic access button`
Expand All @@ -120,9 +120,9 @@ If you will be working on tasks that interface with AWS resources/services, plea
````
1. Make sure you follow the instructions in the terminal to ensure your credentials are set correctly (eg: allow botocore to access data should be selected as "yes")
1. Run `cat ~/.aws/config` to look for the sso profile configured.
1. Run `export AWS_PROFILE=<sso_profile_name from step 6>`
1. Run `export AWS_PROFILE=<sso_profile_name from the previous step>`

Please message in the DLP Discord or view the [Bug Manual page](https://github.com/DSGT-DLP/Deep-Learning-Playground/wiki/Bug-Manual) if you have any difficulty/issue with these steps.
Please message in the DLP Discord or view the [Bug Manual page](https://github.com/DSGT-DLP/Deep-Learning-Playground/wiki/Bug-Manual) and [Documentation](https://www.notion.so/General-011ddb00fda146048ec1beb2d18c8abc) if you have any difficulty/issue with these steps.

# Architecture

Expand Down

0 comments on commit 1293c74

Please sign in to comment.