Ling 573 - Natural Language Processing Systems and Applications
Deliverable #1: Setting up: Due April 4, 2017, 23:45
Through this assignment you will set up the environment for your project:
There is no coding or development required for this deliverable.
- Organize your project repository under a standard version control system.
- Begin to structure/outline your project reports, using a standard format.
Organize your team
For this project you will work in teams of 3 (typically).
form your team, your should send your team list to Glenn and indicate the type of repository you will be using (see below).
Setting up your repository
You will need to set up a repository to support your collaborative work on
your project. You may use either a GIT or a Subversion repository. Basic
how-tos are available on the CLMS wiki as well as on many public websites.
- If you are
using Subversion, Brandon Graves will set up an SVN repository for your team on
the Linguistics SVN server.
- If you are using GIT, David will provide you with a directory under /workspace with suitable permissions where you will be able to create your
- You may alternatively use an external hosting service, like Github Education, provided that it is not public and that the instructor
and TA have access to it.
You should lay out the repository along the following lines, for Subversion and GIT, respectively.
For groups using Subversion:
the group's directory is G1,
G1/trunk: main code
For groups using GIT:
Since GIT does not rely on directory structure for repository organization,
you just need to ensure that you tag each deliverable release appropriately so
that it can be graded.
Each release should have following basic structure:
Dx.cmd: top-level Condor file (not needed for D1)
README: not needed for D1
src/: source code
doc/: reports, powerpoints, additional documentation
outputs/: output files
results/: evaluation results
Beginning the project report
Create an initial project report, D1.pdf, - essentially a paper outline,
according to the guidelines.
This initial version of the project report should include the following sections (headings and
as little text as you'd like):
- Title, Author, and Contact information
- System Overview,
- Conclusion, and
The References Section should include at least two properly formatted entries.
The goal of this exercise is to ensure that, for the remainder of
the course, you can concentrate on building working systems, rather
than trying to figure out bibtex or arguing with your teammates about
whether to use Word or latex.
I strongly encourage you to make sure that everyone on your team can successfully access and update your repository. Pay attention to umasks and other permissions. It is much better to get this sorted out now, when there is little
pressure, than right before deadline when you suddenly realize you can't
access your teammates' work. Speaking from far too much experience.....
- Create and lay out your repository.
- Format your simple 'report'.
- Add D1.pdf, your report PDF, to the repository under the doc directory.
- Create a tag D1 for this deliverable.
- Verify that all components have been added and any changes checked in.