ML4T Software Setup - Revision history

Greg: /* Access to machines at Georgia Tech */

2020-01-28T20:42:37Z

Access to machines at Georgia Tech

Jfox44: /* Running the grading scripts */

2020-01-06T01:41:41Z

Running the grading scripts

Jfox44: /* Getting code templates */

2020-01-06T01:40:36Z

Getting code templates

Greg: /* Notice */

2020-01-03T15:42:25Z

Notice

Jfox44: /* Access to machines at Georgia Tech */

2019-08-15T14:46:19Z

Access to machines at Georgia Tech

Jfox44: /* Access to machines at Georgia Tech */

2019-08-15T14:44:55Z

Access to machines at Georgia Tech

David.joyner: /* Running the grading scripts */

2019-08-14T18:19:34Z

Running the grading scripts

David.joyner: /* Running the grading scripts */

2019-08-14T18:18:24Z

Running the grading scripts

Greg: /* Important Notes */

2019-08-04T18:16:09Z

Important Notes

Greg: /* Getting code templates */

2019-08-04T18:12:26Z

Getting code templates

@@ Line 23: / Line 23: @@
   ssh -X gtname@buffet0X.cc.gatech.edu
-replacing the <tt>X</tt> in <tt>buffet0X</tt> with 1, 3 or 4, as detailed below. You will then be asked for your password and be logged in. Windows users may have to install an ssh client such as [http://www.putty.org/ putty]. In order to distribute workload across the machines, please use the specific machines as follows:
+replacing the <tt>X</tt> in <tt>buffet0X</tt> with 1, 3 or 4, as detailed below and replacing <tt>gtname</tt> with your actual gtname. You will then be asked for your password and be logged in. Windows users may have to install an ssh client such as [http://www.putty.org/ putty]. In order to distribute workload across the machines, please use the specific machines as follows:
 * <s>buffet01.cc.gatech.edu if your last name begins with A-G</s> buffet01.cc.gatech.edu if your last name begins with A-I

@@ Line 42: / Line 42: @@
 == Running the grading scripts ==
-The above zip files contain the grading scripts, data, and util.py for all assignments. Some project page will also have a link to a zip file containing a directory with some template code, which you should extract in the same directory that contains the <tt>data/</tt> and <tt>grading/</tt> directories, and <tt>util.py</tt>, (<tt>ML4T_2019Fall/</tt>). To complete the assignments you'll need to modify the templates according to the assignment description. You can do this on the <tt>buffet0X</tt> machines directly using a text editor such as <tt>gedit</tt>, <tt>nano</tt>, or <tt>vim</tt>. Or you can copy the file to your local machine, edit them in your favorite text editor or IDE, and upload them back to the server. Make sure to test run your code on the server after making changes to catch any typos or other bugs.
+The above zip files contain the grading scripts, data, and util.py for all assignments. Some project page will also have a link to a zip file containing a directory with some template code, which you should extract in the same directory that contains the <tt>data/</tt> and <tt>grading/</tt> directories, and <tt>util.py</tt>, (<tt>ML4T_2020Spring/</tt>). To complete the assignments you'll need to modify the templates according to the assignment description. You can do this on the <tt>buffet0X</tt> machines directly using a text editor such as <tt>gedit</tt>, <tt>nano</tt>, or <tt>vim</tt>. Or you can copy the file to your local machine, edit them in your favorite text editor or IDE, and upload them back to the server. Make sure to test run your code on the server after making changes to catch any typos or other bugs.
 To test your code, you'll need to set up your PYTHONPATH to include the <tt>grading</tt> module and the utility module <tt>util.py</tt>, which are both one directory up from the project directories. Here's an '''example''' of how to run the grading script for the optional (deprecated) assignment Assess Portfolio (note, grade_anlysis.py is included in the template zip file for Assess Portfolio):
@@ Line 48: / Line 48: @@
   PYTHONPATH=../:. python grade_analysis.py
-which assumes you're typing from the folder '''ML4T_2019Fall/assess_portfolio/'''. This will print out a lot of information, and will also produce two text files: <tt>points.txt</tt> and <tt>comments.txt</tt>. It will probably be helpful to scan through all of the output printed out in order to trace errors to your code, while <tt>comments.txt</tt> will contain a succinct summary of which test cases failed and the specific errors (without the backtrace). Here's an example of the contents of <tt>comments.txt</tt> for the first assignment using the unchanged template:
+which assumes you're typing from the folder '''ML4T_2020Spring/assess_portfolio/'''. This will print out a lot of information, and will also produce two text files: <tt>points.txt</tt> and <tt>comments.txt</tt>. It will probably be helpful to scan through all of the output printed out in order to trace errors to your code, while <tt>comments.txt</tt> will contain a succinct summary of which test cases failed and the specific errors (without the backtrace). Here's an example of the contents of <tt>comments.txt</tt> for the first assignment using the unchanged template:
   &lt;pre&gt;--- Summary ---

@@ Line 38: / Line 38: @@
 ==Getting code templates==
-As of Spring 2018, code for each of the individual assignments is provided in zip files, linked to on the individual project page. The data, grading module, and util.py, which are common across all assignments, are available here [[Media:ML4T_2019Fall.zip]] (<span style="color:red">same file as above</span>).
+As of Spring 2018, code for each of the individual assignments is provided in zip files, linked to on the individual project page. The data, grading module, and util.py, which are common across all assignments, are available here [[Media:ML4T_2020Spring.zip]] (<span style="color:red">same file as above</span>).
 == Running the grading scripts ==

@@ Line 1: / Line 1: @@
 == Notice ==
-The repository has been made private for the Fall 2017 semester, and so the links to the repository below will no longer be visible for you. A zip file containing the grading script and any template code or data will be linked off of each assignment's individual wiki page. A zip file containing the <tt>grading</tt> and <tt>util</tt> modules, as well as the data, is available here: [[Media:ML4T_2019Fall.zip]]. The instructions on running the test scripts provided below still applies.
+The repository has been made private for the Fall 2017 semester, and so the links to the repository below will no longer be visible for you. A zip file containing the grading script and any template code or data will be linked off of each assignment's individual wiki page. A zip file containing the <tt>grading</tt> and <tt>util</tt> modules, as well as the data, is available here: [[Media:ML4T_2020Spring.zip]]. The instructions on running the test scripts provided below still applies.
 == Overview ==

@@ Line 18: / Line 18: @@
 ==Access to machines at Georgia Tech==
-There are <s>4</s> 3 machines that will be accessible to students enrolled in the ML4T class via [https://en.wikipedia.org/wiki/Secure_Shell <tt>ssh</tt>]. These machines may not be available until the second week of class; we will make an announcement once they are ready, and if at that time you are still unable to log in, please contact us. If you are using a Unix based operating system, such as Ubuntu or Mac OS X, you already have an ssh client, and you can connect to one of the servers by opening up a terminal and typing:
+There are 3 machines that will be accessible to students enrolled in the ML4T class via [https://en.wikipedia.org/wiki/Secure_Shell <tt>ssh</tt>]. These machines may not be available until the second week of class; we will make an announcement once they are ready, and if at that time you are still unable to log in, please contact us. If you are using a Unix based operating system, such as Ubuntu or Mac OS X, you already have an ssh client, and you can connect to one of the servers by opening up a terminal and typing:
   xhost +

@@ Line 8: / Line 8: @@
 ===Important Notes===
-* Your code '''MUST''' run properly on the Georgia Tech provided servers, and your code must be submitted to Canvas. If you do not test your code on the provided machines it may not run correctly when we test it.  If your code fails to run on the provided servers, you will not get credit for the assignment.  So it is very important that you ensure that you have access to, and that your code runs correctly on, these machines. If you would like to develop on your personal machine and are comfortable installing libraries by hand, you can follow the instructions here: [[ML4T_Software_Installation]]. Note that these instructions are from an earlier version of the class, but should work reasonably well.
+* Your code '''MUST''' run properly on the Georgia Tech provided servers, and your code must be submitted to Canvas. If you do not test your code on the provided machines it may not run correctly when we test it.  If your code fails to run on the provided servers, you will not get credit for the assignment.  So it is very important that you ensure that you have access to, and that your code runs correctly on, these machines. If you would like to develop on your personal machine and are comfortable installing libraries by hand, you can follow the instructions here: [[ML4T_Software_Environment]]. Note that these instructions are from an earlier version of the class, but should work reasonably well.
 * We use a specific, static dataset for this course, which is provided as part of the repository detailed below. If you download your own data from Yahoo (or elsewhere), you will get wrong answers on assignments.
 * We reserve the right to modify the grading script while maintaining API compatibility with what is described on the project pages. This includes modifying or withholding test cases, changing point values to match the given rubric, and changing timeout limits to accommodate grading deadlines. The scripts are provided as a convenience to help students avoid common pitfalls or mistakes, and are intended to be used as a sanity check. '''Passing all tests does not guarantee full credit on the assignment, and should be considered a necessary but not sufficient condition for completing an assignment.'''