Skip to content

Latest commit

 

History

History
103 lines (69 loc) · 4.84 KB

README.md

File metadata and controls

103 lines (69 loc) · 4.84 KB
Raw

Deep Learning Playground

Web Application where people new to Machine Learning can input a dataset and experiment around with basic Pytorch modules through a drag and drop interface

Deployed website: https://datasciencegt-dlp.com/
> GitHub repo: https://github.com/DSGT-DLP/Deep-Learning-Playground

Getting Started

Prerequisites

Have the following installed first:

  1. Node.js v18 via NVM (Install nvm first, and then install node & npm using nvm)
  2. Yarn 1.x (Must be installed after npm. May upgrade to Yarn Modern in the future, keep an eye out for that!)
  3. Mamba (Make sure to install using the Miniforge distribution. On windows, remember to check the box that says that it will add mamba to path)
  4. pip (Is also automatically installed with Python via Python's installer, make sure this version of pip is installed globally)
  5. dlp-cli (We have our own cli!)
  6. AWS CLI
  7. VSCode
  8. git

Recommended

  1. GitKraken for helping with Git commands, especially if you're new to Git
  2. Postman (Extremely helpful for testing REST APIs)
  3. Chrome (For Chrome developer tools)
  4. Redux Devtools (Helpful for debugging any Redux)
  5. Docker
  6. go (In case if you ever need to contribute to the dlp-cli)
  7. VSCode Extensions:
    1. Github Copilot
    2. IntelliCode
    3. Python
    4. Black Formatter
    5. Pretter - Code formatter
    6. ESLint
    7. Docker
    8. Go

Clone the Repository

git clone https://github.com/DSGT-DLP/Deep-Learning-Playground.git in the directory of your choice. If this installation is for the beginner project, do git clone https://github.com/DSGT-DLP/dlp-practice.git.

This can also be achieved through GitKraken.

Frontend and Backend Package Installation

Run the following commands in the project directory (the root folder created after cloning):

Action Command
Install/Update Frontend Packages dlp-cli frontend install
Install/Update Backend Packages dlp-cli backend install

GitGuardian Pre-commit Check

To install the GitGuardian cli and pre-commit, run

pip install ggshield
pip install pre-commit

To protect our secrets, we use the GitGuardian ggshield pre-commit check to ensure no keys are being committed. After installing the backend, run

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

ggshield auth login

If this command works properly, you will be redirected to an auth route in the Git Guardian website. Sign in using your Github account. Then, you should be all set!

Additional VSCode Setup (Recommended)

Access the VSCode command palette via Ctrl+Shift+P. Press Python: Select Interpreter. You need the Python VSCode extension for this.

Select the Python Interpreter named dlp.

To start on localhost:

Run the following commands in the project directory (the root folder created after cloning):

Action Command
Running the Frontend dlp-cli frontend start
Running the Backend dlp-cli backend start

Make sure to run the above two commands in separate terminals.

Architecture

See Architecture.md

License

Deep Learning Playground is MIT licensed, as found in the LICENSE file.

Deep Learning Playground documentation is Creative Commons licensed, as found in the LICENSE-docs file.