Developer Runbook

This page contains information on running the application as a developer when you want to make local changes

Deep Learning Playground Onboarding

Welcome to the Deep Learning Playground project team (a DSGT Content Project). This

team's aim is to create an interactive playground for people to build and test their

machine learning and deep learning models in a quicker way. We are constructing a web

application that allows for users to drag and drop their layers (for deep learning),

set the optimizer and relevant parameters, upload their dataset and click the train

button. Once the train buttion is clicked, then the deep learning model is trained and

relevant performance metrics are outputted. Our product is essentially a low-code/no-

code solution to democratizing access to deep learning and machine learning.

As we are more than elated to have you join this impactful team, we want to make your

onboarding process as smooth as possible.

Join this Discord Group. I guess you already did this step haha :)
Under the #github-accts channel in Discord, include your Github username so that Karthik can add you.
Clone the Deep Learning Playground Repository/Codebase using the command git clone https://github.com/karkir0003/Deep-Learning-Playground.git
cd Deep-Learning-Playground to get into the root directory of the project
Install Anaconda if you haven't at this link
Open Anaconda Prompt.
Navigate to the Deep-Learning-Playground project directory with the help of cd
cd conda
conda env create -f environment.yml . This command creates the Anaconda Environment you will be using for developement. The environment.yml file ensures that we all have a consistent development environment and is generally good practice
cd ../. (get out of the conda subdirectory)
cd backend . You will now be in the backend folder
python driver.py . This will fire up a Flask service for which the frontend will interface with the backend

Now, our project is a web-app after all, so where's the frontend you may ask??? Well, follow these instructions to run the frontend

Open Git CMD (but keep your Anaconda Prompt terminal running). Make sure that you are in the root directory of Deep-Learning-Playground
cd frontend/playground-frontend
If you haven't, install NPM at this link
npm install . If you see warnings (in yellow), you're good. If you see "red warnings", please post in the Discord with a screenshot of your error message
npm start . Development server on localhost:3000 will start up. You should be seeing a drag and drop and some dropdowns along with a train button.

Once you complete the onboarding, please DM any of the current developers in Discord with a screenshot of

the website run on your localhost:3000

Below are the tools/technologies we use