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 permitted.
Due Date/Late Penalties - Projects are due at 11:59 p.m. on the due date. Assignment due dates will be on Mondays and Wednesdays. 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 from 11:59 p.m. on the due date and includes all weekend days and holidays.
Gradescope Submission - Submit all assignment files on the Gradescope course page.
Filename Format - The filename for submitted files depends on the project requirements. Generally, there are four types of files that are submitted: .java, .class, .pdf, .txt
Possible Files to Upload. 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:
1. Code files (filename.java, filename.class, Example: InvertedIndex.java, InvertedIndex.class)
  - Should contain only new or modified java code (both *.java and compiled *.class files).
  - 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.
2. Report PDF file (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.
3. Input/Output trace text files ( trace/[TRACESUFFIX].txt, Example: trace/curlie.txt, 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:
  1. Run the script command on the command line:
    $ script trace/curlie.txt
  2. Run the program on different test cases, as you would have normally done.
  3. When you want to stop collecting traces, type "Control-D" at the command prompt.
  4. The trace of your run is stored in the local file trace/curlie.txt.
  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. Please remove any unnecessary content from the trace file before submitting. Check the sample trace files for recommended format.
Zipping Guidelines
- Usually, you will directly zip all the submission files, including codes, pdf and trace dir.
- NOTE: The zip file should NOT have an upper level directory. For example, the zip file should NOT have extra folders like jd1234_myproj0/InvertedIndex.java but rather the files should simply be in the root folder directly InvertedIndex.java, trace/curlie.txt, and so on.
Autograder
- After submitting the code on Gradescope, you will be able to run the autogrdaer on it and verify your submission. You should immediately be able to see if your code compiled correctly and if certain basic checks such as trace generation and output format are correct. You can also see the results of the autograder run on your code for sample test cases.
  Note that many test cases will be hidden and you will receive the score only after grading.
- Here is how the results after autograding might look like:

Project Submission Information for CS 371R: Information Retrieval and Web Search

Project Submission Information for CS 371R:
Information Retrieval and Web Search