If you're new to BURGS, this is the page for you! Read on to find out what you need to be added to and how to set up your coding environment.
Stuff you need to be added to
Students Folder All BURGS - Contains general information on grading, weekly update formatting, and slides from all-BURGS meetings. Professor Ellis should share this with you.
Nikolopoulos BURGS Students - Where you’ll put your weekly updates. Professor Ellis should share this with you.
BURGS Discord - General BURGS discord server. Make sure you change your nickname for the server to something where the professors can easily identify you (instructions on how to do this can be found here). Make sure to also visit the role channel to give yourself the “Computing Performance for Machine Learning” role! Professor Ellis can invite you to this.
Performance Engineering for Machine Learning Discord - Dr. Niko’s discord server for all his research groups. Make sure you are in the systems-for-ml channel. Dr. Niko can invite you to this.
CS 2974 Course - This will ensure you get credit for your research! For how to add it, check the academic advising website for the college housing your primary major (You can find the site by Googling “vt [your college] academic advising”), or directly ask your academic advisor.
IF YOU AREN'T IN ANY OF THE ABOVE, CONTACT THE RELEVANT PERSON TO BE ADDED.
Installing VSCode
Go to https://code.visualstudio.com/download and choose the appropriate download for your operating system.
Making an RLogin Account
If you don’t already have an RLogin account, you’ll need to make one to get onto Chios. Open this link and follow the instructions. For more information, you can reference the VT CS department wiki, which can be found here.
Connecting to Chios
-
Message Dr. Niko on the systems-for-ml channel in the Performance Engineering for Machine Learning Discord server with your PID and ask him to add you to Chios. (Your PID is your VT email handle. For example, if your VT email was abc123@vt.edu, your PID would be abc123)
-
Go into VSCode. Click the lower-left corner, where you see the > and < going into each other.
-
Several options should now appear under the search bar. Select “Connect to host…”
-
Select “+ Add New SSH Host…”
-
Above the search bar, “Enter SSH Connection Command” will appear. Type in “ssh [your PID]@chios.cs.vt.edu” and press enter. (For example, if your PID was abc123, you would type in “ssh abc123@chios.cs.vt.edu”)
-
You should see a pop-up in the lower-right corner. Click the option to connect to host.
-
You may be prompted to select the platform. If you are, select Linux.
-
A new VSCode window will appear. To check that you’ve successfully connected to Chios, open up the terminal. You should see “[your PID]@chios-headnode.” You can also check the lower left corner of the window, where you should see “SSH: chios.cs.vt.edu”
Cloning the repository
-
Navigate to the BURGS GitLab repository.
-
Click the blue button that says “Code” in the upper right corner, just above the last commit and all the files.
-
A menu will appear. Click the button next to the link below “Clone with HTTPS”
-
Navigate into Chios and open up the terminal.
-
Type in “git clone ” and post the link to the repository, then run the command.
-
The files should now pop up on the side of your window
Installing Required Packages
-
Navigate into the BURGS GitLab repository.
-
In the terminal, type in "cd OptimizerAgent" and run the command. This will move you into the OptimizerAgent folder.
-
Still in the terminal, type in “pip install -r requirements.txt” and run it.
-
A bunch of text will appear as your system installs all the packages. Once that stops, you’ll know you have the packages you need to run the agent.
-
If an error happens with one of the packages, let one of the senior members know. It’s likely that the needed packages will change from semester to semester as our work evolves and stuff gets updated/deprecated, and requirements.txt may not reflect this!