srlearn · hayesall · Jul 20, 2018 · Jul 13, 2018 · Jul 18, 2018 · Jul 20, 2018
diff --git a/.gitignore b/.gitignore
@@ -9,6 +9,7 @@ facts.txt
 sentenceIDs.txt
 wordIDs.txt
 
+.DS_Store
 # === The following are based on the github/gitignore/Python.gitignore === #
 # === Made available under a Creative Commons Zero v1.0 Universal ======== #
 

diff --git a/README.rst b/README.rst
@@ -29,7 +29,7 @@ Development builds on GitHub
 Quick-Start
 -----------
 
-``rnlp`` can be used either as a CLI tool or as an imported Python Package.
+``rnlp`` can be used either as a command line interface (CLI) tool or as an imported Python Package.
 
 +---------------------------------------------+--------------------------------------+
 | **CLI**                                     | **Imported**                         |
@@ -45,11 +45,11 @@ Quick-Start
 
 Text will be converted into relational facts, relations encoded are:
 
-- between blocks of size 'n' (i.e. 2 sentences) in the blocks.
+- between sentences and the surrounding block of n sentences.
 
-- between block's of size n (i.e. 'n' sentences) and sentences in the blocks.
+- between words and the surrounding sentence.
 
-- between sentences and words in the sentences.
+- between words within the surrounding sentence.
 
 ---
 
@@ -77,12 +77,12 @@ The relationships currently encoded are:
 
 ---
 
-Files contain a toy corpus (``files/``) and an image of a BoostSRL tree for predicting if a word in a sentence is the word "you".
+Files contain a toy corpus (``example files/``) and an image of a BoostSRL tree for predicting if a word in a sentence is the word "you".
 
 .. image:: https://raw.githubusercontent.com/starling-lab/rnlp/master/docs/img/output.png
 
-The tree says that if the word string contained in word 'b' is "you" then 'b' is the word "you". (This is of course true).
-A more interesting inference is the False branch that says that if word 'b' is an early word in sentence 'a' and word 'anon12035' is also an early word in sentence 'a' and if the word string contained in word 'anon12035' is "Thank", then the word 'b' has decent change of being the word "you". (The model was able to learn that the word "you" often occurs with the word "Thank" in the same sentence when "Thank" appears early in that sentence).
+The tree says that if the word string contained in word 'b' is "you" then 'b' is the word "you" with a high probability. (This is of course true).
+A more interesting inference is the False branch that says that if word 'b' is an early word in sentence 'a' and word 'anon12035' is also an early word in sentence 'a' and if the word string contained in word 'anon12035' is "Thank", then the word 'b' has decent chance of being the word "you". (The model was able to learn that the word "you" often occurs with the word "Thank" in the same sentence when "Thank" appears early in that sentence).
 
  .. _`@kkroy36`: https://github.com/kkroy36/
  .. _`@batflyer`: https://github.com/batflyer/
diff --git a/docs/Makefile → documentation/Makefile b/docs/Makefile → documentation/Makefile
diff --git a/docs/img/output.png → documentation/img/output.png b/docs/img/output.png → documentation/img/output.png
diff --git a/documentation/requirements.txt b/documentation/requirements.txt
@@ -0,0 +1,2 @@
+sphinx_rtd_theme
+sphinx
diff --git a/docs/source/conf.py → documentation/source/conf.py b/docs/source/conf.py → documentation/source/conf.py
diff --git a/docs/source/index.rst → documentation/source/index.rst b/docs/source/index.rst → documentation/source/index.rst
diff --git a/docs/source/modules.rst → documentation/source/modules.rst b/docs/source/modules.rst → documentation/source/modules.rst
diff --git a/docs/source/rnlp.rst → documentation/source/rnlp.rst b/docs/source/rnlp.rst → documentation/source/rnlp.rst
diff --git a/files/d.txt → example_files/d.txt b/files/d.txt → example_files/d.txt
diff --git a/files/d1.txt → example_files/d1.txt b/files/d1.txt → example_files/d1.txt
diff --git a/files/d2.txt → example_files/d2.txt b/files/d2.txt → example_files/d2.txt
diff --git a/files/d3.txt → example_files/d3.txt b/files/d3.txt → example_files/d3.txt
diff --git a/files/d4.txt → example_files/d4.txt b/files/d4.txt → example_files/d4.txt
diff --git a/files/d5.txt → example_files/d5.txt b/files/d5.txt → example_files/d5.txt
diff --git a/files/d6.txt → example_files/d6.txt b/files/d6.txt → example_files/d6.txt
diff --git a/files/doi.txt → example_files/doi.txt b/files/doi.txt → example_files/doi.txt
diff --git a/v1-0.jar b/v1-0.jar