Project Submission Information for CS 371R:
Information Retrieval and Web Search
- Independent Work - Projects should be completed independently by each student.
No collaboration beyond general discussion of the project requirements is
- Due Date/Late Penalties - Projects are due 30 minutes before the start of class on the due date. Be
sure to hand in assignments on time, late penalties are a loss of a percentage
of the original overall points for the assignment: 1 Day: 15%, 2 Days: 40%; 3
Days: 75%; past 3 days: 100%. A day is a 24 hour period starting 30 minutes
before the beginning of class and includes all weekend days and holidays.
- Canvas Submission - Submit all assignment files to the TA electronically using Canvas.
- Filename Format - The filename for each submitted file should have the format:
where each bracketed  item is replaced with the project number, your EID, the label of
the submitted file, and the proper extension respectively. For example, the file name for the project
3 report for Jane Doe (EID:jd1234) would be
proj3_jd1234_report.pdf. This example
will be used throughout the next sections.
- Possible Files to Upload Note: Must upload seperate files to Canvas. The specific instructions
for each assignment will specify exactly which files to upload but here are a few examples of files that will likely be required:
- Code zip file (
- Should contain only new or modified java code (both *.java and compiled *.class files).
- For example, the command to zip just the modified or new files should be like
$ zip proj3_jd1234_code.zip ir/vsr/InvertedIndex.* ir/vsr/MyNewFile.*
- To check your zip file you can run zip list command (
unzip -l). Example output:
$ unzip -l proj3_jd1234_code.zip
Length Date Time Name
--------- ---------- ----- ----
21067 2015-08-24 12:57 ir/vsr/InvertedIndex.java
7061 2015-08-26 17:25 ir/vsr/MyNewFile.java
3939 2015-08-26 17:26 ir/vsr/MyNewFile.class
10049 2015-08-26 17:26 ir/vsr/InvertedIndex.class
42116 4 files
- Usually, this will only have the
- NOTE: The zip file should NOT have an upper level directory. For example, the zip file
should NOT have extra folders like
jd1234_myproj3/ir/vsr/InvertedIndex.java but rather
the files should simply be in their package folders directly
ir/vsr/InvertedIndex.java as in the above zip file example.
- Ideally, your solution should be contained within the classes you wrote and does not modify
the IR package.
- The code should also be properly commented using Javadoc convention.
- Report PDF file (
proj3_jd1234_report.pdf) - A short document (1-2 pages) clearly describing in well-written
English prose, the approach taken to the assignment, the general algorithm
employed, clear instructions on running the system, and insightful
discussion of any experimental results obtained.
- Input/Output trace text files (
NOTE: Each assignment may ask for different trace files so be careful to see the specific assignment instructions) - A detailed trace of
your program running on any sample test problems. The traces can be generated
using the Unix command
script (call "man script" for documentation).
To use script to collect traces, do the following:
The script command captures everything printed on the
terminal, including non-printing characters like carriage returns
(^M) and backspaces (^H). So when you edit the trace
with a text editor, it may look funny. If the extra control characters
do not affect readability of the trace, then you may submit the trace as
it is. However, if the trace looks messy, then please re-run your
program and create a new trace.
Run the script command on the command line:
$ script proj3_jd1234_experiment1_trace.txt
- Run the program on different test cases, as you would have
When you want to stop collecting traces, type "Control-D" at
the command prompt.
The trace of your run is stored in the local file
For example, if the assignment requires code, a report and 1 trace file, this is how Canvas should look after submission: