Integrated resources into project

README.txt

@@ -31,6 +31,14 @@ Example command:
 
 java -jar graphseg.jar /home/seg-input /home/seg-output 0.25 3
 
+The tool's correct execution depends on the resources in the /source/res directory. These three files are as follows: 
+
+(1) embeddings.txt -- the word embeddings used for measuring semantic similarity between sentences. The default file used are 200-dimensional GloVe embeddings obtained on Wikipedia 2014 + Giga 5 corpus (http://nlp.stanford.edu/data/glove.6B.zip). 
+(2) stopwords.txt -- the list of English stopwords (excluded from sentences when measuring semantic similarity)
+(3) freqs.txt -- frequencies of English words on a large corpus, needed for the IC-weighting of word contribution
+
+You may choose to replace these default files (e.g., by using different embeddings or different stopword list), but make sure you name the new files exactly the same (i.e., embeddings.txt, stopwords.txt, and freqs.txt, respectively). 
+
 Credit
 ========
 
@@ -48,6 +56,18 @@ In case you use GraphSeg in your research, please give approproate credit to our
   url       = {http://anthology.aclweb.org/S16-2016}
 }
 
+License
+========
+
+The GraphSeg tool is licensed under the Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International (CC BY-NC-SA 4.0) license: https://creativecommons.org/licenses/by-nc-sa/4.0/
+
+In short, this means:
+ 
+(1) you must give appropriate credit, provide a link to the license, and indicate if changes were made. You may do so in any reasonable manner, but not in any way that suggests the licensor endorses you or your use;
+(2) you may not use the material for commercial purposes;
+(3) if you remix, transform, or build upon the material, you must distribute your contributions under the same license as the original  (i.e., CC BY-NC-SA 4.0).
+
+
 Contact
 ========
 

binary/graphseg.jar

@@ -1,3 +1,3 @@
 version https://git-lfs.github.com/spec/v1
-oid sha256:83ac4ce85663bd97072a2fad76349bf923d1869b7acd7a67f797e6c16a1a47b2
-size 350762888
+oid sha256:72d083746b5228e96f05bf9dc3d91a4b21b89318fe9e1eaff9b539ce9adbd825
+size 616819637

source/pom.xml

@@ -14,6 +14,9 @@
 					<exclude>**/*.java</exclude>
 				</excludes>
 			</resource>
+			<resource>
+				<directory>res</directory>
+			</resource>
 		</resources>
 		<plugins>
 			<plugin>

source/res/embeddings.txt

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:18870b0a7516e4a72b44d3c226c242d2d846008967d8ce40b94c723a94d1a32b
+size 693432828

source/res/stopwords.txt

@@ -0,0 +1,330 @@
+'s
+a
+about
+above
+across
+after
+afterwards
+again
+against
+ago
+all
+almost
+alone
+along
+already
+also
+although
+always
+am
+among
+amongst
+amount
+an
+and
+another
+any
+anyhow
+anyone
+anything
+anyway
+anywhere
+are
+around
+as
+at
+back
+be
+became
+because
+become
+becomes
+becoming
+been
+before
+beforehand
+behind
+being
+below
+beside
+besides
+between
+beyond
+bill
+both
+bottom
+but
+by
+call
+can
+cannot
+cant
+co
+computer
+con
+consist
+could
+couldnt
+cry
+de
+describe
+detail
+do
+done
+down
+due
+during
+each
+eg
+eight
+either
+eleven
+else
+elsewhere
+empty
+enough
+etc
+etc.
+even
+ever
+every
+everyone
+everything
+everywhere
+except
+few
+fifteen
+fifty
+fill
+find
+fire
+fig.
+first
+five
+for
+former
+formerly
+forty
+found
+four
+from
+front
+full
+further
+get
+give
+go
+had
+has
+hasnt
+have
+he
+hence
+her
+here
+hereafter
+hereby
+herein
+hereupon
+hers
+herself
+him
+himself
+his
+how
+however
+hundred
+i
+ie
+if
+in
+inc
+indeed
+interest
+into
+is
+it
+its
+itself
+keep
+last
+latter
+latterly
+least
+less
+ltd
+made
+many
+may
+me
+meanwhile
+might
+mill
+mine
+more
+moreover
+most
+mostly
+move
+much
+must
+my
+myself
+name
+namely
+neither
+never
+nevertheless
+next
+nine
+no
+nobody
+none
+noone
+nor
+not
+n't
+nothing
+now
+nowhere
+of
+off
+often
+on
+once
+one
+one's
+only
+onto
+or
+other
+others
+otherwise
+our
+ours
+ourselves
+out
+over
+own
+part
+per
+perhaps
+please
+put
+rather
+re
+same
+see
+seem
+seemed
+sb
+sb.
+seeming
+seems
+serious
+several
+she
+should
+show
+side
+since
+sincere
+six
+sixty
+so
+some
+somehow
+someone
+something
+sometime
+sometimes
+somewhere
+st
+st.
+still
+such
+system
+take
+ten
+than
+that
+the
+their
+them
+themselves
+then
+thence
+there
+thereafter
+thereby
+therefore
+therein
+thereupon
+these
+they
+thick
+thin
+third
+this
+those
+though
+three
+through
+throughout
+thru
+thus
+to
+together
+too
+top
+toward
+towards
+twelve
+twenty
+two
+un
+under
+until
+up
+upon
+us
+use
+very
+via
+was
+we
+well
+were
+what
+whatever
+when
+whence
+whenever
+where
+whereafter
+whereas
+whereby
+wherein
+whereupon
+wherever
+whether
+which
+while
+whither
+who
+whoever
+whole
+whom
+whose
+why
+will
+with
+within
+without
+would
+yet
+you
+your
+yours
+yourself
+yourselves

source/src/config.properties

@@ -1,3 +0,0 @@
-inf-cont-path=C:/Goran/Corpora/unigram-freqs-english.txt
-word-vec-path=C:/Goran/Corpora/WordVectors/glove-vectors-6b-200d.txt
-stop-words-path=C:/Goran/Corpora/stopwords.txt

source/src/edu/uma/nlp/graphseg/Start.java

@@ -19,7 +19,6 @@ import edu.uma.nlp.graphseg.preprocessing.StanfordAnnotator;
 import edu.uma.nlp.graphseg.semantics.InformationContent;
 import edu.uma.nlp.graphseg.semantics.SemanticSimilarity;
 import edu.uma.nlp.graphseg.semantics.WordVectorSpace;
-import edu.uma.nlp.graphseg.utils.ApplicationConfiguration;
 import edu.uma.nlp.graphseg.utils.IOHelper;
 import edu.uma.nlp.graphseg.utils.MemoryStorage;
 
@@ -74,11 +73,15 @@ public class Start {
 			return;
 		}
 		
-		List<String> stopwords = IOHelper.getAllLines(ApplicationConfiguration.config.getValue("stop-words-path"));
+		String stopwordsPath = (new File("res/stopwords.txt").getAbsolutePath());
+		List<String> stopwords = IOHelper.getAllLines(stopwordsPath);
+	
+		String embeddingsPath = (new File("res/embeddings.txt")).getAbsolutePath();
 		MemoryStorage.setWordVectorSpace(new WordVectorSpace());
-		MemoryStorage.getWordVectorSpace().load(ApplicationConfiguration.config.getValue("word-vec-path"), null);
+		MemoryStorage.getWordVectorSpace().load(embeddingsPath, null);
 		
-		MemoryStorage.setInformationContent(new InformationContent(ApplicationConfiguration.config.getValue("inf-cont-path"), 1));
+		String freqsPath = (new File("res/freqs.txt").getAbsolutePath());
+		MemoryStorage.setInformationContent(new InformationContent(freqsPath, 1));
 		
 		
 		SemanticSimilarity.setStopwords(stopwords);

source/src/edu/uma/nlp/graphseg/semantics/WordVectorSpace.java

@@ -3,10 +3,11 @@ package edu.uma.nlp.graphseg.semantics;
 import java.io.BufferedReader;
 import java.io.BufferedWriter;
 import java.io.File;
+import java.io.FileInputStream;
 import java.io.FileNotFoundException;
 import java.io.FileOutputStream;
-import java.io.FileReader;
 import java.io.IOException;
+import java.io.InputStreamReader;
 import java.io.OutputStreamWriter;
 import java.util.ArrayList;
 import java.util.HashMap;
@@ -29,7 +30,7 @@ public class WordVectorSpace {
     {
         embeddings = new HashMap<String, double[]>();
 
-        try (BufferedReader br = new BufferedReader(new FileReader(path))) {
+        try (BufferedReader br = new BufferedReader(new InputStreamReader(new FileInputStream(path), "UTF8"))) {
             String line;
             int counter = 0;
             while ((line = br.readLine()) != null) {

source/src/edu/uma/nlp/graphseg/utils/ApplicationConfiguration.java

@@ -1,49 +0,0 @@
-package edu.uma.nlp.graphseg.utils;
-
-import java.io.IOException;
-import java.io.InputStream;
-import java.util.Properties;
-
-public class ApplicationConfiguration {
-	
-	public static ApplicationConfiguration config = new ApplicationConfiguration();
-		
-	private Properties prop;
-	
-	public ApplicationConfiguration() 
-	{
-		prop = new Properties();
-		InputStream inStream = getClass().getClassLoader().getResourceAsStream("config.properties");
-		
-		if (inStream != null)
-		{
-			try 
-			{
-				prop.load(inStream);
-				
-			} 
-			catch (IOException e) {
-				e.printStackTrace();
-			}
-			finally
-			{
-				try 
-				{
-					inStream.close();
-				}
-				catch (IOException e) {
-					e.printStackTrace();
-				}
-			}
-		}
-	}
-	
-	public String getValue(String key)
-	{
-		if (prop != null)
-		{
-			return prop.getProperty(key);
-		}
-		else return null;
-	}
-}

source/src/edu/uma/nlp/graphseg/utils/IOHelper.java

@@ -11,6 +11,7 @@ import java.io.InputStream;
 import java.io.InputStreamReader;
 import java.io.OutputStreamWriter;
 import java.io.UnsupportedEncodingException;
+import java.nio.charset.StandardCharsets;
 import java.nio.file.Files;
 import java.nio.file.Paths;
 import java.util.ArrayList;
@@ -35,6 +36,12 @@ public class IOHelper {
 		}
 	}
 	
+	public static List<String> getAllLinesStream(InputStream stream)
+	{
+		List<String> doc = new BufferedReader(new InputStreamReader(stream, StandardCharsets.UTF_8)).lines().collect(Collectors.toList());
+		return doc;
+	}
+	
 	public static List<String> getAllLinesWithoutEmpty(String path)
 	{
 		try {